Xml Element. More...

#include <yatexml.h>

Inheritance diagram for XmlElement:

Public Member Functions
	XmlElement (const NamedList &element, bool empty, XmlParent *parent=0)
	XmlElement (const char *name, bool complete=true)
	XmlElement (const char name, const char value, bool complete=true)
	XmlElement (const XmlElement &orig)
virtual	~XmlElement ()
const char *	tag () const
bool	isDefaultNs () const
const String &	unprefixedTag () const
void	setUnprefixedTag (const String &s)
const String &	getTag () const
bool	getTag (const String &tag, const String &ns) const
virtual XmlElement *	xmlElement ()
virtual XmlElement *	element ()
virtual XmlSaxParser::Error	addChild (XmlChild *child)
virtual XmlChild *	removeChild (XmlChild *child, bool delObj=true)
virtual void	setCompleted ()
bool	completed () const
bool	empty () const
XmlElement *	parent () const
virtual XmlParent *	getParent ()
virtual void	setParent (XmlParent *parent)
virtual const String &	getName () const
virtual const NamedList &	getElement () const
const ObjList &	getChildren () const
void	clearChildren ()
const NamedList *	inheritedNs () const
void	setInheritedNs (const XmlElement *xml=0, bool inherit=true)
void	addInheritedNs (const NamedList &list)
XmlElement *	pop ()
virtual const String &	toString () const
void	toString (String &dump, bool escape=true, const String &indent=String::empty(), const String &origIndent=String::empty(), bool completeOnly=true, const String *auth=0) const
XmlElement *	findFirstChild (const String name=0, const String ns=0, bool noPrefix=true) const
XmlElement *	findFirstChild (const String &name, const String *ns=0, bool noPrefix=true) const
XmlElement *	findNextChild (const XmlElement prev=0, const String name=0, const String *ns=0, bool noPrefix=true) const
XmlElement *	findNextChild (const String &name, const XmlElement prev=0, const String ns=0, bool noPrefix=true) const
const String *	childText (const String &name, const String *ns=0, bool noPrefix=true) const
XmlChild *	getFirstChild ()
const String &	getText () const
XmlText *	setText (const char *text)
void	addText (const char *text)
void	addText (const void *buf, unsigned int len)
const NamedList &	attributes () const
unsigned int	copyAttributes (NamedList &list, const String &prefix) const
void	setAttributes (const NamedList &list, const String &prefix=String::empty(), bool skipPrefix=true)
void	setAttribute (const String &name, const char *value)
void	setAttributeValid (const String &name, const char *value)
const char *	attribute (const String &name) const
String *	getAttribute (const String &name) const
bool	hasAttribute (const String &name, const String &value) const
void	removeAttribute (const String &name)
String *	xmlns () const
String *	xmlnsAttribute (const String &name) const
bool	hasXmlns (const String &ns) const
bool	setXmlns (const String &name=String::empty(), bool addAttr=false, const String &value=String::empty())
virtual void	replaceParams (const NamedList &params)
XmlElement *	addChild (const char name, const char value=0)
XmlElement *	addChildHex (const char name, const void buf, unsigned int len)
Public Member Functions inherited from XmlChild
	XmlChild ()
virtual XmlComment *	xmlComment ()
virtual XmlCData *	xmlCData ()
virtual XmlText *	xmlText ()
virtual XmlDeclaration *	xmlDeclaration ()
virtual XmlDoctype *	xmlDoctype ()
Public Member Functions inherited from GenObject
	GenObject ()
virtual	~GenObject ()
virtual bool	alive () const
virtual void	destruct ()
virtual const String &	traceId () const
virtual void *	getObject (const String &name) const
NamedCounter *	getObjCounter () const
NamedCounter *	setObjCounter (NamedCounter *counter)
Public Member Functions inherited from XmlParent
	XmlParent ()
virtual	~XmlParent ()
virtual XmlDocument *	document ()
virtual XmlFragment *	fragment ()
XmlChild *	addChildSafe (XmlChild child, XmlSaxParser::Error code=0)
virtual void	reset ()
bool	hasChildren () const

Static Public Member Functions
static bool	isXmlns (const String &str)
static XmlElement *	param2xml (NamedString *param, const String &tag, bool copyXml=false)
static NamedString *	xml2param (XmlElement xml, const String tag, bool copyXml=false)
static void	xml2param (NamedList &list, XmlElement parent, const String tag, bool copyXml=false)
Static Public Member Functions inherited from GenObject
static void *	getObject (const String &name, const GenObject *obj)
static bool	getObjCounting ()
static void	setObjCounting (bool enable)
static NamedCounter *	getObjCounter (const String &name, bool create=true)
static ObjList &	getObjCounters ()

Static Public Attributes
static const String	s_ns
static const String	s_nsPrefix

Detailed Description

Xml Element.

Xml Element from a Xml document

Constructor & Destructor Documentation

◆ XmlElement() [1/4]

XmlElement	(	const NamedList &	element,
		bool	empty,
		XmlParent *	parent = 0 )

Constructor

Parameters

element	The NamedList name represent the element name and the param the attributes
empty	False if has children
parent	The parent of this element

References element(), empty(), parent(), and XmlParent::XmlParent().

Referenced by addChild(), addChildHex(), childText(), element(), findFirstChild(), findFirstChild(), findNextChild(), findNextChild(), param2xml(), parent(), pop(), setInheritedNs(), xml2param(), xml2param(), XmlElement(), and xmlElement().

◆ XmlElement() [2/4]

XmlElement	(	const char *	name,
		bool	complete = true )

Constructor. Creates a new complete and empty element

Parameters

name	The name of the element
complete	False to build an incomplete element

◆ XmlElement() [3/4]

XmlElement	(	const char *	name,
		const char *	value,
		bool	complete = true )

Constructor. Create a new element with a text child

Parameters

name	The name of the element
value	Element text child value
complete	False to build an incomplete element

◆ XmlElement() [4/4]

XmlElement ( const XmlElement & orig )

Copy constructor

Parameters

orig	Original XmlElement

References XmlElement().

◆ ~XmlElement()

virtual ~XmlElement ( )

virtual

Destructor

Member Function Documentation

◆ addChild() [1/2]

XmlElement * addChild	(	const char *	name,
		const char *	value = 0 )

inline

Safely build and add an XmlElement child

Parameters

name	The name of the element
value	Element text child value

Returns: XmlElement pointer on success, NULL on failure

References XmlParent::addChildSafe(), and XmlElement().

◆ addChild() [2/2]

virtual XmlSaxParser::Error addChild ( XmlChild * child )

virtual

Append a new child of this element

Parameters

child The child to append

Implements XmlParent.

References XmlChild::XmlChild().

Referenced by addChildHex().

◆ addChildHex()

XmlElement * addChildHex	(	const char *	name,
		const void *	buf,
		unsigned int	len )

inline

Safely build and add an XmlElement child with hexified value

Parameters

name	The name of the element
buf	Pointer to buffer to hexify
len	Buffer length

Returns: XmlElement pointer on success, NULL on failure

References addChild(), addText(), and XmlElement().

◆ addInheritedNs()

void addInheritedNs ( const NamedList & list )

Add inherited namespaces from a list

Parameters

list	The list of namespaces

◆ addText() [1/2]

void addText ( const char * text )

Add a text child

Parameters

text	Non empty text to add

Referenced by addChildHex().

◆ addText() [2/2]

void addText	(	const void *	buf,
		unsigned int	len )

Add a text child with hexified value

Parameters

buf	Pointer to buffer to hexify
len	Buffer length

◆ attribute()

const char * attribute ( const String & name ) const

inline

Obtain an attribute value for the given name

Parameters

name	The name of the attribute

Returns: Attribute value

◆ attributes()

const NamedList & attributes ( ) const

inline

Retrieve the list of attributes

Returns: Element attributes

◆ childText()

const String * childText	(	const String &	name,
		const String *	ns = 0,
		bool	noPrefix = true ) const

inline

Retrieve a child's text

Parameters

name	Name (tag) of the child
ns	Optional child namespace
noPrefix	True to compare the tag without namespace prefix, false to include namespace prefix when comparing the given tag. This parameter is ignored ns is not 0

Returns: Pointer to child's text, 0 if the child was not found

References findFirstChild(), getText(), and XmlElement().

◆ clearChildren()

void clearChildren ( )

inlinevirtual

Helper method to clear the children list

Reimplemented from XmlParent.

◆ completed()

bool completed ( ) const

inline

Returns: True if this element is completed

Referenced by pop().

◆ copyAttributes()

unsigned int copyAttributes	(	NamedList &	list,
		const String &	prefix ) const

Copy element attributes to a list of parameters

Parameters

list	Destination list
prefix	Prefix to be added to each attribute name

Returns: The number of attributes added to the destination list

◆ element()

virtual XmlElement * element ( )

inlinevirtual

Get an XmlElement from this XmlParent

Returns: This object

Reimplemented from XmlParent.

References XmlElement().

Referenced by parent(), and XmlElement().

◆ empty()

bool empty ( ) const

inline

Returns: True if this element is empty

Referenced by XmlElement().

◆ findFirstChild() [1/2]

XmlElement * findFirstChild	(	const String &	name,
		const String *	ns = 0,
		bool	noPrefix = true ) const

inline

Find the first XmlElement child of this XmlElement

Parameters

name	Name of the child
ns	Optional child namespace
noPrefix	True to compare the tag without namespace prefix, false to include namespace prefix when comparing the given tag. This parameter is ignored if name is 0 or ns is not 0

Returns: The first child element meeting the requested conditions

References XmlFragment::findElement(), getChildren(), and XmlElement().

◆ findFirstChild() [2/2]

XmlElement * findFirstChild	(	const String *	name = 0,
		const String *	ns = 0,
		bool	noPrefix = true ) const

inline

Find the first XmlElement child of this XmlElement

Parameters

name	Optional name of the child
ns	Optional child namespace
noPrefix	True to compare the tag without namespace prefix, false to include namespace prefix when comparing the given tag. This parameter is ignored if name is 0 or ns is not 0

Returns: The first child element meeting the requested conditions

References XmlFragment::findElement(), getChildren(), and XmlElement().

Referenced by childText(), findNextChild(), and pop().

◆ findNextChild() [1/2]

XmlElement * findNextChild	(	const String &	name,
		const XmlElement *	prev = 0,
		const String *	ns = 0,
		bool	noPrefix = true ) const

inline

Finds next XmlElement child of this XmlElement

Parameters

name	Name of the child
prev	Previous child
ns	Optional child namespace
noPrefix	True to compare the tag without namespace prefix, false to include namespace prefix when comparing the given tag. This parameter is ignored if name is 0 or ns is not 0

Returns: The next found child if prev exists else the first

References findNextChild(), and XmlElement().

◆ findNextChild() [2/2]

XmlElement * findNextChild	(	const XmlElement *	prev = 0,
		const String *	name = 0,
		const String *	ns = 0,
		bool	noPrefix = true ) const

inline

Finds next XmlElement child of this XmlElement

Parameters

prev	Previous child
name	Optional name of the child
ns	Optional child namespace
noPrefix	True to compare the tag without namespace prefix, false to include namespace prefix when comparing the given tag. This parameter is ignored if name is 0 or ns is not 0

Returns: The next found child if prev exists else the first

References ObjList::find(), XmlFragment::findElement(), findFirstChild(), getChildren(), ObjList::skipNext(), and XmlElement().

Referenced by findNextChild().

◆ getAttribute()

String * getAttribute ( const String & name ) const

inline

