Class AbstractAttribute
- java.lang.Object
 - 
- org.dom4j.tree.AbstractNode
 - 
- org.dom4j.tree.AbstractAttribute
 
 
 
- 
- All Implemented Interfaces:
 Serializable,Cloneable,Attribute,Node
- Direct Known Subclasses:
 BeanAttribute,DatatypeAttribute,FlyweightAttribute
public abstract class AbstractAttribute extends AbstractNode implements Attribute
AbstractNamespaceis an abstract base class for tree implementors to use for implementation inheritence.- See Also:
 - Serialized Form
 
 
- 
- 
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
Constructors Constructor Description AbstractAttribute() 
- 
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(Visitor visitor)acceptis the method used in the Visitor Pattern.StringasXML()asXMLreturns the textual XML representation of this node.protected NodecreateXPathResult(Element parent)ObjectgetData()Accesses the data of this attribute which may implement data typing bindings such asXML SchemaorJava Beanbindings or will return the same value asNode.getText().StringgetName()getNamereturns the name of this node.NamespacegetNamespace()Returns theNamespaceof this element if one exists otherwise null is returned returned.StringgetNamespacePrefix()Returns the namespace prefix of this element if one exists otherwise an emptyStringis returned.StringgetNamespaceURI()Returns the URI mapped to the namespace of this element if one exists otherwise an emptyStringis returned.shortgetNodeType()Returns the code according to the type of node.StringgetPath(Element context)Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c.StringgetQualifiedName()Returns the fully qualified name of this element.StringgetText()Returns the text of this node.StringgetUniquePath(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.voidsetData(Object data)Sets the data value of this attribute if this element supports data binding or callsNode.setText(String)if it doesn't.voidsetNamespace(Namespace namespace)Sets theNamespaceof this element or if this element is read only then anUnsupportedOperationExceptionis thrown.voidsetText(String text)Sets the text data of this node or this method will throw anUnsupportedOperationExceptionif it is read-only.voidsetValue(String value)Sets the value of this attribute or this method will throw anUnsupportedOperationExceptionif it is read-only.StringtoString()voidwrite(Writer writer)writewrites 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.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 
 - 
 
 - 
 
- 
- 
Method Detail
- 
getNodeType
public short getNodeType()
Description copied from interface:NodeReturns the code according to the type of node. This makes processing nodes polymorphically much easier as the switch statement can be used instead of multiple if (instanceof) statements.- Specified by:
 getNodeTypein interfaceNode- Overrides:
 getNodeTypein classAbstractNode- Returns:
 - a W3C DOM complient code for the node type such as ELEMENT_NODE or ATTRIBUTE_NODE
 
 
- 
setNamespace
public void setNamespace(Namespace namespace)
Description copied from interface:AttributeSets theNamespaceof this element or if this element is read only then anUnsupportedOperationExceptionis thrown.- Specified by:
 setNamespacein interfaceAttribute- Parameters:
 namespace- is theNamespaceto associate with this element
 
- 
getText
public String getText()
Description copied from interface:NodeReturns the text of this node.
- Specified by:
 getTextin interfaceNode- Overrides:
 getTextin classAbstractNode- Returns:
 - the text for this node.
 
 
- 
setText
public void setText(String text)
Description copied from interface:NodeSets the text data of this node or this method will throw an
UnsupportedOperationExceptionif it is read-only.- Specified by:
 setTextin interfaceNode- Overrides:
 setTextin classAbstractNode- Parameters:
 text- is the new textual value of this node
 
- 
setValue
public void setValue(String value)
Description copied from interface:AttributeSets the value of this attribute or this method will throw anUnsupportedOperationExceptionif it is read-only. 
- 
getData
public Object getData()
Description copied from interface:AttributeAccesses the data of this attribute which may implement data typing bindings such asXML SchemaorJava Beanbindings or will return the same value asNode.getText(). 
- 
setData
public void setData(Object data)
Description copied from interface:AttributeSets the data value of this attribute if this element supports data binding or callsNode.setText(String)if it doesn't. 
- 
asXML
public String asXML()
Description copied from interface:NodeasXMLreturns the textual XML representation of this node. 
- 
write
public void write(Writer writer) throws IOException
Description copied from interface:Nodewritewrites 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 useXMLWriteror its derivations.- Specified by:
 writein interfaceNode- Overrides:
 writein classAbstractNode- Parameters:
 writer- is theWriterto output the XML to- Throws:
 IOException- DOCUMENT ME!
 
- 
accept
public void accept(Visitor visitor)
Description copied from interface:Nodeacceptis the method used in the Visitor Pattern. 
- 
getNamespace
public Namespace getNamespace()
Description copied from interface:AttributeReturns theNamespaceof this element if one exists otherwise null is returned returned.- Specified by:
 getNamespacein interfaceAttribute- Returns:
 - the 
Namespaceassociated with this node 
 
- 
getName
public String getName()
Description copied from interface:NodegetNamereturns 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.- Specified by:
 getNamein interfaceNode- Overrides:
 getNamein classAbstractNode- Returns:
 - the XML name of this node
 
 
- 
getNamespacePrefix
public String getNamespacePrefix()
Description copied from interface:AttributeReturns the namespace prefix of this element if one exists otherwise an emptyStringis returned.- Specified by:
 getNamespacePrefixin interfaceAttribute- Returns:
 - the prefix of the 
Namespaceof this element or an emptyString 
 
- 
getNamespaceURI
public String getNamespaceURI()
Description copied from interface:AttributeReturns the URI mapped to the namespace of this element if one exists otherwise an emptyStringis returned.- Specified by:
 getNamespaceURIin interfaceAttribute- Returns:
 - the URI for the 
Namespaceof this element or an emptyString 
 
- 
getQualifiedName
public String getQualifiedName()
Description copied from interface:AttributeReturns the fully qualified name of this element. This will be the same as the value returned fromNode.getName()if this element has no namespace attached to this element or an expression of the formgetNamespacePrefix() + ":" + getName()
will be returned.- Specified by:
 getQualifiedNamein interfaceAttribute- Returns:
 - the fully qualified name of the element
 
 
- 
getPath
public String getPath(Element context)
Description copied from interface:NodeReturns the relative XPath expression which will return a node set containing the given node such as a/b/@c. No indexing will be used to restrict the path if multiple elements with the same name occur on the path.- Specified by:
 getPathin interfaceNode- Parameters:
 context- 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.- Returns:
 - the XPath expression relative to the given context which will return a nodeset containing at least this node.
 
 
- 
getUniquePath
public String getUniquePath(Element context)
Description copied from interface: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.
- Specified by:
 getUniquePathin interfaceNode- Parameters:
 context- 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.- Returns:
 - the XPath expression relative to the given context which will return a nodeset containing just this node.
 
 
- 
createXPathResult
protected Node createXPathResult(Element parent)
- Overrides:
 createXPathResultin classAbstractNode
 
 - 
 
 -