|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.dom4j.tree.AbstractNode
org.dom4j.tree.AbstractBranch
org.dom4j.tree.AbstractElement
org.dom4j.tree.DefaultElement
DefaultElement
is the default DOM4J default implementation
of an XML element.
Field Summary |
Fields inherited from class org.dom4j.tree.AbstractElement |
EMPTY_ITERATOR, EMPTY_LIST, USE_STRINGVALUE_SEPARATOR, VERBOSE_TOSTRING |
Fields inherited from class org.dom4j.tree.AbstractBranch |
DEFAULT_CONTENT_LIST_SIZE, outputFormat |
Fields inherited from class org.dom4j.tree.AbstractNode |
NODE_TYPE_NAMES |
Fields inherited from interface org.dom4j.Node |
ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE |
Constructor Summary | |
DefaultElement(QName qname)
|
|
DefaultElement(QName qname,
int attributeCount)
|
|
DefaultElement(java.lang.String name)
|
|
DefaultElement(java.lang.String name,
Namespace namespace)
|
Method Summary | |
void |
add(Attribute attribute)
Adds the given Attribute to this element. |
java.util.List |
additionalNamespaces()
Returns any additional namespaces declarations for this element other than namespace returned via the AbstractElement.getNamespace() method. |
java.util.List |
additionalNamespaces(java.lang.String defaultNamespaceURI)
|
protected void |
addNewNode(Node node)
Like addNode() but does not require a parent check |
Attribute |
attribute(int index)
Returns the attribute at the specified indexGets the |
Attribute |
attribute(QName qName)
|
Attribute |
attribute(java.lang.String name)
Returns the attribute with the given name |
Attribute |
attribute(java.lang.String name,
Namespace namespace)
|
int |
attributeCount()
|
java.util.Iterator |
attributeIterator()
|
protected java.util.List |
attributeList()
|
protected java.util.List |
attributeList(int size)
|
java.util.List |
attributes()
Returns the Attribute instances this element contains as
a backed List so that the attributes may be modified directly
using the List interface. |
void |
clearContent()
Clears the content for this branch, removing any Node
instances this branch may contain. |
java.lang.Object |
clone()
clone will return a deep clone or if this node is
read-only then clone will return the same instance. |
protected java.util.List |
contentList()
|
java.util.List |
declaredNamespaces()
Returns all the namespaces declared by this element. |
Element |
element(QName qName)
Returns the first element for the given fully qualified name. |
Element |
element(java.lang.String name)
Returns the first element for the given local name and any namespace. |
Element |
element(java.lang.String name,
Namespace namespace)
|
java.util.Iterator |
elementIterator()
Returns an iterator over all this elements child elements. |
java.util.Iterator |
elementIterator(QName qName)
Returns an iterator over the elements contained in this element which match the given fully qualified name. |
java.util.Iterator |
elementIterator(java.lang.String name)
Returns an iterator over the elements contained in this element which match the given local name and any namespace. |
java.util.Iterator |
elementIterator(java.lang.String name,
Namespace namespace)
|
java.util.List |
elements()
Returns the elements contained in this element. |
java.util.List |
elements(QName qName)
Returns the elements contained in this element with the given fully qualified name. |
java.util.List |
elements(java.lang.String name)
Returns the elements contained in this element with the given local name and any namespace. |
java.util.List |
elements(java.lang.String name,
Namespace namespace)
|
Document |
getDocument()
getDocument returns the Document
that this Node is part of if this node supports
the parent relationship. |
protected DocumentFactory |
getDocumentFactory()
|
Namespace |
getNamespaceForPrefix(java.lang.String prefix)
Returns the Namespace which is mapped to the given
prefix or null if it could not be found. |
Namespace |
getNamespaceForURI(java.lang.String uri)
Returns the Namespace which is mapped to the given
URI or null if it could not be found. |
Element |
getParent()
getParent returns the parent Element
if this node supports the parent relationship or null if it is
the root element or does not support the parent relationship. |
QName |
getQName()
Returns the QName of this element which represents
the local name, the qualified name and the Namespace . |
java.lang.String |
getStringValue()
Returns the XPath string-value of this node. |
java.lang.String |
getText()
Returns the text value of this element without recursing through child elements. |
int |
indexOf(Node node)
Returns the index of the given node if it is a child node of this branch or -1 if the given node is not a child node. |
Node |
node(int index)
Returns the Node at the specified index position. |
int |
nodeCount()
Returns the number of Node instances that this branch
contains. |
java.util.Iterator |
nodeIterator()
Returns an iterator through the content nodes of this branch |
ProcessingInstruction |
processingInstruction(java.lang.String target)
|
java.util.List |
processingInstructions()
Returns a list of all the processing instructions in this branch. |
java.util.List |
processingInstructions(java.lang.String target)
Returns a list of the processing instructions for the given target. |
boolean |
remove(Attribute attribute)
Removes the given Attribute from this element. |
protected boolean |
removeNode(Node node)
|
boolean |
removeProcessingInstruction(java.lang.String target)
Removes the processing instruction for the given target if it exists |
protected void |
setAttributeList(java.util.List attributes)
|
void |
setAttributes(java.util.List attributes)
Sets the attributes that this element contains |
void |
setContent(java.util.List content)
Sets the contents of this branch as a List of
Node instances. |
void |
setDocument(Document document)
setDocument sets the document of this node if the
parent relationship is supported or does nothing if the parent
relationship is not supported. |
void |
setParent(Element parent)
setParent sets the parent relationship of
this node if the parent relationship is supported or does nothing
if the parent relationship is not supported. |
void |
setQName(QName qname)
Sets the QName of this element which represents
the local name, the qualified name and the Namespace . |
boolean |
supportsParent()
supportsParent returns true if this node supports the
parent relationship. |
Methods inherited from class org.dom4j.tree.AbstractBranch |
addElement, addElement, addElement, appendContent, content, contentRemoved, createContentList, createContentList, createEmptyList, createResultList, createSingleResultList, elementByID, elementID, getContentAsStringValue, getContentAsText, getTextTrim, hasContent, invalidNodeTypeAddException, isReadOnly, setProcessingInstructions |
Methods inherited from class org.dom4j.tree.AbstractNode |
asXPathResult, createPattern, createXPath, createXPathFilter, createXPathResult, detach, getNodeTypeName, getPath, getUniquePath, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, valueOf |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.dom4j.Element |
getTextTrim |
Methods inherited from interface org.dom4j.Branch |
addElement, addElement, appendContent, content, elementByID, setProcessingInstructions |
Methods inherited from interface org.dom4j.Node |
asXPathResult, createXPath, detach, getNodeTypeName, getPath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, valueOf |
Constructor Detail |
public DefaultElement(java.lang.String name)
public DefaultElement(QName qname)
public DefaultElement(QName qname, int attributeCount)
public DefaultElement(java.lang.String name, Namespace namespace)
Method Detail |
public Element getParent()
Node
getParent
returns the parent Element
if this node supports the parent relationship or null if it is
the root element or does not support the parent relationship.
This method is an optional feature and may not be supported
for all Node
implementations.
getParent
in interface Node
getParent
in class AbstractNode
public void setParent(Element parent)
Node
setParent
sets the parent relationship of
this node if the parent relationship is supported or does nothing
if the parent relationship is not supported.
This method should only be called from inside an
Element
implementation method and is not intended for
general use.
setParent
in interface Node
setParent
in class AbstractNode
public Document getDocument()
Node
getDocument
returns the Document
that this Node
is part of if this node supports
the parent relationship.
This method is an optional feature and may not be supported
for all Node
implementations.
getDocument
in interface Node
getDocument
in class AbstractNode
public void setDocument(Document document)
Node
setDocument
sets the document of this node if the
parent relationship is supported or does nothing if the parent
relationship is not supported.
This method should only be called from inside a
Document
implementation method and is not intended for
general use.
setDocument
in interface Node
setDocument
in class AbstractNode
public boolean supportsParent()
Node
supportsParent
returns true if this node supports the
parent relationship.
Some XML tree implementations are singly linked and only support downward navigation through children relationships. The default case is that both parent and children relationships are supported though for memory and performance reasons the parent relationship may not be supported.
supportsParent
in interface Node
supportsParent
in class AbstractNode
public QName getQName()
Element
Returns the QName
of this element which represents
the local name, the qualified name and the Namespace
.
QName
associated with this elementpublic void setQName(QName qname)
Element
Sets the QName
of this element which represents
the local name, the qualified name and the Namespace
.
qname
- is the QName
to be associated with this elementpublic java.lang.String getText()
Element
Text
, CDATA
and
Entity
nodes that this element contains
and appends the text values together.
getText
in interface Element
getText
in class AbstractBranch
public java.lang.String getStringValue()
Element
Text
, CDATA
, Entity
and Element
nodes
all appended together.
getStringValue
in interface Element
getStringValue
in class AbstractElement
public java.lang.Object clone()
Node
clone
will return a deep clone or if this node is
read-only then clone will return the same instance.
clone
in interface Node
clone
in class AbstractNode
public Namespace getNamespaceForPrefix(java.lang.String prefix)
Element
Returns the Namespace
which is mapped to the given
prefix or null if it could not be found.
getNamespaceForPrefix
in interface Element
getNamespaceForPrefix
in class AbstractElement
public Namespace getNamespaceForURI(java.lang.String uri)
Element
Returns the Namespace
which is mapped to the given
URI or null if it could not be found.
getNamespaceForURI
in interface Element
getNamespaceForURI
in class AbstractElement
public java.util.List declaredNamespaces()
Element
Returns all the namespaces declared by this element. If no namespaces are declared for this element then an empty list will be returned. The list is backed by the element such that changes to the list will be reflected in the element though the reverse is not the case.
declaredNamespaces
in interface Element
declaredNamespaces
in class AbstractElement
public java.util.List additionalNamespaces()
Element
Returns any additional namespaces declarations for this element
other than namespace returned via the Element.getNamespace()
method.
If no additional namespace declarations are present for this
element then an empty list will be returned.
The list is backed by the element such that changes to the list will
be reflected in the element though the reverse is not the case.
additionalNamespaces
in interface Element
additionalNamespaces
in class AbstractElement
public java.util.List additionalNamespaces(java.lang.String defaultNamespaceURI)
additionalNamespaces
in class AbstractElement
public java.util.List processingInstructions()
Branch
Returns a list of all the processing instructions in this branch. The list is backed by this branch so that changes to the list will be reflected in the branch but the reverse is not the case.
processingInstructions
in interface Branch
processingInstructions
in class AbstractElement
public java.util.List processingInstructions(java.lang.String target)
Branch
Returns a list of the processing instructions for the given target. The list is backed by this branch so that changes to the list will be reflected in the branch but the reverse is not the case.
processingInstructions
in interface Branch
processingInstructions
in class AbstractElement
public ProcessingInstruction processingInstruction(java.lang.String target)
processingInstruction
in interface Branch
processingInstruction
in class AbstractElement
public boolean removeProcessingInstruction(java.lang.String target)
Branch
removeProcessingInstruction
in interface Branch
removeProcessingInstruction
in class AbstractElement
public Element element(java.lang.String name)
Element
element
in interface Element
element
in class AbstractElement
public Element element(QName qName)
Element
element
in interface Element
element
in class AbstractElement
public Element element(java.lang.String name, Namespace namespace)
element
in class AbstractElement
public java.util.List elements()
Element
Returns the elements contained in this element. If this element does not contain any elements then this method returns an empty list. The list is backed by the element such that changes to the list will be reflected in the element though the reverse is not the case.
elements
in interface Element
elements
in class AbstractElement
public java.util.List elements(java.lang.String name)
Element
Returns the elements contained in this element with the given local name and any namespace. If no elements are found then this method returns an empty list. The list is backed by the element such that changes to the list will be reflected in the element though the reverse is not the case.
elements
in interface Element
elements
in class AbstractElement
public java.util.List elements(QName qName)
Element
Returns the elements contained in this element with the given fully qualified name. If no elements are found then this method returns an empty list. The list is backed by the element such that changes to the list will be reflected in the element though the reverse is not the case.
elements
in interface Element
elements
in class AbstractElement
public java.util.List elements(java.lang.String name, Namespace namespace)
elements
in class AbstractElement
public java.util.Iterator elementIterator()
Element
elementIterator
in interface Element
elementIterator
in class AbstractElement
public java.util.Iterator elementIterator(java.lang.String name)
Element
elementIterator
in interface Element
elementIterator
in class AbstractElement
public java.util.Iterator elementIterator(QName qName)
Element
elementIterator
in interface Element
elementIterator
in class AbstractElement
public java.util.Iterator elementIterator(java.lang.String name, Namespace namespace)
elementIterator
in class AbstractElement
public void setContent(java.util.List content)
Branch
List
of
Node
instances.
content
- is the list of nodes to use as the content for this
branch.public void clearContent()
Branch
Node
instances this branch may contain.
public Node node(int index)
Branch
Node
at the specified index position.
node
in interface Branch
node
in class AbstractElement
public int indexOf(Node node)
Branch
indexOf
in interface Branch
indexOf
in class AbstractElement
public int nodeCount()
Branch
Node
instances that this branch
contains.
nodeCount
in interface Branch
nodeCount
in class AbstractElement
public java.util.Iterator nodeIterator()
Branch
nodeIterator
in interface Branch
nodeIterator
in class AbstractElement
public java.util.List attributes()
Element
Returns the Attribute
instances this element contains as
a backed List
so that the attributes may be modified directly
using the List
interface.
The List
is backed by the Element
so that
changes to the list are reflected in the element and vice versa.
attributes
in interface Element
attributes
in class AbstractElement
public void setAttributes(java.util.List attributes)
Element
public java.util.Iterator attributeIterator()
attributeIterator
in interface Element
attributeIterator
in class AbstractElement
public Attribute attribute(int index)
Element
attribute
in interface Element
attribute
in class AbstractElement
public int attributeCount()
attributeCount
in interface Element
attributeCount
in class AbstractElement
public Attribute attribute(java.lang.String name)
Element
attribute
in interface Element
attribute
in class AbstractElement
public Attribute attribute(QName qName)
attribute
in interface Element
attribute
in class AbstractElement
public Attribute attribute(java.lang.String name, Namespace namespace)
attribute
in class AbstractElement
public void add(Attribute attribute)
Element
Attribute
to this element.
If the given node already has a parent defined then an
InvalidAddNodeException
will be thrown.
Attributes with null values are silently ignored.
If the value of the attribute is null then this method call will
remove any attributes with the QName of this attribute.
add
in interface Element
add
in class AbstractElement
public boolean remove(Attribute attribute)
Element
Attribute
from this element.
remove
in interface Element
remove
in class AbstractElement
protected void addNewNode(Node node)
AbstractElement
addNewNode
in class AbstractElement
protected boolean removeNode(Node node)
removeNode
in class AbstractElement
protected java.util.List contentList()
contentList
in class AbstractBranch
protected java.util.List attributeList()
attributeList
in class AbstractElement
protected java.util.List attributeList(int size)
attributeList
in class AbstractElement
protected void setAttributeList(java.util.List attributes)
protected DocumentFactory getDocumentFactory()
getDocumentFactory
in class AbstractElement
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |