ReaderBase Class Reference

#include <readerbase.h>

Inheritance diagram for ReaderBase:

Public Member Functions
virtual	~ReaderBase ()
virtual QString	errorMessage () const =0
virtual KEduVocDocument::FileType	fileTypeHandled ()=0
virtual bool	isParsable ()=0
virtual KEduVocDocument::ErrorCode	read (KEduVocDocument &doc)=0

Detailed Description

a base class for readers of various lexicon formats

Definition at line 19 of file readerbase.h.

Constructor & Destructor Documentation

~ReaderBase()

virtual ReaderBase::~ReaderBase ( )

inlinevirtual

destructor

Definition at line 23 of file readerbase.h.

Member Function Documentation

errorMessage()

virtual QString ReaderBase::errorMessage ( ) const

pure virtual

an error message.

Returns

the error message

Implemented in DummyReader, FailedReader, KEduVocCsvReader, KEduVocKvtml2Reader, KEduVocPaukerReader, KEduVocVokabelnReader, KEduVocWqlReader, and KEduVocXdxfReader.

fileTypeHandled()

virtual KEduVocDocument::FileType ReaderBase::fileTypeHandled ( )

pure virtual

returns the KEduVocDocument::FileType that this reader handles

Returns

KEduVocDocument::FileType handled

Implemented in DummyReader, FailedReader, KEduVocCsvReader, KEduVocKvtml2Reader, KEduVocPaukerReader, KEduVocVokabelnReader, KEduVocWqlReader, and KEduVocXdxfReader.

isParsable()

virtual bool ReaderBase::isParsable ( )

pure virtual

Can this reader parse the file.

Read a small portion of the header of the file and decide if it is a suitable type.

Returns

true if parsable

Implemented in DummyReader, FailedReader, KEduVocCsvReader, KEduVocKvtml2Reader, KEduVocPaukerReader, KEduVocVokabelnReader, KEduVocWqlReader, and KEduVocXdxfReader.

read()

virtual KEduVocDocument::ErrorCode ReaderBase::read ( KEduVocDocument & doc )

pure virtual

Parse file and write into doc.

Parameters

doc	to be written

Returns

error status of the read.

Implemented in DummyReader, FailedReader, KEduVocCsvReader, KEduVocKvtml2Reader, KEduVocPaukerReader, KEduVocVokabelnReader, KEduVocWqlReader, and KEduVocXdxfReader.

---

The documentation for this class was generated from the following file:

• readerbase.h