public class ElementImpl extends ParentNode implements Element, ElementTraversal, TypeInfo
Elements may have Attributes associated with them; the API for this is defined in Node, but the function is implemented here. In general, XML applications should retrive Attributes as Nodes, since they may contain entity references and hence be a fairly complex sub-tree. HTML users will be dealing with simple string values, and convenience methods are provided to work in terms of Strings.
ElementImpl does not support Namespaces. ElementNSImpl, which inherits from it, does.
ElementNSImpl
,
Serialized FormModifier and Type | Field and Description |
---|---|
protected AttributeMap |
attributes
Attributes.
|
protected String |
name
Element name.
|
firstChild, fNodeListCache, ownerDocument
nextSibling, previousSibling
DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_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
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION
Modifier | Constructor and Description |
---|---|
protected |
ElementImpl() |
|
ElementImpl(CoreDocumentImpl ownerDoc,
String name)
Factory constructor.
|
Modifier and Type | Method and Description |
---|---|
Node |
cloneNode(boolean deep)
Return a duplicate copy of this Element.
|
String |
getAttribute(String name)
Look up a single Attribute by name.
|
Attr |
getAttributeNode(String name)
Look up a single Attribute by name.
|
Attr |
getAttributeNodeNS(String namespaceURI,
String localName)
Retrieves an Attr node by local name and namespace URI.
|
String |
getAttributeNS(String namespaceURI,
String localName)
Introduced in DOM Level 2.
|
NamedNodeMap |
getAttributes()
Retrieve all the Attributes as a set.
|
String |
getBaseURI()
DOM Level 3 WD - Experimental.
|
int |
getChildElementCount()
Returns the current number of element nodes that are children of this
element.
|
protected NamedNodeMapImpl |
getDefaultAttributes()
Get the default attributes.
|
NodeList |
getElementsByTagName(String tagname)
Returns a NodeList of all descendent nodes (children,
grandchildren, and so on) which are Elements and which have the
specified tag name.
|
NodeList |
getElementsByTagNameNS(String namespaceURI,
String localName)
Introduced in DOM Level 2.
|
Element |
getFirstElementChild()
Returns the first child element node of this element.
|
Element |
getLastElementChild()
Returns the last child element node of this element.
|
Element |
getNextElementSibling()
Returns the next sibling element node of this element.
|
String |
getNodeName()
Returns the element name
|
short |
getNodeType()
A short integer indicating what type of node this is.
|
Element |
getPreviousElementSibling()
Returns the previous sibling element node of this element.
|
TypeInfo |
getSchemaTypeInfo()
Method getSchemaTypeInfo.
|
String |
getTagName()
Returns the name of the Element.
|
String |
getTypeName() |
String |
getTypeNamespace() |
protected int |
getXercesAttribute(String namespaceURI,
String localName)
NON-DOM: get inded of an attribute
|
protected Attr |
getXMLBaseAttribute()
NON-DOM
Returns the xml:base attribute.
|
boolean |
hasAttribute(String name)
Introduced in DOM Level 2.
|
boolean |
hasAttributeNS(String namespaceURI,
String localName)
Introduced in DOM Level 2.
|
boolean |
hasAttributes()
Introduced in DOM Level 2.
|
boolean |
isDerivedFrom(String typeNamespaceArg,
String typeNameArg,
int derivationMethod)
Introduced in DOM Level 3.
|
boolean |
isEqualNode(Node arg)
DOM Level 3 WD- Experimental.
|
void |
normalize()
In "normal form" (as read from a source file), there will never be two
Text children in succession.
|
protected void |
reconcileDefaultAttributes()
Reconcile default attributes.
|
void |
removeAttribute(String name)
Remove the named attribute from this Element.
|
Attr |
removeAttributeNode(Attr oldAttr)
Remove the specified attribute/value pair.
|
void |
removeAttributeNS(String namespaceURI,
String localName)
Introduced in DOM Level 2.
|
void |
setAttribute(String name,
String value)
Add a new name/value pair, or replace the value of the existing
attribute having that name.
|
Attr |
setAttributeNode(Attr newAttr)
Add a new attribute/value pair, or replace the value of the
existing attribute with that name.
|
Attr |
setAttributeNodeNS(Attr newAttr)
Introduced in DOM Level 2.
|
void |
setAttributeNS(String namespaceURI,
String qualifiedName,
String value)
Introduced in DOM Level 2.
|
void |
setIdAttribute(String name,
boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute
|
void |
setIdAttributeNode(Attr at,
boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute
|
void |
setIdAttributeNS(String namespaceURI,
String localName,
boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute
|
protected void |
setOwnerDocument(CoreDocumentImpl doc)
NON-DOM
set the ownerDocument of this node, its children, and its attributes
|
void |
setReadOnly(boolean readOnly,
boolean deep)
NON-DOM: Subclassed to flip the attributes' readonly switch as well.
|
protected void |
setupDefaultAttributes()
Setup the default attributes.
|
protected int |
setXercesAttributeNode(Attr attr)
NON-DOM: sets attribute node for this element
|
protected void |
synchronizeData()
Synchronizes the data (name and value) for fast nodes.
|
getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, getTextContent, hasChildNodes, insertBefore, item, removeChild, replaceChild, setTextContent, synchronizeChildren
getNextSibling, getParentNode, getPreviousSibling
addEventListener, appendChild, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getLocalName, getNamespaceURI, getNodeNumber, getNodeValue, getPrefix, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setPrefix, setUserData, setUserData, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
appendChild, compareDocumentPosition, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
protected String name
protected AttributeMap attributes
public ElementImpl(CoreDocumentImpl ownerDoc, String name)
protected ElementImpl()
public short getNodeType()
getNodeType
in interface Node
getNodeType
in class NodeImpl
public String getNodeName()
getNodeName
in interface Node
getNodeName
in class NodeImpl
public NamedNodeMap getAttributes()
getAttributes
in interface Node
getAttributes
in class NodeImpl
ElementImpl
public Node cloneNode(boolean deep)
cloneNode
in interface Node
cloneNode
in class ParentNode
Node.cloneNode(boolean)
public String getBaseURI()
getBaseURI
in interface Node
getBaseURI
in class NodeImpl
protected Attr getXMLBaseAttribute()
protected void setOwnerDocument(CoreDocumentImpl doc)
setOwnerDocument
in class ParentNode
public String getAttribute(String name)
Note: Attributes may contain complex node trees. This method returns the "flattened" string obtained from Attribute.getValue(). If you need the structure information, see getAttributeNode().
getAttribute
in interface Element
public Attr getAttributeNode(String name)
If no matching attribute is available, returns null.
getAttributeNode
in interface Element
public NodeList getElementsByTagName(String tagname)
Note: NodeList is a "live" view of the DOM. Its contents will change as the DOM changes, and alterations made to the NodeList will be reflected in the DOM.
getElementsByTagName
in interface Element
tagname
- The type of element to gather. To obtain a list of
all elements no matter what their names, use the wild-card tag
name "*".DeepNodeListImpl
public String getTagName()
This is case-preserving in XML. HTML should uppercasify it on the way in.
getTagName
in interface Element
public void normalize()
To normalize a Document, normalize its top-level Element child.
As of PR-DOM-Level-1-19980818, CDATA -- despite being a subclass of Text -- is considered "markup" and will _not_ be merged either with normal Text or with other CDATASections.
normalize
in interface Node
normalize
in class ParentNode
public void removeAttribute(String name)
The default logic is actually implemented in NamedNodeMapImpl. PR-DOM-Level-1-19980818 doesn't fully address the DTD, so some of this behavior is likely to change in future versions. ?????
Note that this call "succeeds" even if no attribute by this name existed -- unlike removeAttributeNode, which will throw a not-found exception in that case.
removeAttribute
in interface Element
DOMException(NO_MODIFICATION_ALLOWED_ERR)
- if the node is
readonly.public Attr removeAttributeNode(Attr oldAttr) throws DOMException
NOTE: Specifically removes THIS NODE -- not the node with this name, nor the node with these contents. If the specific Attribute object passed in is not stored in this Element, we throw a DOMException. If you really want to remove an attribute by name, use removeAttribute().
removeAttributeNode
in interface Element
DOMException(NOT_FOUND_ERR)
- if oldattr is not an attribute of
this Element.DOMException(NO_MODIFICATION_ALLOWED_ERR)
- if the node is
readonly.DOMException
public void setAttribute(String name, String value)
setAttribute
in interface Element
DOMException(INVALID_NAME_ERR)
- if the name is not acceptable.
(Attribute factory will do that test for us.)DOMException(NO_MODIFICATION_ALLOWED_ERR)
- if the node is
readonly.public Attr setAttributeNode(Attr newAttr) throws DOMException
This method allows you to add an Attribute that has already been constructed, and hence avoids the limitations of the simple setAttribute() call. It can handle attribute values that have arbitrarily complex tree structure -- in particular, those which had entity references mixed into their text.
setAttributeNode
in interface Element
DOMException(INUSE_ATTRIBUTE_ERR)
- if the Attribute object
has already been assigned to another Element.DOMException
public String getAttributeNS(String namespaceURI, String localName)
Retrieves an attribute value by local name and namespace URI.
getAttributeNS
in interface Element
namespaceURI
- The namespace URI of the attribute to
retrieve.localName
- The local name of the attribute to retrieve.public void setAttributeNS(String namespaceURI, String qualifiedName, String value)
Adds a new attribute. If the given namespaceURI is null or an empty string and the qualifiedName has a prefix that is "xml", the new attribute is bound to the predefined namespace "http://www.w3.org/XML/1998/namespace" [Namespaces]. If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be the value parameter. This value is a simple string, it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNodeNS or setAttributeNode to assign it as the value of an attribute.
setAttributeNS
in interface Element
namespaceURI
- The namespace URI of the attribute to create
or alter.qualifiedName
- The qualified name of the attribute to create or
alter.value
- The value to set in string form.INVALID_CHARACTER_ERR:
- Raised if the specified
name contains an invalid character.NO_MODIFICATION_ALLOWED_ERR:
- Raised if this
node is readonly.NAMESPACE_ERR:
- Raised if the qualifiedName
has a prefix that is "xml" and the namespaceURI
is neither null nor an empty string nor
"http://www.w3.org/XML/1998/namespace", or if
the qualifiedName has a prefix that is "xmlns"
but the namespaceURI is neither null nor an
empty string, or if if the qualifiedName has a
prefix different from "xml" and "xmlns" and the
namespaceURI is null or an empty string.public void removeAttributeNS(String namespaceURI, String localName)
Removes an attribute by local name and namespace URI. If the removed attribute has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix.
removeAttributeNS
in interface Element
namespaceURI
- The namespace URI of the attribute to remove.localName
- The local name of the attribute to remove.NO_MODIFICATION_ALLOWED_ERR:
- Raised if this
node is readonly.public Attr getAttributeNodeNS(String namespaceURI, String localName)
getAttributeNodeNS
in interface Element
namespaceURI
- The namespace URI of the attribute to
retrieve.localName
- The local name of the attribute to retrieve.public Attr setAttributeNodeNS(Attr newAttr) throws DOMException
Adds a new attribute. If an attribute with that local name and namespace URI is already present in the element, it is replaced by the new one.
setAttributeNodeNS
in interface Element
newAttr
- The Attr node to add to the attribute list. When
the Node has no namespaceURI, this method behaves
like setAttributeNode.WRONG_DOCUMENT_ERR:
- Raised if newAttr
was created from a different document than the one that
created the element.NO_MODIFICATION_ALLOWED_ERR:
- Raised if
this node is readonly.INUSE_ATTRIBUTE_ERR:
- Raised if newAttr is
already an attribute of another Element object. The
DOM user must explicitly clone Attr nodes to re-use
them in other elements.DOMException
protected int setXercesAttributeNode(Attr attr)
protected int getXercesAttribute(String namespaceURI, String localName)
public boolean hasAttributes()
hasAttributes
in interface Node
hasAttributes
in class NodeImpl
true
if this node has any attributes,
false
otherwise.ElementImpl
public boolean hasAttribute(String name)
hasAttribute
in interface Element
public boolean hasAttributeNS(String namespaceURI, String localName)
hasAttributeNS
in interface Element
public NodeList getElementsByTagNameNS(String namespaceURI, String localName)
Returns a NodeList of all the Elements with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the Document tree, starting from this node.
getElementsByTagNameNS
in interface Element
namespaceURI
- The namespace URI of the elements to match
on. The special value "*" matches all
namespaces. When it is null or an empty
string, this method behaves like
getElementsByTagName.localName
- The local name of the elements to match on.
The special value "*" matches all local names.public boolean isEqualNode(Node arg)
isEqualNode
in interface Node
isEqualNode
in class ParentNode
arg
- The node to compare equality with.true
otherwise false
.public void setIdAttributeNode(Attr at, boolean makeId)
setIdAttributeNode
in interface Element
public void setIdAttribute(String name, boolean makeId)
setIdAttribute
in interface Element
public void setIdAttributeNS(String namespaceURI, String localName, boolean makeId)
setIdAttributeNS
in interface Element
public String getTypeName()
getTypeName
in interface TypeInfo
TypeInfo.getTypeName()
public String getTypeNamespace()
getTypeNamespace
in interface TypeInfo
TypeInfo.getTypeNamespace()
public boolean isDerivedFrom(String typeNamespaceArg, String typeNameArg, int derivationMethod)
Checks if a type is derived from another by restriction. See: http://www.w3.org/TR/DOM-Level-3-Core/core.html#TypeInfo-isDerivedFrom
isDerivedFrom
in interface TypeInfo
typeNamespaceArg
- The namspace of the ancestor type declarationtypeNameArg
- The name of the ancestor type declarationderivationMethod
- The derivation methodpublic TypeInfo getSchemaTypeInfo()
getSchemaTypeInfo
in interface Element
public void setReadOnly(boolean readOnly, boolean deep)
setReadOnly
in class ParentNode
readOnly
- True or false as desired.deep
- If true, children are also toggled. Note that this will
not change the state of an EntityReference or its children,
which are always read-only.NodeImpl.setReadOnly(boolean, boolean)
protected void synchronizeData()
synchronizeData
in class NodeImpl
protected void setupDefaultAttributes()
protected void reconcileDefaultAttributes()
protected NamedNodeMapImpl getDefaultAttributes()
public final int getChildElementCount()
ElementTraversal
0
if this element has no child nodes that are of
nodeType
1
.getChildElementCount
in interface ElementTraversal
public final Element getFirstElementChild()
ElementTraversal
null
if this element has no child elements.getFirstElementChild
in interface ElementTraversal
public final Element getLastElementChild()
ElementTraversal
null
if this element has no child elements.getLastElementChild
in interface ElementTraversal
public final Element getNextElementSibling()
ElementTraversal
null
if this element has no element sibling nodes that
come after this one in the document tree.getNextElementSibling
in interface ElementTraversal
public final Element getPreviousElementSibling()
ElementTraversal
null
if this element has no element sibling nodes that
come before this one in the document tree.getPreviousElementSibling
in interface ElementTraversal
Copyright © 2021 JBoss by Red Hat. All rights reserved.