org.expath.tools.model.dom

Class DomElement

java.lang.Object

org.expath.tools.model.dom.DomElement

All Implemented Interfaces:

Element

public class DomElement
extends java.lang.Object
implements Element

Trivial, in-memory implementation, for test purposes.

Author:

Florent Georges

Constructor Summary

Constructors

Constructor and Description
DomElement(org.w3c.dom.Element elem)

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<Attribute>	attributes() Iterate through the attributes.
java.lang.Iterable<Element>	children() Iterate through the children elements.
java.lang.Iterable<Element>	children(java.lang.String ns) Iterate through the children elements in a specific namespace.
java.lang.String	getAttribute(java.lang.String local_name) Return the value of an attribute.
Sequence	getContent() Return the content of the element (the content of the child:: axis).
java.lang.String	getDisplayName() Get the display name of the element.
java.lang.String	getLocalName() Get the local part of the name of the element.
java.lang.String	getNamespaceUri() Return the namespace URI part of the name of the element.
boolean	hasNoNsChild() Return true if this element has at least one child in no namespace.
void	noOtherNCNameAttribute(java.lang.String[] names, java.lang.String[] forbidden_ns) Check the element elem does not have attributes other than names.
javax.xml.namespace.QName	parseQName(java.lang.String value) Parse a literal QName using the namespace bindings in scope on the element.
static Element	parseString(java.lang.String xml)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DomElement

public DomElement(org.w3c.dom.Element elem)

Method Detail

parseString

public static Element parseString(java.lang.String xml)
                           throws ToolsException

Throws:

ToolsException

getLocalName

public java.lang.String getLocalName()

Description copied from interface: Element

Get the local part of the name of the element.

Specified by:

getLocalName in interface Element

Returns:

The local part of the name of the element, cannot be null nor empty.

getNamespaceUri

public java.lang.String getNamespaceUri()

Description copied from interface: Element

Return the namespace URI part of the name of the element.

Specified by:

getNamespaceUri in interface Element

Returns:

The empty string if the name is in no namespace (never return null).

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: Element

Get the display name of the element. The display name is the original lexical name (with the original prefix if any). An implementation is not required to return the exact same name as the original, and can instead make a "best guess". This is for reporting purpose only.

Specified by:

getDisplayName in interface Element

Returns:

The display name of the element, cannot be null nor empty.

getAttribute

public java.lang.String getAttribute(java.lang.String local_name)

Description copied from interface: Element

Return the value of an attribute.

Specified by:

getAttribute in interface Element

Parameters:

local_name - The local name of the attribute to look for. The attribute is looked for in no namespace.

Returns:

The value of the attribute, or null if it does not exist.

attributes

public java.lang.Iterable<Attribute> attributes()

Description copied from interface: Element

Iterate through the attributes.

Specified by:

attributes in interface Element

Returns:

The iterator.

hasNoNsChild

public boolean hasNoNsChild()

Description copied from interface: Element

Return true if this element has at least one child in no namespace.

Specified by:

hasNoNsChild in interface Element

Returns:

true if there is any child in no namespace.

children

public java.lang.Iterable<Element> children()

Description copied from interface: Element

Iterate through the children elements.

Specified by:

children in interface Element

Returns:

The iterator.

children

public java.lang.Iterable<Element> children(java.lang.String ns)

Description copied from interface: Element

Iterate through the children elements in a specific namespace.

Specified by:

children in interface Element

Parameters:

ns - The namespace to use.

Returns:

The iterator.

noOtherNCNameAttribute

public void noOtherNCNameAttribute(java.lang.String[] names,
                                   java.lang.String[] forbidden_ns)
                            throws ToolsException

Description copied from interface: Element

Check the element elem does not have attributes other than names. names contains non-qualified names, for allowed attributes. The element can have other attributes in other namespace (not in the forbidden namespaces) but no attributes in no namespace.

Specified by:

noOtherNCNameAttribute in interface Element

Parameters:

names - The non-qualified names of allowed attributes (cannot be null, but can be empty.)

forbidden_ns - The forbidden namespaces, no attribute can be in any of those namespaces.

Throws:

ToolsException - If the element contains an attribute in any of the forbidden namespaces, or in no namespace and the name of which is not in names.

getContent

public Sequence getContent()

Description copied from interface: Element

Return the content of the element (the content of the child:: axis).

Specified by:

getContent in interface Element

Returns:

The sequence.

parseQName

public javax.xml.namespace.QName parseQName(java.lang.String value)
                                     throws ToolsException

Description copied from interface: Element

Parse a literal QName using the namespace bindings in scope on the element.

Specified by:

parseQName in interface Element

Parameters:

value - The literal QName to parse.

Returns:

The parsed QName.

Throws:

ToolsException