|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.axis2.om.impl.dom.NodeImpl
org.apache.axis2.om.impl.dom.ChildNode
org.apache.axis2.om.impl.dom.ParentNode
org.apache.axis2.om.impl.dom.ElementImpl
Implementation of the org.w3c.dom.Element and org.apache.axis2.om.Element interfaces.
Field Summary | |
protected String |
localName
|
protected OMNamespace |
namespace
|
Fields inherited from class org.apache.axis2.om.impl.dom.ParentNode |
firstChild, lastChild |
Fields inherited from class org.apache.axis2.om.impl.dom.ChildNode |
nextSibling, parentNode, previousSibling |
Fields inherited from class org.apache.axis2.om.impl.dom.NodeImpl |
builder, done, FIRSTCHILD, flags, nodeType, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED |
Fields inherited from interface org.w3c.dom.Node |
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE |
Fields inherited from interface org.apache.axis2.om.OMNode |
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE |
Fields inherited from interface org.apache.axis2.om.OMConstants |
ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DEFAULT_CHAR_SET_ENCODING, DEFAULT_XML_VERSION, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI |
Constructor Summary | |
ElementImpl(DocumentImpl ownerDocument,
String tagName)
|
|
ElementImpl(DocumentImpl ownerDocument,
String tagName,
NamespaceImpl ns)
Creates a new element with the namespace. |
|
ElementImpl(DocumentImpl ownerDocument,
String tagName,
NamespaceImpl ns,
OMXMLParserWrapper builder)
|
|
ElementImpl(ParentNode parentNode,
String tagName,
NamespaceImpl ns)
|
|
ElementImpl(ParentNode parentNode,
String tagName,
NamespaceImpl ns,
OMXMLParserWrapper builder)
|
|
ElementImpl(String tagName,
NamespaceImpl ns,
OMXMLParserWrapper builder)
|
Method Summary | |
OMAttribute |
addAttribute(OMAttribute attr)
Adds an attribute to this element. |
OMAttribute |
addAttribute(String attributeName,
String value,
OMNamespace ns)
The behaviour of this is the same as org.w3c.dom.Element#setAttributeNS |
Node |
cloneNode(boolean deep)
|
OMElement |
cloneOMElement()
Creates a clone which belongs to a new document. |
OMNamespace |
declareNamespace(OMNamespace namespace)
Allows overriding an existing declaration if the same prefix was used. |
OMNamespace |
declareNamespace(String uri,
String prefix)
Allows overriding an existing declaration if the same prefix was used. |
void |
discard()
Discards a node. |
OMNamespace |
findNamespace(String uri,
String prefix)
Finds a namespace with the given uri and prefix, in the scope of the hierarchy. |
OMNamespace |
findNamespaceURI(String prefix)
Checks for a namespace in the context of this element with the given prefix and returns the relevant namespace object, if available. |
Iterator |
getAllAttributes()
Returns a list of OMAttributes. |
Iterator |
getAllDeclaredNamespaces()
Returns an iterator for all of the namespaces declared on this element. |
OMAttribute |
getAttribute(QName qname)
Returns a named attribute if present. |
String |
getAttribute(String name)
Looks in the local list of attributes and returns if found. |
Attr |
getAttributeNode(String name)
Retrieves an attribute node by name. |
Attr |
getAttributeNodeNS(String namespaceURI,
String localName)
Retrieves an attribute node by local name and namespace URI. |
String |
getAttributeNS(String namespaceURI,
String localName)
Retrieves an attribute value by local name and namespace URI. |
NamedNodeMap |
getAttributes()
Returns the set of attributes of this node and the namespace declarations available. |
String |
getAttributeValue(QName qname)
Returns a named attribute's value, if present. |
OMXMLParserWrapper |
getBuilder()
Returns the builder object. |
Iterator |
getChildElements()
Returns a filtered list of children - just the elements. |
NodeList |
getElementsByTagName(String name)
|
NodeList |
getElementsByTagNameNS(String namespaceURI,
String localName)
|
OMElement |
getFirstElement()
Returns the first Element node. |
String |
getLocalName()
Returns the local name of this element node |
OMNamespace |
getNamespace()
Returns the namespace of this element. |
String |
getNamespaceURI()
Returns the value of the namespace URI. |
String |
getNamespaceURI(String prefix)
Returns the namespace uri, given the prefix. |
OMNode |
getNextOMSibling()
Returns the next sibling in document order. |
String |
getNodeName()
|
short |
getNodeType()
|
String |
getPrefix()
Returns the namespace prefix of this element node |
QName |
getQName()
Returns the QName of this element. |
TypeInfo |
getSchemaTypeInfo()
|
String |
getTagName()
|
String |
getText()
Gets all the text children and concatinates them to a single string. |
int |
getType()
Returns the type of node. |
XMLStreamReader |
getXMLStreamReader()
Returns the pull parser that will generate the pull events relevant to THIS element. |
XMLStreamReader |
getXMLStreamReaderWithoutCaching()
Returns the pull parser that will generate the pull events relevant to THIS element. |
boolean |
hasAttribute(String name)
|
boolean |
hasAttributeNS(String namespaceURI,
String localName)
Returns whether the given attribute is available or not. |
boolean |
hasAttributes()
Returns whether this element contains any attribute or not. |
void |
removeAttribute(OMAttribute attr)
Removes an attribute from the element. |
void |
removeAttribute(String name)
Removes an attribute by name. |
Attr |
removeAttributeNode(Attr oldAttr)
Removes the specified attribute node. |
void |
removeAttributeNS(String namespaceURI,
String localName)
|
boolean |
removeNamespace(String prefix)
Removes a declared namespace given its prefix. |
QName |
resolveQName(String qname)
Turn a prefix:local qname string into a proper QName, evaluating it in the OMElement context unprefixed qnames resolve to the local namespace |
void |
serialize(OMOutputImpl omOutput)
Serializes the node with caching. |
protected void |
serialize(OMOutputImpl omOutput,
boolean cache)
|
void |
serializeAndConsume(OMOutputImpl omOutput)
Serializes the node without caching. |
void |
setAttribute(String name,
String value)
|
Attr |
setAttributeNode(Attr attr)
Adds a new attribute node. |
Attr |
setAttributeNodeNS(Attr attr)
|
void |
setAttributeNS(String namespaceURI,
String qualifiedName,
String value)
Adds a new attribute. |
void |
setBuilder(OMXMLParserWrapper wrapper)
Sets the OM builder. |
void |
setIdAttribute(String arg0,
boolean arg1)
|
void |
setIdAttributeNode(Attr arg0,
boolean arg1)
|
void |
setIdAttributeNS(String arg0,
String arg1,
boolean arg2)
|
void |
setLocalName(String localName)
Sets the local name. |
void |
setNamespace(OMNamespace namespace)
Sets the namespace. |
protected void |
setOwnerDocument(DocumentImpl document)
Sets the owner document. |
void |
setText(String text)
Creates a text node with the given value and adds it to the element. |
void |
setType(int nodeType)
|
String |
toString()
Overridden toString() for ease of debugging. |
String |
toStringWithConsume()
This is a convenience method only. |
Methods inherited from class org.apache.axis2.om.impl.dom.ParentNode |
addChild, buildNext, getChildNodes, getChildren, getChildrenWithName, getFirstChild, getFirstChildWithName, getFirstOMChild, getLastChild, hasChildNodes, insertBefore, removeChild, replaceChild, setFirstChild |
Methods inherited from class org.apache.axis2.om.impl.dom.ChildNode |
detach, getNextSibling, getParent, getParentNode, getPreviousOMSibling, getPreviousSibling, insertSiblingAfter, insertSiblingBefore, setNextOMSibling, setParent, setPreviousOMSibling |
Methods inherited from class org.apache.axis2.om.impl.dom.NodeImpl |
appendChild, build, compareDocumentPosition, getBaseURI, getFeature, getLength, getNodeValue, getOwnerDocument, getTextContent, getUserData, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeWithCache, setComplete, setNodeValue, setPrefix, setTextContent, setUserData |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.w3c.dom.Node |
appendChild, getChildNodes, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix |
Methods inherited from interface org.apache.axis2.om.OMElement |
setFirstChild |
Methods inherited from interface org.apache.axis2.om.OMNode |
build, detach, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, isComplete, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume |
Methods inherited from interface org.apache.axis2.om.OMContainer |
addChild, buildNext, getChildren, getChildrenWithName, getFirstChildWithName, getFirstOMChild, isComplete |
Methods inherited from interface org.apache.axis2.om.impl.OMContainerEx |
setComplete |
Field Detail |
protected OMNamespace namespace
protected String localName
Constructor Detail |
public ElementImpl(DocumentImpl ownerDocument, String tagName)
ownerDocument
- public ElementImpl(DocumentImpl ownerDocument, String tagName, NamespaceImpl ns)
ownerDocument
- tagName
- ns
- public ElementImpl(DocumentImpl ownerDocument, String tagName, NamespaceImpl ns, OMXMLParserWrapper builder)
public ElementImpl(ParentNode parentNode, String tagName, NamespaceImpl ns)
public ElementImpl(ParentNode parentNode, String tagName, NamespaceImpl ns, OMXMLParserWrapper builder)
public ElementImpl(String tagName, NamespaceImpl ns, OMXMLParserWrapper builder)
Method Detail |
public short getNodeType()
getNodeType
in interface Node
public String getNodeName()
getNodeName
in interface Node
public String getNamespaceURI()
getNamespaceURI
in interface Node
getNamespaceURI
in class NodeImpl
public int getType() throws OMException
OMNode
getType
in interface OMNode
OMNode.ELEMENT_NODE
, OMNode.TEXT_NODE
, OMNode.CDATA_SECTION_NODE
, OMNode.COMMENT_NODE
,
OMNode.DTD_NODE
, OMNode.PI_NODE
, OMNode.ENTITY_REFERENCE_NODE
, OMNode.SPACE_NODE
,
or OMNode.TEXT_NODE
.
OMException
public void setType(int nodeType) throws OMException
setType
in interface OMNodeEx
OMException
public String getTagName()
getTagName
in interface Element
public void removeAttribute(String name) throws DOMException
removeAttribute
in interface Element
name
- The name of the attribute to remove
DOMException
Element.removeAttribute(java.lang.String)
public void removeAttributeNS(String namespaceURI, String localName) throws DOMException
removeAttributeNS
in interface Element
DOMException
public Attr removeAttributeNode(Attr oldAttr) throws DOMException
removeAttributeNode
in interface Element
DOMException
Element.removeAttributeNode(org.w3c.dom.Attr)
public boolean hasAttribute(String name)
hasAttribute
in interface Element
public boolean hasAttributeNS(String namespaceURI, String localName)
hasAttributeNS
in interface Element
Element.hasAttributeNS(java.lang.String,
java.lang.String)
public String getAttribute(String name)
getAttribute
in interface Element
Element.getAttribute(java.lang.String)
public Attr getAttributeNode(String name)
getAttributeNode
in interface Element
Element.getAttributeNode(java.lang.String)
public String getAttributeNS(String namespaceURI, String localName)
getAttributeNS
in interface Element
Element.getAttributeNS(java.lang.String,
java.lang.String)
public Attr getAttributeNodeNS(String namespaceURI, String localName)
getAttributeNodeNS
in interface Element
Element.getAttributeNodeNS(java.lang.String,
java.lang.String)
public Attr setAttributeNode(Attr attr) throws DOMException
setAttributeNode
in interface Element
DOMException
Element.setAttributeNode(org.w3c.dom.Attr)
public void setAttribute(String name, String value) throws DOMException
setAttribute
in interface Element
DOMException
public Attr setAttributeNodeNS(Attr attr) throws DOMException
setAttributeNodeNS
in interface Element
DOMException
public void setAttributeNS(String namespaceURI, String qualifiedName, String value) throws DOMException
setAttributeNS
in interface Element
DOMException
Element.setAttributeNS(java.lang.String,
java.lang.String, java.lang.String)
public boolean hasAttributes()
hasAttributes
in interface Node
hasAttributes
in class NodeImpl
public NodeList getElementsByTagNameNS(String namespaceURI, String localName)
getElementsByTagNameNS
in interface Element
public NodeList getElementsByTagName(String name)
getElementsByTagName
in interface Element
public OMAttribute addAttribute(OMAttribute attr)
OMElement
There is no order implied by added attributes.
addAttribute
in interface OMElement
attr
- The attribute to add.
(org.apache.axis2.om.OMAttribute)
public OMAttribute addAttribute(String attributeName, String value, OMNamespace ns)
addAttribute
in interface OMElement
attributeName
- The "local name" for the attribute.value
- The string value of the attribute.ns
- The namespace has to be one of the in scope namespace. i.e. the passed namespace
must be declared in the parent element of this attribute or ancestors of the parent element of the attribute.
OMElement.addAttribute(java.lang.String,
java.lang.String, org.apache.axis2.om.OMNamespace)
public OMNamespace declareNamespace(OMNamespace namespace)
declareNamespace
in interface OMElement
namespace
- The namespace to declare
(org.apache.axis2.om.OMNamespace)
public OMNamespace declareNamespace(String uri, String prefix)
declareNamespace
in interface OMElement
uri
- The namespace to declare in the current scope. The
caller is expected to ensure that the URI is a valid namespace name.prefix
- The prefix to associate with the given namespace.
The caller is expected to ensure that this is a valid XML prefix.
OMElement.declareNamespace(java.lang.String,
java.lang.String)
public OMNamespace findNamespace(String uri, String prefix)
OMElement
Searches from the current element and goes up the hiararchy until a match is found. If no match is found, returns null.
Either prefix or uri should be null. Results are undefined if both are specified.
findNamespace
in interface OMElement
uri
- The namespace to look for. If this is specified, prefix should be null.prefix
- The prefix to look for. If this is specified, uri should be null.
OMElement.findNamespace(java.lang.String,
java.lang.String)
public OMNamespace findNamespaceURI(String prefix)
OMElement
findNamespaceURI
in interface OMElement
prefix
- public OMAttribute getAttribute(QName qname)
getAttribute
in interface OMElement
qname
- the qualified name to search for
(javax.xml.namespace.QName)
public String getAttributeValue(QName qname)
getAttributeValue
in interface OMElement
qname
- the qualified name to search for
public OMXMLParserWrapper getBuilder()
OMElement
getBuilder
in interface OMElement
public OMElement getFirstElement()
getFirstElement
in interface OMElement
OMElement.getFirstElement()
public OMNamespace getNamespace() throws OMException
getNamespace
in interface OMElement
OMException
OMElement.getNamespace()
public QName getQName()
getQName
in interface OMElement
QName
for the element.OMElement.getQName()
public String getText()
getText
in interface OMElement
OMElement.getText()
public void removeAttribute(OMAttribute attr)
removeAttribute
in interface OMElement
attr
- (org.apache.axis2.om.OMAttribute)
public void setBuilder(OMXMLParserWrapper wrapper)
setBuilder
in interface OMElement
wrapper
- (org.apache.axis2.om.OMXMLParserWrapper)
public void setLocalName(String localName)
setLocalName
in interface OMElement
localName
- OMElement.setLocalName(java.lang.String)
public void setNamespace(OMNamespace namespace)
setNamespace
in interface OMElement
namespace
- (org.apache.axis2.om.OMNamespace)
public void setText(String text)
setText
in interface OMElement
text
- OMElement.setText(java.lang.String)
public void serialize(OMOutputImpl omOutput) throws XMLStreamException
OMNodeEx
serialize
in interface OMNodeEx
omOutput
-
XMLStreamException
OMNodeEx.serialize(org.apache.axis2.om.impl.OMOutputImpl)
public void serializeAndConsume(OMOutputImpl omOutput) throws XMLStreamException
OMNodeEx
serializeAndConsume
in interface OMNodeEx
omOutput
-
XMLStreamException
protected void serialize(OMOutputImpl omOutput, boolean cache) throws XMLStreamException
XMLStreamException
public XMLStreamReader getXMLStreamReaderWithoutCaching()
OMElement
Caching is off.
getXMLStreamReaderWithoutCaching
in interface OMElement
public XMLStreamReader getXMLStreamReader()
OMElement
Caching is on.
getXMLStreamReader
in interface OMElement
public String toStringWithConsume() throws XMLStreamException
OMElement
toStringWithConsume
in interface OMElement
XMLStreamException
public String toString()
toString
in interface OMElement
Object.toString()
public Iterator getChildElements()
OMElement
getChildElements
in interface OMElement
OMContainer.getChildren()
,
OMContainer.getChildrenWithName(javax.xml.namespace.QName)
public Iterator getAllDeclaredNamespaces() throws OMException
OMElement
If you're interested in all namespaces in scope, you need to call this function for all parent elements as well. Note that the iterator may be invalidated by any call to either declareNamespace function.
getAllDeclaredNamespaces
in interface OMElement
OMNamespace
items declared on the current element.
OMException
OMElement.getAllDeclaredNamespaces()
public Iterator getAllAttributes()
OMElement
Note that the iterator returned by this function will be invalidated by any addAttribute call.
getAllAttributes
in interface OMElement
Iterator
of OMAttribute
items associated with the element.OMElement.getAllAttributes()
public String getLocalName()
getLocalName
in interface Node
getLocalName
in class NodeImpl
Node.getLocalName()
public String getPrefix()
getPrefix
in interface Node
getPrefix
in class NodeImpl
Node.getPrefix()
protected void setOwnerDocument(DocumentImpl document)
NodeImpl
setOwnerDocument
in class NodeImpl
document
- (org.apache.axis2.om.impl.dom.DocumentImpl)
public QName resolveQName(String qname)
resolveQName
in interface OMElement
qname
- prefixed qname string to resolve
public OMElement cloneOMElement()
cloneOMElement
in interface OMElement
OMElement.cloneOMElement()
public Node cloneNode(boolean deep)
cloneNode
in interface Node
cloneNode
in class ParentNode
public NamedNodeMap getAttributes()
getAttributes
in interface Node
getAttributes
in class NodeImpl
ElementImpl
public String getNamespaceURI(String prefix)
prefix
-
public boolean removeNamespace(String prefix)
prefix
-
public OMNode getNextOMSibling() throws OMException
OMNode
getNextOMSibling
in interface OMNode
getNextOMSibling
in class ChildNode
OMException
public void discard() throws OMException
OMNode
Discard goes to the parser level and if the element is not completely built, then it will be completely skipped at the parser level.
discard
in interface OMNode
discard
in class ChildNode
OMException
public TypeInfo getSchemaTypeInfo()
public void setIdAttribute(String arg0, boolean arg1) throws DOMException
DOMException
public void setIdAttributeNode(Attr arg0, boolean arg1) throws DOMException
DOMException
public void setIdAttributeNS(String arg0, String arg1, boolean arg2) throws DOMException
DOMException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |