|
|||||||||||
| 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.AbstractAttribute
AbstractNamespace is an abstract base class for tree
implementors to use for implementation inheritence.
| Field Summary |
| 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 | |
AbstractAttribute()
|
|
| Method Summary | |
void |
accept(Visitor visitor)
accept is the method used in the Visitor Pattern.
|
String |
asXML()
asXML returns the textual XML representation of this node.
|
protected Node |
createXPathResult(Element parent)
|
Object |
getData()
Accesses the data of this attribute which may implement data typing bindings such as XML Schema or Java Bean
bindings or will return the same value as Node.getText().
|
String |
getName()
getName returns the name of this node. |
Namespace |
getNamespace()
Returns the Namespace of this element if one exists
otherwise null is returned returned.
|
String |
getNamespacePrefix()
Returns the namespace prefix of this element if one exists otherwise an empty String is returned.
|
String |
getNamespaceURI()
Returns the URI mapped to the namespace of this element if one exists otherwise an empty String is returned.
|
short |
getNodeType()
Returns the code according to the type of node. |
String |
getPath(Element context)
Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c. |
String |
getQualifiedName()
Returns the fully qualified name of this element. |
String |
getText()
Returns the text of this node. |
String |
getUniquePath(Element context)
Returns the relative unique XPath expression from the given context which will return a nodeset of one node which is the current node. |
void |
setData(Object data)
Sets the data value of this attribute if this element supports data binding or calls Node.setText(String)if it doesn't.
|
void |
setNamespace(Namespace namespace)
Sets the Namespace of this element or if this element is
read only then an UnsupportedOperationException is thrown.
|
void |
setText(String text)
Sets the text data of this node or this method will throw an UnsupportedOperationException if it is read-only.
|
void |
setValue(String value)
Sets the value of this attribute or this method will throw an UnsupportedOperationException if it is read-only.
|
String |
toString()
|
void |
write(Writer writer)
write writes this node as the default XML notation for
this node. |
| Methods inherited from class org.dom4j.tree.AbstractNode |
asXPathResult, clone, createPattern, createXPath, createXPathFilter, detach, getDocument, getDocumentFactory, getNodeTypeName, getParent, getPath, getStringValue, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, supportsParent, valueOf |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.dom4j.Attribute |
getQName, getValue |
| Methods inherited from interface org.dom4j.Node |
asXPathResult, clone, createXPath, detach, getDocument, getNodeTypeName, getParent, getPath, getStringValue, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, supportsParent, valueOf |
| Constructor Detail |
public AbstractAttribute()
| Method Detail |
public short getNodeType()
Node
getNodeType in interface NodegetNodeType in class AbstractNodepublic void setNamespace(Namespace namespace)
Attribute
Sets the Namespace of this element or if this element is
read only then an UnsupportedOperationException is thrown.
setNamespace in interface Attributenamespace - is the Namespace to associate with this elementpublic String getText()
NodeReturns the text of this node.
getText in interface NodegetText in class AbstractNodepublic void setText(String text)
Node
Sets the text data of this node or this method will throw an
UnsupportedOperationException if it is read-only.
setText in interface NodesetText in class AbstractNodepublic void setValue(String value)
Attribute
Sets the value of this attribute or this method will throw an
UnsupportedOperationException if it is read-only.
setValue in interface Attributevalue - is the new value of this attributepublic Object getData()
Attribute
Accesses the data of this attribute which may implement data typing
bindings such as XML Schema or Java Bean
bindings or will return the same value as Node.getText().
getData in interface Attributepublic void setData(Object data)
Attribute
Sets the data value of this attribute if this element supports data
binding or calls Node.setText(String)if it doesn't.
setData in interface Attributedata - the attribute datapublic String toString()
public String asXML()
Node
asXML returns the textual XML representation of this node.
asXML in interface Node
public void write(Writer writer)
throws IOException
Node
write writes this node as the default XML notation for
this node. If you wish to control the XML output (such as for pretty
printing, changing the indentation policy etc.) then please use XMLWriter or its derivations.
write in interface Nodewrite in class AbstractNodeIOExceptionpublic void accept(Visitor visitor)
Node
accept is the method used in the Visitor Pattern.
accept in interface Nodevisitor - is the visitor in the Visitor Patternpublic Namespace getNamespace()
Attribute
Returns the Namespace of this element if one exists
otherwise null is returned returned.
getNamespace in interface AttributeNamespace associated with this nodepublic String getName()
Node
getName returns the name of this node. This is the XML
local name of the element, attribute, entity or processing instruction.
For CDATA and Text nodes this method will return null.
getName in interface NodegetName in class AbstractNodepublic String getNamespacePrefix()
Attribute
Returns the namespace prefix of this element if one exists otherwise an
empty String is returned.
getNamespacePrefix in interface AttributeNamespace of this element or an
empty Stringpublic String getNamespaceURI()
Attribute
Returns the URI mapped to the namespace of this element if one exists
otherwise an empty String is returned.
getNamespaceURI in interface AttributeNamespace of this element or an
empty Stringpublic String getQualifiedName()
AttributeReturns the fully qualified name of this element.
This will be the same as the value returned from Node.getName()
if this element has no namespace attached to this element or an
expression of the form
getNamespacePrefix() + ":" + getName()will be returned.
getQualifiedName in interface Attributepublic String getPath(Element context)
Node
getPath in interface Nodecontext - is the parent context from which the relative path should
start. If the context is null or the context is not an
ancestor of this node then the path will be absolute and start
from the document and so begin with the '/' character.
public String getUniquePath(Element context)
NodeReturns the relative unique XPath expression from the given context which will return a nodeset of one node which is the current node. This method will use the XPath index operator to restrict the path if multiple elements with the same name occur on the path.
getUniquePath in interface Nodecontext - is the parent context from which the path should start. If the
context is null or the context is not an ancestor of this node
then the path will start from the document and so begin with
the '/' character.
protected Node createXPathResult(Element parent)
createXPathResult in class AbstractNode
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||