Public Types | Public Member Functions | Protected Member Functions | List of all members
iser::CXmlReadArchiveBase Class Referenceabstract

Base class for XML based reading archives. More...

#include <CXmlReadArchiveBase.h>

Inheritance diagram for iser::CXmlReadArchiveBase:
iser::CTextReadArchiveBase iser::CXmlDocumentInfoBase iser::CReadArchiveBase iser::CArchiveBase iser::IArchive istd::ILogger istd::IPolymorphic istd::IPolymorphic iser::CXmlStreamReadArchiveBase ifile::CSimpleXmlFileReadArchive iser::CXmlStringReadArchive

Public Types

typedef CTextReadArchiveBase BaseClass
 
- Public Types inherited from iser::CTextReadArchiveBase
typedef CReadArchiveBase BaseClass
 
- Public Types inherited from iser::IArchive
enum  MessageId { MI_TAG_ERROR = 0x3f320a0, MI_TAG_SKIPPED }
 

Public Member Functions

virtual bool IsTagSkippingSupported () const
 Check if skiping to the end of tag on EndTag is supported. More...
 
virtual bool BeginTag (const CArchiveTag &tag)
 Begin of archive tag. More...
 
virtual bool BeginMultiTag (const CArchiveTag &tag, const CArchiveTag &subTag, int &count)
 Begin of archive tag containing set of subelements of the same type. More...
 
virtual bool EndTag (const CArchiveTag &tag)
 End of archive tag. More...
 
virtual bool Process (QByteArray &value)
 Process primitive type. More...
 
virtual bool Process (QString &value)
 Process primitive type. More...
 
- Public Member Functions inherited from iser::CTextReadArchiveBase
virtual bool Process (bool &value)
 Process primitive type. More...
 
virtual bool Process (char &value)
 Process primitive type. More...
 
virtual bool Process (quint8 &value)
 Process primitive type. More...
 
virtual bool Process (qint8 &value)
 Process primitive type. More...
 
virtual bool Process (quint16 &value)
 Process primitive type. More...
 
virtual bool Process (qint16 &value)
 Process primitive type. More...
 
virtual bool Process (quint32 &value)
 Process primitive type. More...
 
virtual bool Process (qint32 &value)
 Process primitive type. More...
 
virtual bool Process (quint64 &value)
 Process primitive type. More...
 
virtual bool Process (qint64 &value)
 Process primitive type. More...
 
virtual bool Process (float &value)
 Process primitive type. More...
 
virtual bool Process (double &value)
 Process primitive type. More...
 
virtual bool ProcessData (void *dataPtr, int size)
 Process binary data block. More...
 
- Public Member Functions inherited from iser::CReadArchiveBase
virtual bool IsStoring () const
 Check if this archive is loading or storing. More...
 
virtual const IVersionInfoGetVersionInfo () const
 Get version of archived stream for specific versioning type. More...
 
virtual bool ProcessBits (void *dataPtr, int bitsCount, int bytesCount)
 Process binary data block. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from iser::CXmlDocumentInfoBase
 CXmlDocumentInfoBase ()
 
bool IsCommentEnabled () const
 Check if comments in XML document are enabled. More...
 
void SetCommentEnabled (bool state=true)
 Allows comments in XML document. More...
 

Protected Member Functions

 CXmlReadArchiveBase (const CArchiveTag &rootTag)
 
bool InternEndTag (const CArchiveTag &tag, bool &wasTagSkipped)
 Extended implementation of EndTag() with additional flag signalizing that tag is skipped. More...
 
virtual bool ReadXmlHeader ()
 
virtual bool ReadXmlFooter ()
 
virtual bool ReadTextNode (QByteArray &text)
 Read single unformatted text node. More...
 
virtual bool ReadToDelimeter (const QByteArray &delimeters, QByteArray &result, bool skipDelimeter=true, char *foundDelimeterPtr=NULL)=0
 Read input stream till one of specified delimeters is found. More...
 
- Protected Member Functions inherited from iser::CReadArchiveBase
bool SerializeAcfHeader ()
 Serialize standard header. More...
 
- Protected Member Functions inherited from iser::CArchiveBase
 CArchiveBase ()
 
