hpp::util::parser::ObjectFactory Class Reference

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)
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 ()
void	setAttribute (const XMLAttribute *attr)
virtual void	addTextChild (const XMLText *text)
	Add Text child. More...
virtual bool	finishAttributes ()
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
	Get a new XMLElement from the content of this factory. More...
Accessors
std::string	tagName () const
std::string	name () const
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)

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

ObjectFactoryList

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

Constructor & Destructor Documentation

ObjectFactory() [1/3]

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

~ObjectFactory()

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

inlinevirtual

ObjectFactory() [2/3]

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

Constructor for writing objects from scratch.

ObjectFactory() [3/3]

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

protected

Member Function Documentation

addAttribute()

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

Add an attribute.

addChild()

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

protected

addTextChild()

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

virtual

Add Text child.

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

as()

template<typename T >

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

inline

Cast this class to any child class.

finishAttributes()

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

virtual

Called when all the attributes have been processed.

Returns

True to continue parsing this tag, False otherwise.

finishFile()

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

virtual

Called when parsing is finished.

finishTags()

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

virtual

Called when all the child tags have been processed.

getAttribute()

std::string hpp::util::parser::ObjectFactory::getAttribute

(

const std::string &

attr

)

const

Return a given attributes.

getChildOfType()

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.

getChildrenOfType()

std::list< ObjectFactory * > hpp::util::parser::ObjectFactory::getChildrenOfType

(

std::string

type

)

Get a list of ObjectFactory whose tag name is type.

hasAttribute()

bool hpp::util::parser::ObjectFactory::hasAttribute

(

const std::string &

attr

)

const

Check if an attribute was set.

hasParent()

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

protected

impl_setAttribute()

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

protectedvirtual

impl_write()

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

protectedvirtual

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

init()

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.

name() [1/3]

std::string hpp::util::parser::ObjectFactory::name

(

)

const

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

name() [2/3]

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.

name() [3/3]

void hpp::util::parser::ObjectFactory::name

(

const char *

n

)

See name(const std::string&)

parent()

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

protected

print()

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

protectedvirtual

root()

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

protectedvirtual

setAttribute()

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.

tagName()

std::string hpp::util::parser::ObjectFactory::tagName

(

)

const

Return tag name of the element is any. Returns "No element" otherwise.

write()

XMLNode * hpp::util::parser::ObjectFactory::write

(

XMLNode *

node

)

const

Get a new XMLElement from the content of this factory.

Add this factory as child of the node argument. 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.

XMLelement()

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

protected

Friends And Related Function Documentation

operator<<

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

friend

---

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

• include/hpp/util/parser.hh
• src/parser.cc