Serializer Interface Reference

List of all members.

---

Detailed Description

Interface one must derive from if you want to write a serializer the hard way.

Public Member Functions
virtual const char *	className ()=0
	returns the class name as it is in the cpp hase map.
virtual IEntry *	CreateNewUserObject ()=0
	return a new POCO according to the serializer class
virtual bool	Deserialize (BinaryReader &writer, IEntry *pNewObject)=0
	De serialization, this function is usualy auto generated by the gsxml to cpp but the user can override this function.
std::string	GenerateUIDFromID (const std::string &objectID)
virtual size_t	GetNumberOfProperties ()=0
	return the number of properties.
virtual boost::any	GetRoutingField (const IEntry *pIEntry)=0
	return the routing field value if exist
virtual int	GetRoutingFieldOffset ()=0
	return the routing field offset
virtual ExternalEntryPtr	getSchema ()=0
virtual std::string	GetUID (const IEntry *userObject)=0
	extract the uid of the object
virtual long	GetVersionID (const IEntry *userObject)=0
	extract the version id of the object
virtual bool	IsAutoGenerateUID ()=0
	returns true if the class has the attribute autoGenrate="true"
virtual bool	IsFifo ()=0
	Return true if the class has the Fifo attribute.
virtual bool	IsPersist ()=0
	Return true if the class has the persist attribute.
virtual bool	IsReplicate ()=0
	Return true if the class has the Replicate attribute.
virtual bool	IsRoutingFieldNull (const IEntry *pIEntry)=0
	className return the full class name of this serializer
virtual void	PostDeserialize (IEntry *pNewObject)
	called after De serialization, can be overridden by user
virtual void	PreSerialize (const IEntry *ptr, bool isTemplate=false)
	called before serialization, can be overridden by the user
virtual void	Serialize (const IEntry *ptr, BinaryWriter &writer, bool isTemplate=false, bool isTransient=false)=0
	Serialization, this function is usualy auto generated by the gsxml2cpp but the user can override this function.
virtual bool	SetUID (IEntry *pUserObject, std::string newUID)=0
	set the UID
virtual bool	SetVersionID (IEntry *pUserObject, long newVersionID)=0
	set version id

---

Member Function Documentation

virtual const char* Serializer::className

(

)

[pure virtual]

returns the class name as it is in the cpp hase map.

className return the full class name of this serializer

virtual IEntry* Serializer::CreateNewUserObject

(

)

[pure virtual]

return a new POCO according to the serializer class

virtual bool Serializer::Deserialize	(	BinaryReader &	writer,
		IEntry *	pNewObject
	)			[pure virtual]

De serialization, this function is usualy auto generated by the gsxml to cpp but the user can override this function.

virtual size_t Serializer::GetNumberOfProperties

(

)

[pure virtual]

return the number of properties.

virtual boost::any Serializer::GetRoutingField

(

const IEntry *

pIEntry

)

[pure virtual]

return the routing field value if exist

virtual int Serializer::GetRoutingFieldOffset

(

)

[pure virtual]

return the routing field offset

virtual std::string Serializer::GetUID

(

const IEntry *

userObject

)

[pure virtual]

extract the uid of the object

virtual long Serializer::GetVersionID

(

const IEntry *

userObject

)

[pure virtual]

extract the version id of the object

virtual bool Serializer::IsAutoGenerateUID

(

)

[pure virtual]

returns true if the class has the attribute autoGenrate="true"

virtual bool Serializer::IsFifo

(

)

[pure virtual]

Return true if the class has the Fifo attribute.

virtual bool Serializer::IsPersist

(

)

[pure virtual]

Return true if the class has the persist attribute.

virtual bool Serializer::IsReplicate

(

)

[pure virtual]

Return true if the class has the Replicate attribute.

virtual bool Serializer::IsRoutingFieldNull

(

const IEntry *

pIEntry

)

[pure virtual]

className return the full class name of this serializer

virtual void Serializer::PostDeserialize

(

IEntry *

pNewObject

)

[inline, virtual]

called after De serialization, can be overridden by user

virtual void Serializer::PreSerialize	(	const IEntry *	ptr,
		bool	isTemplate = false
	)			[inline, virtual]

called before serialization, can be overridden by the user

virtual void Serializer::Serialize	(	const IEntry *	ptr,
		BinaryWriter &	writer,
		bool	isTemplate = false,
		bool	isTransient = false
	)			[pure virtual]

Serialization, this function is usualy auto generated by the gsxml2cpp but the user can override this function.

virtual bool Serializer::SetUID	(	IEntry *	pUserObject,
		std::string	newUID
	)			[pure virtual]

set the UID

virtual bool Serializer::SetVersionID	(	IEntry *	pUserObject,
		long	newVersionID
	)			[pure virtual]

set version id

---