Class that catch XML Parser events for a specific tag and build the corresponding Object. More...

#include <hpp/util/parser.hh>

Inheritance diagram for hpp::util::parser::ObjectFactory:

Public Types
typedef std::list< ObjectFactory * >	ObjectFactoryList

Public Member Functions
	ObjectFactory (ObjectFactory parent=NULL, const XMLElement element=NULL)

virtual	~ObjectFactory ()

void	name (const std::string &n)
	Set the name. More...

void	name (const char *n)
	See name(const std::string&) More...

template<typename T >
T *	as ()
	Cast this class to any child class. More...

Events
virtual bool	init ()
	Called when the object is created. More...

void	setAttribute (const XMLAttribute *attr)
	Called for each attribute. More...

virtual void	addTextChild (const XMLText *text)
	Add Text child. More...

virtual bool	finishAttributes ()
	Called when all the attributes have been processed. More...

virtual void	finishTags ()
	Called when all the child tags have been processed. More...

virtual void	finishFile ()
	Called when parsing is finished. More...

Write to file
	ObjectFactory (const std::string &tagName, ObjectFactory *parent=NULL)
	Constructor for writing objects from scratch. More...

void	addAttribute (const std::string &name, const std::string &value)
	Add an attribute. More...

XMLNode *	write (XMLNode *node) const
	Add this factory as child of the node argument. More...

Accessors
std::string	tagName () const
	Return tag name of the element is any. More...

std::string	name () const
	Return the content of the attribute name, or an empty string. More...

bool	hasAttribute (const std::string &attr) const
	Check if an attribute was set. More...

std::string	getAttribute (const std::string &attr) const
	Return a given attributes. More...

ObjectFactoryList	getChildrenOfType (std::string type)
	Get a list of ObjectFactory whose tag name is type. More...

bool	getChildOfType (std::string type, ObjectFactory *&o)
	Get the ObjectFactory whose tag name is type. More...

Protected Member Functions
	ObjectFactory (ObjectFactory *root)

ObjectFactory *	parent ()

virtual ObjectFactory *	root ()

bool	hasParent () const

const XMLElement *	XMLelement ()

virtual void	impl_setAttribute (const XMLAttribute *attr)

virtual void	impl_write (XMLElement *element) const

void	addChild (ObjectFactory *child)

virtual std::ostream &	print (std::ostream &os) const

Friends
std::ostream &	operator<< (std::ostream &, const ObjectFactory &)

Detailed Description

Class that catch XML Parser events for a specific tag and build the corresponding Object.

Derive this class if you wish to extend the Parser. The event callbacks are called in the following order:

ObjectFactory::init after having created the object.
ObjectFactory::setAttribute for each attribute of the tag.
ObjectFactory::finishAttributes after having processed every attribute.
ObjectFactory::addTextChild when a child is a text element.
ObjectFactory::finishTags when all the children have been parsed.
ObjectFactory::finishFile when the file has been fully parsed.

Note: The derived class must have the following construtor
DerivedFactory (ObjectFactory* parent, const XMLElement* element) :
ObjectFactory (parent, element)
{
/*
* Keep in mind that it might be more convenient
* to build objects in an event callback, when some information
* has already been parsed.
*/
}

Member Typedef Documentation

typedef std::list<ObjectFactory*> hpp::util::parser::ObjectFactory::ObjectFactoryList

Constructor & Destructor Documentation

hpp::util::parser::ObjectFactory::ObjectFactory	(	ObjectFactory *	parent = `NULL`,
		const XMLElement *	element = `NULL`
	)

References addChild(), and root().

Referenced by as(), and ~ObjectFactory().

virtual hpp::util::parser::ObjectFactory::~ObjectFactory ( )

inlinevirtual

References addAttribute(), addTextChild(), finishAttributes(), finishFile(), finishTags(), getAttribute(), getChildOfType(), getChildrenOfType(), hasAttribute(), init(), name(), ObjectFactory(), parent(), setAttribute(), tagName(), and write().

hpp::util::parser::ObjectFactory::ObjectFactory	(	const std::string &	tagName,
		ObjectFactory *	parent = `NULL`
	)

Constructor for writing objects from scratch.

References addChild(), and root().

hpp::util::parser::ObjectFactory::ObjectFactory ( ObjectFactory * root )

protected

Member Function Documentation

void hpp::util::parser::ObjectFactory::addAttribute	(	const std::string &	name,
		const std::string &	value
	)

Add an attribute.

References name().

Referenced by ~ObjectFactory().

void hpp::util::parser::ObjectFactory::addChild ( ObjectFactory * child )

protected

References tagName().

Referenced by as(), and ObjectFactory().

void hpp::util::parser::ObjectFactory::addTextChild ( const XMLText * text )

virtual

Add Text child.

Reimplemented in hpp::util::parser::SequenceFactory< ValueType >.

Referenced by hpp::util::parser::Parser::addObjectFactory(), and ~ObjectFactory().

template<typename T >

T* hpp::util::parser::ObjectFactory::as ( )

inline

Cast this class to any child class.

References addChild(), hasParent(), impl_setAttribute(), impl_write(), ObjectFactory(), operator<<, parent(), print(), root(), and XMLelement().

bool hpp::util::parser::ObjectFactory::finishAttributes ( )

virtual

Called when all the attributes have been processed.

Returns: True to continue parsing this tag, False otherwise.

Referenced by hpp::util::parser::Parser::addObjectFactory(), and ~ObjectFactory().

void hpp::util::parser::ObjectFactory::finishFile ( )

virtual

Called when parsing is finished.

Referenced by ~ObjectFactory().

void hpp::util::parser::ObjectFactory::finishTags ( )

virtual

Called when all the child tags have been processed.

Referenced by hpp::util::parser::Parser::addObjectFactory(), and ~ObjectFactory().

std::string hpp::util::parser::ObjectFactory::getAttribute ( const std::string & attr ) const

Return a given attributes.

References hppDout.

Referenced by ~ObjectFactory().

bool hpp::util::parser::ObjectFactory::getChildOfType	(	std::string	type,
		ObjectFactory *&	o
	)

Get the ObjectFactory whose tag name is type.

Parameters

[out] o Set to the first element of the requested type.

Returns: true if there was only element of the requested type. false if there are more than one.

Exceptions

std::invalid_argument if no ObjectFactory of the requested type exists.

References getChildrenOfType(), hppDout, and tagName().

Referenced by ~ObjectFactory().

std::list< ObjectFactory * > hpp::util::parser::ObjectFactory::getChildrenOfType ( std::string type )

Get a list of ObjectFactory whose tag name is type.

Referenced by getChildOfType(), and ~ObjectFactory().

bool hpp::util::parser::ObjectFactory::hasAttribute ( const std::string & attr ) const

Check if an attribute was set.

Referenced by ~ObjectFactory().

bool hpp::util::parser::ObjectFactory::hasParent ( ) const

protected

Referenced by as().

void hpp::util::parser::ObjectFactory::impl_setAttribute ( const XMLAttribute * attr )

protectedvirtual

Referenced by as(), and setAttribute().

void hpp::util::parser::ObjectFactory::impl_write ( XMLElement * element ) const

protectedvirtual

Reimplemented in hpp::util::parser::SequenceFactory< ValueType >, and hpp::util::parser::IgnoreTagFactory.

Referenced by as(), and write().

bool hpp::util::parser::ObjectFactory::init ( )

virtual

Called when the object is created.

Returns: True to continue parsing this tag, False otherwise.

Reimplemented in hpp::util::parser::IgnoreTagFactory.

Referenced by hpp::util::parser::Parser::addObjectFactory(), and ~ObjectFactory().

std::string hpp::util::parser::ObjectFactory::name ( ) const

Return the content of the attribute name, or an empty string.

Referenced by addAttribute(), name(), print(), setAttribute(), and ~ObjectFactory().

void hpp::util::parser::ObjectFactory::name ( const std::string & n )

Set the name.

The default value is the value of the attribute "name" of the XML tag or an empty string if this does not exist.

void hpp::util::parser::ObjectFactory::name ( const char * n )

See name(const std::string&)

References name().

ObjectFactory * hpp::util::parser::ObjectFactory::parent ( )

protected

Referenced by as(), hpp::util::parser::create(), and ~ObjectFactory().

std::ostream & hpp::util::parser::ObjectFactory::print ( std::ostream & os ) const

protectedvirtual

References name(), and tagName().

Referenced by as(), and hpp::util::parser::operator<<().

ObjectFactory * hpp::util::parser::ObjectFactory::root ( )

protectedvirtual

Referenced by as(), and ObjectFactory().

void hpp::util::parser::ObjectFactory::setAttribute ( const XMLAttribute * attr )

Called for each attribute.

A few reserved name are automatocally catched. The reserved names are "name" and "id". "name" expects a string. "id" expects an unsigned integer and can be use to define pointers to elements.

References hppDout, impl_setAttribute(), and name().

Referenced by hpp::util::parser::Parser::addObjectFactory(), and ~ObjectFactory().

std::string hpp::util::parser::ObjectFactory::tagName ( ) const

Return tag name of the element is any.

Returns "No element" otherwise.

Referenced by addChild(), hpp::util::parser::Parser::addObjectFactory(), getChildOfType(), print(), write(), and ~ObjectFactory().

XMLNode * hpp::util::parser::ObjectFactory::write ( XMLNode * node ) const

Add this factory as child of the node argument.

Get a new XMLElement from the content of this factory.

Tags are handled throught children so you should add children before calling this function. If you factory must write something different from tags (XMLText or XMLComment), reimplement method impl_write.

References impl_write(), and tagName().

Referenced by ~ObjectFactory().

const XMLElement * hpp::util::parser::ObjectFactory::XMLelement ( )

protected

Referenced by as().

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const ObjectFactory &	o
	)

friend

Referenced by as().

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation