|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.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 |
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(String name)
|
|
DefaultElement(String name,
Namespace namespace)
|
Method Summary | |
void |
add(Attribute attribute)
Adds the given Attribute to this element. |
List |
additionalNamespaces()
Returns any additional namespaces declarations for this element other than namespace returned via the AbstractElement.getNamespace() method. |
List |
additionalNamespaces(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)
DOCUMENT ME! |
Attribute |
attribute(String name)
Returns the attribute with the given name |
Attribute |
attribute(String name,
Namespace namespace)
|
int |
attributeCount()
DOCUMENT ME! |
Iterator |
attributeIterator()
DOCUMENT ME! |
protected List |
attributeList()
DOCUMENT ME! |
protected List |
attributeList(int size)
DOCUMENT ME! |
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. |
Object |
clone()
clone will return a deep clone or if this node is
read-only then clone will return the same instance.
|
protected List |
contentList()
DOCUMENT ME! |
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(String name)
Returns the first element for the given local name and any namespace. |
Element |
element(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(String prefix)
Returns the Namespace which is mapped to the given prefix
or null if it could not be found.
|
Namespace |
getNamespaceForURI(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 .
|
String |
getStringValue()
Returns the XPath string-value of this node. |
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. |
Iterator |
nodeIterator()
Returns an iterator through the content nodes of this branch |
ProcessingInstruction |
processingInstruction(String target)
DOCUMENT ME! |
List |
processingInstructions()
Returns a list of all the processing instructions in this branch. |
List |
processingInstructions(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(String target)
Removes the processing instruction for the given target if it exists |
protected void |
setAttributeList(List attributeList)
|
void |
setAttributes(List attributes)
Sets the attributes that this element contains |
void |
setContent(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 name)
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(String name)
public DefaultElement(QName qname)
public DefaultElement(QName qname, int attributeCount)
public DefaultElement(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 name)
Element
Sets the QName
of this element which represents the local
name, the qualified name and the Namespace
.
name
- is the QName
to be associated with this elementpublic 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 String getStringValue()
Element
Text
,CDATA
,Entity
and Element
nodes all appended together.
getStringValue
in interface Element
getStringValue
in class AbstractElement
public 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(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(String uri)
Element
Returns the Namespace
which is mapped to the given URI or
null if it could not be found. If there is more than one
Namespace
mapped to the URI, which of them will be
returned is undetermined.
getNamespaceForURI
in interface Element
getNamespaceForURI
in class AbstractElement
public 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 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 List additionalNamespaces(String defaultNamespaceURI)
additionalNamespaces
in class AbstractElement
public 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 List processingInstructions(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(String target)
Branch
processingInstruction
in interface Branch
processingInstruction
in class AbstractElement
public boolean removeProcessingInstruction(String target)
Branch
removeProcessingInstruction
in interface Branch
removeProcessingInstruction
in class AbstractElement
public Element element(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(String name, Namespace namespace)
element
in class AbstractElement
public void setContent(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 Iterator nodeIterator()
Branch
nodeIterator
in interface Branch
nodeIterator
in class AbstractElement
public 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(List attributes)
Element
attributes
- DOCUMENT ME!public Iterator attributeIterator()
Element
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()
Element
attributeCount
in interface Element
attributeCount
in class AbstractElement
public Attribute attribute(String name)
Element
attribute
in interface Element
attribute
in class AbstractElement
public Attribute attribute(QName qName)
Element
attribute
in interface Element
attribute
in class AbstractElement
public Attribute attribute(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
IllegalAddException
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
node
- DOCUMENT ME!protected boolean removeNode(Node node)
removeNode
in class AbstractElement
protected List contentList()
AbstractBranch
contentList
in class AbstractBranch
protected List attributeList()
AbstractElement
attributeList
in class AbstractElement
protected List attributeList(int size)
AbstractElement
attributeList
in class AbstractElement
size
- DOCUMENT ME!
protected void setAttributeList(List attributeList)
protected DocumentFactory getDocumentFactory()
getDocumentFactory
in class AbstractElement
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |