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 XmlElement &orig)
virtual	~XmlElement ()
const char *	tag () const
bool	isDefaultNs () const
const String &	unprefixedTag () const
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 *	findNextChild (XmlElement prev=0, const String name=0, const String *ns=0, bool noPrefix=true) const
const String &	getText ()
void	addText (const char *text)
const NamedList &	attributes () const
unsigned int	copyAttributes (NamedList &list, const String &prefix) const
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())
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 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	(	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

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 ( const XmlElement & orig )

Copy constructor

Parameters:

orig	Original XmlElement

virtual ~XmlElement ( ) [virtual]

Destructor

Member Function Documentation

virtual XmlSaxParser::Error addChild ( XmlChild * child ) [virtual]

Append a new child of this element

Parameters:

child The child to append

Implements XmlParent.

Referenced by XMPPUtils::createFailure(), XMPPUtils::createIqAuthGet(), XMPPUtils::createIqResult(), XMPPUtils::createXOobUrl(), and XMPPUtils::setPriority().

void addInheritedNs ( const NamedList & list )

Add inherited namespaces from a list

Parameters:

list	The list of namespaces

void addText ( const char * text )

Add a text child

Parameters:

text	Non empty text to add

Referenced by XMPPUtils::createElement().

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

const NamedList& attributes ( ) const [inline]

Retrieve the list of attributes

Returns:: Element attributes

void clearChildren ( ) [inline, virtual]

Helper method to clear the children list

Reimplemented from XmlParent.

bool completed ( ) const [inline]

Returns:: True if this element is completed

Referenced by XmlElement::pop().

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

virtual XmlElement* element ( ) [inline, virtual]

Get an XmlElement from this XmlParent

Returns:: This object

Reimplemented from XmlParent.

Referenced by XmlElement::parent().

bool empty ( ) const [inline]

Returns:: True if this element is empty

XmlElement* findFirstChild	(	const String *	name = `0`,
		const String *	ns = `0`,
		bool	noPrefix = `true`
	)		const `[inline]`

Find the first 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().

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

Finds next 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(), and ObjList::skipNext().

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 XMPPUtils::isResponse().

const ObjList& getChildren ( ) const [inline, virtual]

Helper method to obtain the children list

Returns:: The children list

Reimplemented from XmlParent.

virtual const NamedList& getElement ( ) const [inline, virtual]

Returns:: The held element

virtual const String& getName ( ) const [inline, virtual]

Returns:: The name of this element

virtual XmlParent* getParent ( ) [inline, virtual]

Returns:: The parent of this element

const String& getTag ( ) const [inline]

Retrieve the element's tag (without prefix)

Returns:: Element tag

Referenced by XMPPUtils::getTag(), and XMPPUtils::tag().

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

const String& getText ( )

Returns:: The first XmlText found in this XmlElement children

Referenced by XMPPUtils::subject().

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

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

Referenced by XMPPUtils::hasXmlns().

const NamedList* inheritedNs ( ) const [inline]

Retrieve the list of inherited namespaces

Returns:: The list of inherited namespaces (or 0)

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

static bool isXmlns ( const String & str ) [inline, static]

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 String::startsWith().

static 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

XmlElement* parent ( ) const [inline]

Retrieve an XmlElement parent of this one

Returns:: XmlElement pointer or 0

References XmlElement::element().

XmlElement* pop ( ) [inline]

Extract the first child element

Returns:: XmlElement pointer or 0

References XmlElement::completed().

void removeAttribute ( const String & name ) [inline]

Remove an attribute

Parameters:

name	Attribute name

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.

void setAttribute	(	const String &	name,
		const char *	value
	)		`[inline]`

Add or replace an attribute

Parameters:

name	Attribute name
value	Attribute value

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 TelEngine::null().

Referenced by XMPPUtils::createParameter().

virtual void setCompleted ( ) [inline, virtual]

Notification for this element that is complete

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

virtual void setParent ( XmlParent * parent ) [virtual]

Set this element's parent. Update inherited namespaces

Returns:: The parent of this element

Reimplemented from XmlChild.

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

Referenced by XMPPUtils::createElement(), and XMPPUtils::setXmlns().

const char* tag ( ) const [inline]

Retrieve the element's tag

Returns:: The element's tag

virtual const String& toString ( ) const [inline, virtual]

Retrieve the element tag

Returns:: The element tag

Reimplemented from GenObject.

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

const String& unprefixedTag ( ) const [inline]

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

Returns:: The element's tag unprefixed

Referenced by XMPPUtils::isUnprefTag().

static 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

static 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