com.ebmwebsourcing.easybox.api
Interface XmlObjectNode

All Superinterfaces:

java.lang.Comparable<XmlObjectNode>

All Known Subinterfaces:

AnyXmlObject, XmlObject, XmlObjectAttribute, XmlObjectText

public interface XmlObjectNode
extends java.lang.Comparable<XmlObjectNode>

Convenience interface to be shared between XmlObject XmlObjectText, and XmlObjectAttribute.

Author:

mjambert

Field Summary

static XmlObjectNode[]

EMPTY_ARRAY

Method Summary

java.lang.Object	getUserData() Get user data associated with this object.
XmlObjectNode[]	getXmlObjectAncestors() Get XmlObjectNode ancestors.
java.lang.Integer[]	getXmlObjectBaseIndexes()
XmlObject	getXmlObjectBaseRoot() Get root of this XmlObjectNode base document (the further ancestor which has same base URI).
java.net.URI	getXmlObjectBaseURI() Get base URI of document from where this XmlObjectNode originated.
java.lang.String	getXmlObjectBaseXPath() Get XPath leading to this XmlObjectNode, if executed from base root.
XmlObjectNode[]	getXmlObjectChildren() Get list of all child XmlObjectNode.
XmlObjectNode[]	getXmlObjectDescendants() Get list of all descendants XmlObjectNode.
XmlObjectNode[]	getXmlObjectFollowing() Get followers of this XmlObjectNode.
XmlObjectNode	getXmlObjectFollowingSibling() Get following sibling of this XmlObjectNode.
XmlObjectNode[]	getXmlObjectFollowingSiblings() Get following siblings of this XmlObjectNode.
int	getXmlObjectIndex() Get index of this XmlObjectNode.
XmlObject	getXmlObjectParent() Get parent of this XmlObjectNode.
XmlObjectNode[]	getXmlObjectPreceding() Get preceding XmlObjectNode of this XmlObjectNode.
XmlObjectNode[]	getXmlObjectPrecedingOrAncestor() Get preceding or ancestor XmlObjectNode of this XmlObjectNode.
XmlObjectNode	getXmlObjectPrecedingSibling() Get preceding sibling of this XmlObjectNode.
XmlObjectNode[]	getXmlObjectPrecedingSiblings() Get preceding siblings of this XmlObjectNode.
javax.xml.namespace.QName	getXmlObjectQName() Get qualified name of XML node corresponding to this XmlObjectNode.
XmlObject	getXmlObjectRoot() Get root parent of this XmlObjectNode hierarchy.
java.lang.String	getXmlObjectTextContent() Get text content.
java.lang.Object	getXmlObjectValue()
boolean	hasUserData() Whether or not user data is set on this object.
void	setUserData(java.lang.Object userData) Associates user data with this object.

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

EMPTY_ARRAY

static final XmlObjectNode[] EMPTY_ARRAY

Method Detail

getXmlObjectParent

XmlObject getXmlObjectParent()

Get parent of this XmlObjectNode.

Returns:

This XmlObject or null if none.

getXmlObjectChildren

XmlObjectNode[] getXmlObjectChildren()

Get list of all child XmlObjectNode.

Returns:

Properly ordered list of all children objects.

getXmlObjectTextContent

java.lang.String getXmlObjectTextContent()

Get text content.

Returns:

Text content of this XmlObjectNode or null if none.

getXmlObjectValue

java.lang.Object getXmlObjectValue()

getXmlObjectQName

javax.xml.namespace.QName getXmlObjectQName()

Get qualified name of XML node corresponding to this XmlObjectNode.

Returns:

QName of this XmlObjectNode or null if not known, or not applicable.

getXmlObjectBaseXPath

java.lang.String getXmlObjectBaseXPath()

Get XPath leading to this XmlObjectNode, if executed from base root.

Returns:

XPath leading to this XmlObjectNode.

getXmlObjectBaseIndexes

java.lang.Integer[] getXmlObjectBaseIndexes()

getXmlObjectIndex

int getXmlObjectIndex()

Get index of this XmlObjectNode.

Returns:

Position (starting from 0) of this XmlObjectNode in its parent children list.

getXmlObjectFollowingSibling

XmlObjectNode getXmlObjectFollowingSibling()

Get following sibling of this XmlObjectNode.

Returns:

Following sibling of this XmlObjectNode, or null if none.

getXmlObjectPrecedingSibling

XmlObjectNode getXmlObjectPrecedingSibling()

Get preceding sibling of this XmlObjectNode.

Returns:

Preceding sibling of this XmlObjectNode, or null if none.

getXmlObjectAncestors

XmlObjectNode[] getXmlObjectAncestors()

Get XmlObjectNode ancestors.

Returns:

Array of XmlObjectNode containing all ancestors of this object.

getXmlObjectFollowing

XmlObjectNode[] getXmlObjectFollowing()

Get followers of this XmlObjectNode.

Returns:

Followers of this XmlObjectNode.

getXmlObjectFollowingSiblings

XmlObjectNode[] getXmlObjectFollowingSiblings()

Get following siblings of this XmlObjectNode.

Returns:

Following siblings of this XmlObjectNode.

getXmlObjectPrecedingSiblings

XmlObjectNode[] getXmlObjectPrecedingSiblings()

Get preceding siblings of this XmlObjectNode.

Returns:

Preceding siblings of this XmlObjectNode.

getXmlObjectPreceding

XmlObjectNode[] getXmlObjectPreceding()

Get preceding XmlObjectNode of this XmlObjectNode.

Returns:

Preceding XmlObjectNode of this XmlObjectNode.

getXmlObjectPrecedingOrAncestor

XmlObjectNode[] getXmlObjectPrecedingOrAncestor()

Get preceding or ancestor XmlObjectNode of this XmlObjectNode.

Returns:

Preceding or ancestor XmlObjectNode of this XmlObjectNode.

getXmlObjectRoot

XmlObject getXmlObjectRoot()

Get root parent of this XmlObjectNode hierarchy.

Returns:

Root parent of this XmlObjectNode.

getXmlObjectDescendants

XmlObjectNode[] getXmlObjectDescendants()

Get list of all descendants XmlObjectNode.

Returns:

Properly ordered list of all descendant objects.

getXmlObjectBaseURI

java.net.URI getXmlObjectBaseURI()

Get base URI of document from where this XmlObjectNode originated.

Returns:

Base URI of originating document, if known, null otherwise.

getXmlObjectBaseRoot

XmlObject getXmlObjectBaseRoot()

Get root of this XmlObjectNode base document (the further ancestor which has same base URI).

Returns:

Root of this XmlObjectNode base document.

hasUserData

boolean hasUserData()

Whether or not user data is set on this object.

Returns:

true if user data is not null, false otherwise.

getUserData

java.lang.Object getUserData()

Get user data associated with this object.

Returns:

User data associated with this object.

setUserData

void setUserData(java.lang.Object userData)

Associates user data with this object. Anyone is free to store any object which might be convenient on client side.

Parameters:

userData - User data to associate.