org.expath.tools.model

Interface Element

All Known Implementing Classes:

DomElement

public interface Element

An abstract representation of an element (just provide the HTTP Client needs).

Author:

Florent Georges

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.

Method Detail

getLocalName

java.lang.String getLocalName()

Get the local part of the name of the element.

Returns:

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

getNamespaceUri

java.lang.String getNamespaceUri()

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

Returns:

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

getDisplayName

java.lang.String getDisplayName()

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.

Returns:

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

getAttribute

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

Return the value of an attribute.

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

java.lang.Iterable<Attribute> attributes()

Iterate through the attributes.

Returns:

The iterator.

hasNoNsChild

boolean hasNoNsChild()

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

Returns:

true if there is any child in no namespace.

children

java.lang.Iterable<Element> children()

Iterate through the children elements.

Returns:

The iterator.

children

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

Iterate through the children elements in a specific namespace.

Parameters:

ns - The namespace to use.

Returns:

The iterator.

noOtherNCNameAttribute

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

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.

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

Sequence getContent()
             throws ToolsException

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

Returns:

The sequence.

Throws:

ToolsException - if an error occurs whilst retrieving the content

parseQName

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

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

Parameters:

value - The literal QName to parse.

Returns:

The parsed QName.

Throws:

ToolsException - if an error occurs whilst parsing the QName