Obtain an attribute value for the given name

Parameters

name	The name of the attribute

Returns: String pointer or 0 if not found

Referenced by hasAttribute().

◆ getChildren()

const ObjList & getChildren ( ) const

inlinevirtual

Helper method to obtain the children list

Returns: The children list

Reimplemented from XmlParent.

Referenced by findFirstChild(), findFirstChild(), and findNextChild().

◆ getElement()

virtual const NamedList & getElement ( ) const

inlinevirtual

Returns: The held element

◆ getFirstChild()

XmlChild * getFirstChild ( )

Get first XmlChild of this XmlElement

Returns: The first XmlChild found.

References XmlChild::XmlChild().

◆ getName()

virtual const String & getName ( ) const

inlinevirtual

Returns: The name of this element

◆ getParent()

virtual XmlParent * getParent ( )

inlinevirtual

Returns: The parent of this element

References XmlParent::XmlParent().

◆ getTag() [1/2]

const String & getTag ( ) const

inline

Retrieve the element's tag (without prefix)

Returns: Element tag

◆ getTag() [2/2]

bool getTag	(	const String *&	tag,
		const String *&	ns ) const

Retrieve the element's tag (without prefix) and namespace

Parameters

tag	Pointer to element tag
ns	Pointer to element's namespace (may be 0 for unprefixed tags)

Returns: True if a namespace was found for the element tag or the tag is not prefixed

References tag().

◆ getText()

const String & getText ( ) const

Returns: The first XmlText found in this XmlElement children

Referenced by XPath::anyValue(), and childText().

◆ hasAttribute()

bool hasAttribute	(	const String &	name,
		const String &	value ) const

inline

Check if the element has an attribute with a requested value

Parameters

name	The name of the attribute
value	The value to check

Returns: True if the element has an attribute with the requested value

References getAttribute().

◆ hasXmlns()

bool hasXmlns ( const String & ns ) const

inline

Verify if this element belongs to the given namespace

Parameters

ns	The namespace to compare with

Returns: True if this element belongs to the given namespace

References xmlns().

◆ inheritedNs()

const NamedList * inheritedNs ( ) const

inline

Retrieve the list of inherited namespaces

Returns: The list of inherited namespaces (or 0)

◆ isDefaultNs()

bool isDefaultNs ( ) const

inline

Check if this element must be processed in the default namespace (its tag is not prefixed)

Returns: True if this element must be processed in the default namespace

◆ isXmlns()

bool isXmlns ( const String & str )

inlinestatic

Check if a string represents a namespace attribute name

Parameters

str	The string to check

Returns: True if the given string is the default namespace attribute name or a namespace attribute name prefix

References s_ns, s_nsPrefix, and String::startsWith().

◆ param2xml()

XmlElement * param2xml	(	NamedString *	param,
		const String &	tag,
		bool	copyXml = false )

static

Build an XML element from a list parameter. Parameter name will be set in a 'name' attribute. Parameter value will be set in a 'value' attribute Handle NamedPointer parameters carrying DataBlock, NamedList and XmlElement objects (a 'type' attribute is added to the created element). DataBlock: Encode using BASE64 and add it as element text NamedList: The name is added as element text. The function is called again for each list parameter XmlElement: Added as child to newly created element

Parameters

param	The parameter to convert
tag	XmlElement tag
copyXml	True to copy XmlElement objects instead of just remove them from the parameter

Returns: XmlElement pointer or 0 on failure

References tag(), and XmlElement().

◆ parent()

XmlElement * parent ( ) const

inline

Retrieve an XmlElement parent of this one

Returns: XmlElement pointer or 0

References element(), and XmlElement().

Referenced by setParent(), xml2param(), and XmlElement().

◆ pop()

XmlElement * pop ( )

inline

Extract the first child element

Returns: XmlElement pointer or 0

References completed(), findFirstChild(), and XmlElement().

◆ removeAttribute()

void removeAttribute ( const String & name )

