org.dom4j.datatype

Class DatatypeAttribute

Implemented Interfaces:
Cloneable, Serializable, SerializationContext, ValidationContext, Attribute, Node

public class DatatypeAttribute
extends org.dom4j.tree.AbstractAttribute
implements SerializationContext, ValidationContext

DatatypeAttribute represents an Attribute which supports the XML Schema Data Types specification.
Version:
$Revision: 1.9 $
Author:
James Strachan

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

DatatypeAttribute(QName qname, XSDatatype datatype)
DatatypeAttribute(QName qname, XSDatatype datatype, String text)

Method Summary

protected Object
convertToValue(String txt)
String
getBaseUri()
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
getNamespacePrefix(String uri)
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 attribute which represents the local name, the qualified name and the Namespace.
String
getValue()
Returns the value of the attribute.
XSDatatype
getXSDatatype()
Returns the MSV XSDatatype for this node
boolean
isNotation(String notationName)
boolean
isReadOnly()
isReadOnly returns true if this node is read only and cannot be modified.
boolean
isUnparsedEntity(String entityName)
String
resolveNamespacePrefix(String prefix)
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
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
setValue(String value)
Sets the value of this attribute or this method will throw an UnsupportedOperationException if it is read-only.
boolean
supportsParent()
supportsParent returns true if this node supports the parent relationship.
String
toString()
protected void
validate(String txt)

Methods inherited from class org.dom4j.tree.AbstractAttribute

accept, asXML, createXPathResult, getData, getName, getNamespace, getNamespacePrefix, getNamespaceURI, getNodeType, getPath, getQualifiedName, getText, getUniquePath, setData, setNamespace, setText, setValue, toString, write

Methods inherited from class org.dom4j.tree.AbstractNode

asXPathResult, clone, createPattern, createXPath, createXPathFilter, createXPathResult, detach, getDocument, getDocumentFactory, getName, getNodeType, getNodeTypeName, getParent, getPath, getStringValue, getText, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, valueOf, write

Constructor Details

DatatypeAttribute

public DatatypeAttribute(QName qname,
                         XSDatatype datatype)

DatatypeAttribute

public DatatypeAttribute(QName qname,
                         XSDatatype datatype,
                         String text)

Method Details

convertToValue

protected Object convertToValue(String txt)

getBaseUri

public String getBaseUri()

getData

public Object getData()
Specified by:
getData in interface Attribute
Overrides:
getData in interface org.dom4j.tree.AbstractAttribute
Returns:
the attribute data

getNamespacePrefix

public String getNamespacePrefix(String uri)

getParent

public 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.

This method is an optional feature and may not be supported for all Node implementations.

Specified by:
getParent in interface Node
Overrides:
getParent in interface org.dom4j.tree.AbstractNode
Returns:
the parent of this node or null if it is the root of the tree or the parent relationship is not supported.

getQName

public QName getQName()
Returns the QName of this attribute which represents the local name, the qualified name and the Namespace.
Specified by:
getQName in interface Attribute
Returns:
the QName associated with this attribute

getValue

public String getValue()
Specified by:
getValue in interface Attribute
Returns:
the value of the attribute

getXSDatatype

public XSDatatype getXSDatatype()
Returns the MSV XSDatatype for this node
Returns:
DOCUMENT ME!

isNotation

public boolean isNotation(String notationName)

isReadOnly

public boolean isReadOnly()
isReadOnly returns true if this node is read only and cannot be modified. Any attempt to modify a read-only Node will result in an UnsupportedOperationException being thrown.
Specified by:
isReadOnly in interface Node
Overrides:
isReadOnly in interface org.dom4j.tree.AbstractNode
Returns:
true if this Node is read only and cannot be modified otherwise false.

isUnparsedEntity

public boolean isUnparsedEntity(String entityName)

resolveNamespacePrefix

public String resolveNamespacePrefix(String prefix)

setData

public void setData(Object data)
Specified by:
setData in interface Attribute
Overrides:
setData in interface org.dom4j.tree.AbstractAttribute
Parameters:
data - the attribute data

setParent

public 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.

This method should only be called from inside an Element implementation method and is not intended for general use.

Specified by:
setParent in interface Node
Overrides:
setParent in interface org.dom4j.tree.AbstractNode
Parameters:
parent - is the new parent of this node.

setValue

public void setValue(String value)
Sets the value of this attribute or this method will throw an UnsupportedOperationException if it is read-only.
Specified by:
setValue in interface Attribute
Overrides:
setValue in interface org.dom4j.tree.AbstractAttribute
Parameters:
value - is the new value of this attribute

supportsParent

public boolean supportsParent()
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.

Specified by:
supportsParent in interface Node
Overrides:
supportsParent in interface org.dom4j.tree.AbstractNode
Returns:
true if this node supports the parent relationship or false it is not supported

toString

public String toString()
Overrides:
toString in interface org.dom4j.tree.AbstractAttribute

validate

protected void validate(String txt)
            throws IllegalArgumentException

Copyright B) 2005 MetaStuff Ltd. All Rights Reserved. Hosted by

SourceForge Logo