- Protected Member Functions inherited from istd::ILogger
virtual void DecorateMessage (IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const
 Decorate message parts before outputting. More...
 
virtual bool IsLogConsumed (const IInformationProvider::InformationCategory *categoryPtr=NULL, const int *flagsPtr=NULL) const
 Check if any log message is consumed. More...
 
virtual bool SendLogMessage (IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const
 Send any message to log. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from iser::CArchiveBase
static const CArchiveTagGetAcfRootTag ()
 
- Static Public Member Functions inherited from iser::CXmlDocumentInfoBase
static void EncodeXml (const QByteArray &text, QByteArray &xmlText)
 
static void DecodeXml (const QByteArray &xmlText, QByteArray &text)
 
static void EncodeXml (const QString &text, QByteArray &xmlText)
 
static void DecodeXml (const QByteArray &xmlText, QString &text)
 
static const QString & GetElementSeparator ()
 
- Static Protected Attributes inherited from iser::CArchiveBase
static CArchiveTag s_acfRootTag
 

Detailed Description

Base class for XML based reading archives.

Definition at line 17 of file CXmlReadArchiveBase.h.

Member Typedef Documentation

Definition at line 22 of file CXmlReadArchiveBase.h.

Constructor & Destructor Documentation

iser::CXmlReadArchiveBase::CXmlReadArchiveBase ( const CArchiveTag rootTag)
explicitprotected

Member Function Documentation

virtual bool iser::CXmlReadArchiveBase::BeginMultiTag ( const CArchiveTag tag,
const CArchiveTag subTag,
int &  count 
)
virtual

Begin of archive tag containing set of subelements of the same type.

See Also
BeginTag.
Parameters
tagmain tag.
subTagtype of subelement tag.
countnumber of subelements. If it is read archive this value will be set. If it storing archive this is input value.
useTagSkippingflag signalling that support of tag skipping should be enabled.
Returns
true if success. In this case you have to call EndTag after serializing of subelements.

Reimplemented from iser::CArchiveBase.

virtual bool iser::CXmlReadArchiveBase::BeginTag ( const CArchiveTag tag)
virtual

Begin of archive tag.

Parameters
tagtag object.
useTagSkippingflag signalling that support of tag skipping should be enabled.

Implements iser::IArchive.

virtual bool iser::CXmlReadArchiveBase::EndTag ( const CArchiveTag tag)
virtual

End of archive tag.

This method should be allways called after BeginTag is successfull called. If skipping of tag contains is supported, this will skip to the end of tag while archive reading. Otherwise you have to read contains of archive completely.

See Also
IsTagSkippingSupported.

Implements iser::IArchive.

bool iser::CXmlReadArchiveBase::InternEndTag ( const CArchiveTag tag,
bool &  wasTagSkipped 
)
protected

Extended implementation of EndTag() with additional flag signalizing that tag is skipped.

Parameters
tagserializing tag should be ended.
wasTagSkippedif tag is skipped it will be set, otherwise state is not changed.
virtual bool iser::CXmlReadArchiveBase::IsTagSkippingSupported ( ) const
virtual

Check if skiping to the end of tag on EndTag is supported.

See Also
EndTag.

Reimplemented from iser::CArchiveBase.

virtual bool iser::CXmlReadArchiveBase::Process ( QByteArray &  value)
virtual

Process primitive type.

Reimplemented from iser::CTextReadArchiveBase.

virtual bool iser::CXmlReadArchiveBase::Process ( QString &  value)
virtual

Process primitive type.

Implements iser::IArchive.

virtual bool iser::CXmlReadArchiveBase::ReadTextNode ( QByteArray &  text)
protectedvirtual

Read single unformatted text node.

Implements iser::CTextReadArchiveBase.

virtual bool iser::CXmlReadArchiveBase::ReadToDelimeter ( const QByteArray &  delimeters,
QByteArray &  result,
bool  skipDelimeter = true,
char *  foundDelimeterPtr = NULL 
)
protectedpure virtual

Read input stream till one of specified delimeters is found.

Parameters
delimeterslist of delimeters.
resultresult string object. White spaces will be trimmed at the begin and end of this string. Delimeter will be not excluded from this string.
skipDelimeterif it is true, delimeter will be not parsed by next call of this method.
foundDelimeteroptional found delimeter will be returned in this character (it means 1 byte, it is not C string).

Implemented in iser::CXmlStreamReadArchiveBase.

virtual bool iser::CXmlReadArchiveBase::ReadXmlFooter ( )
protectedvirtual
virtual bool iser::CXmlReadArchiveBase::ReadXmlHeader ( )
protectedvirtual

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

© 2007-2017 Witold Gantzke and Kirill Lepskiy