org.apache.axiom.om.impl.dom

Class AttrImpl

java.lang.Object

org.apache.axiom.om.impl.dom.NodeImpl

org.apache.axiom.om.impl.dom.ParentNode

org.apache.axiom.om.impl.dom.RootNode

org.apache.axiom.om.impl.dom.AttrImpl

All Implemented Interfaces:

IParentNode, OMAttribute, OMInformationItem, OMNamedInformationItem, Attr, Node, NodeList

public class AttrImpl
extends RootNode
implements OMAttribute, Attr

Implementation of org.w3c.dom.Attr and org.apache.axiom.om.OMAttribute

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isId Flag used to mark an attribute as per the DOM Level 3 specification

Fields inherited from class org.apache.axiom.om.impl.dom.ParentNode

firstChild, lastChild

Fields inherited from class org.apache.axiom.om.impl.dom.NodeImpl

factory, FIRSTCHILD, flags, HAS_PARENT, SPECIFIED

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface org.apache.axiom.om.impl.common.IParentNode

COMPLETE, DISCARDED, INCOMPLETE

Constructor Summary

Constructors

Constructor and Description
AttrImpl(DocumentImpl ownerDocument, String name, OMFactory factory)
AttrImpl(DocumentImpl ownerDocument, String localName, OMNamespace namespace, OMFactory factory)
AttrImpl(DocumentImpl ownerDocument, String localName, OMNamespace ns, String value, OMFactory factory)
AttrImpl(DocumentImpl ownerDocument, String name, String value, OMFactory factory)

Method Summary

Modifier and Type	Method and Description
void	build()
boolean	equals(Object obj) An instance of AttrImpl can act as an OMAttribute and as well as an org.w3c.dom.Attr.
String	getAttributeType() Get the attribute type.
String	getAttributeValue() Get the attribute value.
OMXMLParserWrapper	getBuilder()
String	getLocalName() Get the local name of the information item.
String	getName()
OMNamespace	getNamespace() Returns the namespace of the attribute as an OMNamespace.
String	getNamespaceURI() Returns the namespace URI of this attr node.
Node	getNextSibling()
String	getNodeName() Returns the name of this attribute.
short	getNodeType() Returns the node type.
String	getNodeValue() Returns the value of this attribute.
OMElement	getOwner() Returns the owner element of this attribute
Element	getOwnerElement() Returns the owner element.
Node	getParentNode()
String	getPrefix() Returns the namespace prefix of this attr node.
QName	getQName() Returns a qname representing the attribute.
TypeInfo	getSchemaTypeInfo()
boolean	getSpecified()
int	getState()
String	getValue() Returns the value of this attribute.
int	hashCode()
void	internalSerialize(XMLStreamWriter writer, boolean cache)
void	internalSetNamespace(OMNamespace namespace) Set the namespace of the node without adding a corresponding namespace declaration.
boolean	isComplete()
boolean	isId()
String	lookupNamespaceURI(String specifiedPrefix)
void	setAttributeType(String attrType) Sets the attribute value.
void	setAttributeValue(String value) Sets the attribute value.
void	setComplete(boolean state)
void	setLocalName(String localName) Sets the name of attribute.
void	setOMNamespace(OMNamespace omNamespace) Sets the namespace of this attribute node.
void	setPrefix(String prefix)
void	setValue(String value) Sets the value of the attribute.
String	toString()

Methods inherited from class org.apache.axiom.om.impl.dom.ParentNode

addChild, addChild, appendChild, getChildNodes, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChild, getFirstChildWithName, getFirstOMChild, getFirstOMChildIfAvailable, getLastChild, getLastKnownOMChild, getLength, getSAXSource, getTextContent, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, hasChildNodes, insertBefore, item, removeChild, replaceChild, setFirstChild, setLastChild, setTextContent

Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl

buildWithAttachments, clone, cloneNode, close, compareDocumentPosition, detach, getAttributes, getBaseURI, getFeature, getNextOMSiblingIfAvailable, getOMFactory, getOwnerDocument, getParent, getPreviousOMSibling, getPreviousSibling, getUserData, hasAttributes, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setNextOMSibling, setNodeValue, setParent, setParent, setPreviousOMSibling, setUserData

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getOwnerDocument, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setTextContent, setUserData

Methods inherited from interface org.apache.axiom.om.OMInformationItem

clone, getOMFactory

Field Detail

isId

protected boolean isId

Flag used to mark an attribute as per the DOM Level 3 specification

Constructor Detail

AttrImpl

public AttrImpl(DocumentImpl ownerDocument,
                String localName,
                OMNamespace ns,
                String value,
                OMFactory factory)

AttrImpl

public AttrImpl(DocumentImpl ownerDocument,
                String name,
                String value,
                OMFactory factory)

AttrImpl

public AttrImpl(DocumentImpl ownerDocument,
                String name,
                OMFactory factory)

AttrImpl

public AttrImpl(DocumentImpl ownerDocument,
                String localName,
                OMNamespace namespace,
                OMFactory factory)

Method Detail

getNodeName

public String getNodeName()

Returns the name of this attribute.

Specified by:

getNodeName in interface Node

getNodeType

public short getNodeType()

Returns the node type.

Specified by:

getNodeType in interface Node

See Also:

Node.getNodeType()

getNodeValue

public String getNodeValue()
                    throws DOMException

Returns the value of this attribute.

Specified by:

getNodeValue in interface Node

Overrides:

getNodeValue in class NodeImpl

Throws:

DOMException

See Also:

Node.getNodeValue()

getValue

public String getValue()

Returns the value of this attribute.

Specified by:

getValue in interface Attr

See Also:

Attr.getValue()

getName

public String getName()

Specified by:

getName in interface Attr

getOwnerElement

public Element getOwnerElement()

Returns the owner element.

Specified by:

getOwnerElement in interface Attr

See Also:

Attr.getOwnerElement()

getSpecified

public boolean getSpecified()

Specified by:

getSpecified in interface Attr

getNamespace

public OMNamespace getNamespace()

Returns the namespace of the attribute as an OMNamespace.

Specified by:

getNamespace in interface OMNamedInformationItem

Returns:

The namespace of this information item, or null if the information item has no namespace. Note that this implies that the method never returns an OMNamespace object with both prefix and namespace URI set to the empty string. In addition, the prefix of the returned OMNamespace object (if any) is never null: if a null prefix was specified when creating this information item, then a prefix has been automatically assigned and the assigned prefix is returned.

See Also:

OMNamedInformationItem.getNamespace()

getQName

public QName getQName()

Returns a qname representing the attribute.

Specified by:

getQName in interface OMNamedInformationItem

Returns:

the QName for the information item

See Also:

OMNamedInformationItem.getQName()

getAttributeValue

public String getAttributeValue()

Description copied from interface: OMAttribute

Get the attribute value.

Specified by:

getAttributeValue in interface OMAttribute

Returns:

the attribute value; never null

getAttributeType

public String getAttributeType()

Description copied from interface: OMAttribute

Get the attribute type. For most attributes, the type is CDATA.

Specified by:

getAttributeType in interface OMAttribute

Returns:

the attribute type

setLocalName

public void setLocalName(String localName)

Sets the name of attribute.

Specified by:

setLocalName in interface OMNamedInformationItem

Parameters:

localName - the new local name of the information item

See Also:

OMNamedInformationItem.setLocalName(String)

internalSetNamespace

public void internalSetNamespace(OMNamespace namespace)

Set the namespace of the node without adding a corresponding namespace declaration.

setOMNamespace

public void setOMNamespace(OMNamespace omNamespace)

Sets the namespace of this attribute node.

Specified by:

setOMNamespace in interface OMAttribute

See Also:

(org.apache.axiom.om.OMNamespace)

setAttributeValue

public void setAttributeValue(String value)

Sets the attribute value.

Specified by:

setAttributeValue in interface OMAttribute

See Also:

OMAttribute.setAttributeValue(String)

setAttributeType