inline

Remove an attribute

Parameters

name	Attribute name

Referenced by setAttributeValid().

◆ removeChild()

virtual XmlChild * removeChild	(	XmlChild *	child,
		bool	delObj = true )

virtual

Remove a child

Parameters

child	The child to remove
delObj	True to delete the object

Returns: XmlChild pointer if found and not deleted

Implements XmlParent.

References XmlChild::XmlChild().

◆ replaceParams()

virtual void replaceParams ( const NamedList & params )

virtual

Replaces all ${paramname} in element's attributes and children with the corresponding parameters

Parameters

params List of parameters

Reimplemented from XmlChild.

◆ setAttribute()

void setAttribute	(	const String &	name,
		const char *	value )

inline

Add or replace an attribute

Parameters

name	Attribute name
value	Attribute value

◆ setAttributes()

void setAttributes	(	const NamedList &	list,
		const String &	prefix = String::empty(),
		bool	skipPrefix = true )

inline

Set element attributes from a list of parameters

Parameters

list	List of attributes
prefix	Add only the attributes that start with this prefix. Set attributes from the whole parameter list if this parameter is empty
skipPrefix	Skip over the prefix when building attribute name

References String::empty().

◆ setAttributeValid()

void setAttributeValid	(	const String &	name,
		const char *	value )

inline

Add or replace an attribute. Clears it if value is empty

Parameters

name	Attribute name
value	Attribute value

References removeAttribute().

◆ setCompleted()

virtual void setCompleted ( )

inlinevirtual

Notification for this element that is complete

◆ setInheritedNs()

void setInheritedNs	(	const XmlElement *	xml = 0,
		bool	inherit = true )

Set inherited namespaces from a given element. Reset them anyway

Parameters

xml	The source element used to set inherited namespaces
inherit	Copy element's inherited namespaces if it doesn't have a parent

References XmlElement().

◆ setParent()

virtual void setParent ( XmlParent * parent )

virtual

Set this element's parent. Update inherited namespaces

Returns: The parent of this element

Reimplemented from XmlChild.

References parent(), and XmlParent::XmlParent().

◆ setText()

XmlText * setText ( const char * text )

Set text for first XmlText element found in this XmlElement's children If child text element does not exist, create it and append it to the element's children.

Parameters

text	Text to set to the XmlElement. If null, the first found XmlText element will be deleted.

Returns: The set XmlText if text was set, null if an XmlText was deleted

◆ setUnprefixedTag()

void setUnprefixedTag ( const String & s )

Set element's unprefixed tag, don't change namespace prefix

Parameters

s	New element's tag

◆ setXmlns()

bool setXmlns	(	const String &	name = String::empty(),
		bool	addAttr = false,
		const String &	value = String::empty() )

Set the element's namespace

Parameters

name	The namespace name (element prefix). Can be the default namespace attribute name (empty means the default one)
addAttr	True to add a non empty, not repeating, namespace attribute to the list
value	Namespace value (ignored if addAttr is false)

Returns: True on success, false if another namespace exists with the same value

References String::empty().

◆ tag()

const char * tag ( ) const

inline

Retrieve the element's tag

Returns: The element's tag

Referenced by getTag(), param2xml(), xml2param(), and xml2param().

◆ toString() [1/2]

virtual const String & toString ( ) const

inlinevirtual

Retrieve the element tag

Returns: The element tag

Reimplemented from GenObject.

◆ toString() [2/2]

void toString	(	String &	dump,
		bool	escape = true,
		const String &	indent = String::empty(),
		const String &	origIndent = String::empty(),
		bool	completeOnly = true,
		const String *	auth = 0 ) const

Build (append to) a String from this XmlElement

Parameters

dump	The destination string
escape	True if the attributes values need to be escaped
indent	Spaces for output
origIndent	Original indent
completeOnly	True to build only if complete
auth	Optional list of tag and attribute names to be replaced with '***'. This parameter can be used when the result will be printed to output to avoid printing authentication data to output. The array must end with an empty string

References String::empty().

◆ unprefixedTag()

const String & unprefixedTag ( ) const

inline

Retrieve the element's tag unprefixed (namespace prefix removed)

Returns: The element's tag unprefixed

◆ xml2param() [1/2]

void xml2param	(	NamedList &	list,
		XmlElement *	parent,
		const String *	tag,
		bool	copyXml = false )

static

Build and add list parameters from XML element children. Each parameter will be taken from 'name' and 'value' attributes. See param2xml for more info

Parameters

list	Destination list
parent	The XML element to process
tag	Child XmlElement tag to handle
copyXml	True to copy XmlElement objects instead of just remove them from parent

References parent(), tag(), and XmlElement().

◆ xml2param() [2/2]

NamedString * xml2param	(	XmlElement *	xml,
		const String *	tag,
		bool	copyXml = false )

static

Build a list parameter from xml element See param2xml for more info

Parameters

xml	The XML element to process
tag	Child XmlElement tag to handle
copyXml	True to copy XmlElement objects instead of just remove them from parent

Returns: NamedString pointer or 0 on failure

References tag(), and XmlElement().

◆ xmlElement()

virtual XmlElement * xmlElement ( )

inlinevirtual

Get an XmlElement from this XmlChild

Returns: This object

Reimplemented from XmlChild.

References XmlElement().

◆ xmlns()

String * xmlns ( ) const

inline

Retrieve the element's namespace

Returns: Element's namespace or 0 if not found

References s_ns, s_nsPrefix, and xmlnsAttribute().

Referenced by hasXmlns().

◆ xmlnsAttribute()

String * xmlnsAttribute ( const String & name ) const

Retrieve a namespace attribute. Search in parent or inherited for it

Returns: String pointer or 0 if not found

Referenced by xmlns().

Member Data Documentation

◆ s_ns

const String s_ns

static

Default namespace attribute name

Referenced by isXmlns(), and xmlns().

◆ s_nsPrefix

const String s_nsPrefix

static

Namespace attribute name perfix

Referenced by isXmlns(), and xmlns().

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

yatexml.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XmlElement() [1/4]

◆ XmlElement() [2/4]

◆ XmlElement() [3/4]

◆ XmlElement() [4/4]

◆ ~XmlElement()

Member Function Documentation

◆ addChild() [1/2]

◆ addChild() [2/2]

◆ addChildHex()

◆ addInheritedNs()

◆ addText() [1/2]

◆ addText() [2/2]

◆ attribute()

◆ attributes()

◆ childText()

◆ clearChildren()

◆ completed()

◆ copyAttributes()

◆ element()

◆ empty()

◆ findFirstChild() [1/2]

◆ findFirstChild() [2/2]

◆ findNextChild() [1/2]

◆ findNextChild() [2/2]

◆ getAttribute()

◆ getChildren()

◆ getElement()

◆ getFirstChild()

◆ getName()

◆ getParent()

◆ getTag() [1/2]

◆ getTag() [2/2]

◆ getText()

◆ hasAttribute()

◆ hasXmlns()

◆ inheritedNs()

◆ isDefaultNs()

◆ isXmlns()

◆ param2xml()

◆ parent()

◆ pop()

◆ removeAttribute()

◆ removeChild()

◆ replaceParams()

◆ setAttribute()

◆ setAttributes()

◆ setAttributeValid()

◆ setCompleted()

◆ setInheritedNs()

◆ setParent()

◆ setText()

◆ setUnprefixedTag()

◆ setXmlns()

◆ tag()

◆ toString() [1/2]

◆ toString() [2/2]

◆ unprefixedTag()

◆ xml2param() [1/2]

◆ xml2param() [2/2]

◆ xmlElement()

◆ xmlns()

◆ xmlnsAttribute()

Member Data Documentation

◆ s_ns

◆ s_nsPrefix