public void setAttributeType(String attrType)

Sets the attribute value.

Specified by:

setAttributeType in interface OMAttribute

See Also:

OMAttribute.setAttributeType(String)

setValue

public void setValue(String value)
              throws DOMException

Sets the value of the attribute.

Specified by:

setValue in interface Attr

Throws:

DOMException

See Also:

Attr.setValue(String)

getParentNode

public Node getParentNode()

Specified by:

getParentNode in interface Node

Overrides:

getParentNode in class NodeImpl

getLocalName

public String getLocalName()

Description copied from interface: OMNamedInformationItem

Get the local name of the information item.

Specified by:

getLocalName in interface OMNamedInformationItem

Specified by:

getLocalName in interface Node

Overrides:

getLocalName in class NodeImpl

Returns:

the local name of the information item

getNamespaceURI

public String getNamespaceURI()

Returns the namespace URI of this attr node.

Specified by:

getNamespaceURI in interface OMNamedInformationItem

Specified by:

getNamespaceURI in interface Node

Overrides:

getNamespaceURI in class NodeImpl

Returns:

the namespace URI of the information item or null if the information item has no namespace

See Also:

Node.getNamespaceURI()

getPrefix

public String getPrefix()

Returns the namespace prefix of this attr node.

Specified by:

getPrefix in interface OMNamedInformationItem

Specified by:

getPrefix in interface Node

Overrides:

getPrefix in class NodeImpl

Returns:

the prefix of the information item or null if the information item has no prefix

See Also:

Node.getPrefix()

setPrefix

public void setPrefix(String prefix)
               throws DOMException

Specified by:

setPrefix in interface Node

Overrides:

setPrefix in class NodeImpl

Throws:

DOMException

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()

Specified by:

getSchemaTypeInfo in interface Attr

isId

public boolean isId()

Specified by:

isId in interface Attr

toString

public String toString()

Overrides:

toString in class Object

getOwner

public OMElement getOwner()

Description copied from interface: OMAttribute

Returns the owner element of this attribute

Specified by:

getOwner in interface OMAttribute

Returns:

OMElement - The owner element

equals

public boolean equals(Object obj)

An instance of AttrImpl can act as an OMAttribute and as well as an org.w3c.dom.Attr. So we first check if the object to compare with (obj) is of type OMAttribute (this includes instances of OMAttributeImpl or AttrImpl (instances of this class)). If so we check for the equality of namespaces first (note that if the namespace of this instance is null then for the obj to be equal its namespace must also be null). This condition solely doesn't determine the equality. So we check for the equality of names and values (note that the value can also be null in which case the same argument holds as that for the namespace) of the two instances. If all three conditions are met then we say the two instances are equal.

If obj is of type org.w3c.dom.Attr then we perform the same equality check as before. Note that, however, the implementation of the test for equality in this case is little different than before.

If obj is neither of type OMAttribute nor of type org.w3c.dom.Attr then we return false.

Overrides:

equals in class Object

Parameters:

obj - The object to compare with this instance

Returns:

True if the two objects are equal or else false. The equality is checked as explained above.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

internalSerialize

public void internalSerialize(XMLStreamWriter writer,
                              boolean cache)
                       throws XMLStreamException

Specified by:

internalSerialize in class NodeImpl

Throws:

XMLStreamException

getBuilder

public final OMXMLParserWrapper getBuilder()

Specified by:

getBuilder in interface IParentNode

Specified by:

getBuilder in class NodeImpl

getState

public final int getState()

Specified by:

getState in interface IParentNode

isComplete

public final boolean isComplete()

Specified by:

isComplete in interface IParentNode

Specified by:

isComplete in class NodeImpl

setComplete

public final void setComplete(boolean state)

Specified by:

setComplete in class NodeImpl

build

public final void build()

getNextSibling

public final Node getNextSibling()

Specified by:

getNextSibling in interface Node

lookupNamespaceURI

public final String lookupNamespaceURI(String specifiedPrefix)

Specified by:

lookupNamespaceURI in interface Node