|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.xerces.dom.NodeImpl org.apache.xerces.dom.ChildNode org.apache.xerces.dom.ParentNode org.apache.xerces.dom.ElementImpl
public class ElementImpl
Elements represent most of the "markup" and structure of the document. They contain both the data for the element itself (element name and attributes), and any contained nodes, including document text (as children).
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 FormField Summary |
---|
Fields inherited from interface org.w3c.dom.TypeInfo |
---|
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION |
Constructor Summary | |
---|---|
ElementImpl(CoreDocumentImpl ownerDoc,
java.lang.String name)
Factory constructor. |
Method Summary | |
---|---|
Node |
cloneNode(boolean deep)
Return a duplicate copy of this Element. |
java.lang.String |
getAttribute(java.lang.String name)
Look up a single Attribute by name. |
Attr |
getAttributeNode(java.lang.String name)
Look up a single Attribute by name. |
Attr |
getAttributeNodeNS(java.lang.String namespaceURI,
java.lang.String localName)
Retrieves an Attr node by local name and namespace URI. |
java.lang.String |
getAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
Introduced in DOM Level 2. |
NamedNodeMap |
getAttributes()
Retrieve all the Attributes as a set. |
java.lang.String |
getBaseURI()
DOM Level 3 WD - Experimental. |
NodeList |
getElementsByTagName(java.lang.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(java.lang.String namespaceURI,
java.lang.String localName)
Introduced in DOM Level 2. |
java.lang.String |
getNodeName()
Returns the element name |
short |
getNodeType()
A short integer indicating what type of node this is. |
TypeInfo |
getSchemaTypeInfo()
Method getSchemaTypeInfo. |
java.lang.String |
getTagName()
Returns the name of the Element. |
java.lang.String |
getTypeName()
The name of a type declared for the associated element or attribute, or null if unknown. |
java.lang.String |
getTypeNamespace()
The namespace of the type declared for the associated element or attribute or null if the element does not have
declaration or if no namespace information is available. |
boolean |
hasAttribute(java.lang.String name)
Introduced in DOM Level 2. |
boolean |
hasAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
Introduced in DOM Level 2. |
boolean |
hasAttributes()
Introduced in DOM Level 2. |
boolean |
isDerivedFrom(java.lang.String typeNamespaceArg,
java.lang.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. |
void |
removeAttribute(java.lang.String name)
Remove the named attribute from this Element. |
Attr |
removeAttributeNode(Attr oldAttr)
Remove the specified attribute/value pair. |
void |
removeAttributeNS(java.lang.String namespaceURI,
java.lang.String localName)
Introduced in DOM Level 2. |
void |
setAttribute(java.lang.String name,
java.lang.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(java.lang.String namespaceURI,
java.lang.String qualifiedName,
java.lang.String value)
Introduced in DOM Level 2. |
void |
setIdAttribute(java.lang.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(java.lang.String namespaceURI,
java.lang.String localName,
boolean makeId)
DOM Level 3: register the given attribute node as an ID attribute |
void |
setReadOnly(boolean readOnly,
boolean deep)
NON-DOM: Subclassed to flip the attributes' readonly switch as well. |
Methods inherited from class org.apache.xerces.dom.ParentNode |
---|
getChildNodes, getFirstChild, getLastChild, getLength, getOwnerDocument, getTextContent, hasChildNodes, insertBefore, item, removeChild, replaceChild, setTextContent |
Methods inherited from class org.apache.xerces.dom.ChildNode |
---|
getNextSibling, getParentNode, getPreviousSibling |
Methods inherited from class org.apache.xerces.dom.NodeImpl |
---|
addEventListener, appendChild, compareDocumentPosition, compareTreePosition, dispatchEvent, getFeature, getLocalName, getNamespaceURI, getNodeValue, getPrefix, getReadOnly, getUserData, getUserData, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setPrefix, setUserData, setUserData, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.w3c.dom.Node |
---|
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 |
Constructor Detail |
---|
public ElementImpl(CoreDocumentImpl ownerDoc, java.lang.String name)
Method Detail |
---|
public short getNodeType()
getNodeType
in interface Node
getNodeType
in class NodeImpl
public java.lang.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
deep
- If true
, recursively clone the subtree under
the specified node; if false
, clone only the node
itself (and its attributes, if it is an Element
).
Node.cloneNode(boolean)
public java.lang.String getBaseURI()
getBaseURI
in interface Node
getBaseURI
in class NodeImpl
public java.lang.String getAttribute(java.lang.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
name
- The name of the attribute to retrieve.
Attr
value as a string, or the empty string
if that attribute does not have a specified or default value.public Attr getAttributeNode(java.lang.String name)
If no matching attribute is available, returns null.
getAttributeNode
in interface Element
name
- The name (nodeName
) of the attribute to
retrieve.
Attr
node with the specified name (
nodeName
) or null
if there is no such
attribute.public NodeList getElementsByTagName(java.lang.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 "*".
Element
nodes.DeepNodeListImpl
public java.lang.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(java.lang.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
name
- The name of the attribute to remove.
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
oldAttr
- The Attr
node to remove from the attribute
list.
DOMException(NOT_FOUND_ERR)
- if oldattr is not an attribute of
this Element.
DOMException(NO_MODIFICATION_ALLOWED_ERR)
- if the node is
readonly.
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
oldAttr
is not an attribute
of the element.public void setAttribute(java.lang.String name, java.lang.String value)
setAttribute
in interface Element
name
- The name of the attribute to create or alter.value
- Value to set in string form.
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
newAttr
- The Attr
node to add to the attribute list.
newAttr
attribute replaces an existing
attribute, the replaced Attr
node is returned,
otherwise null
is returned.
DOMException(INUSE_ATTRIBUTE_ERR)
- if the Attribute object
has already been assigned to another Element.
DOMException
- WRONG_DOCUMENT_ERR: Raised if newAttr
was created from a
different document than the one that created the element.
newAttr
is already an
attribute of another Element
object. The DOM user must
explicitly clone Attr
nodes to re-use them in other
elements.public java.lang.String getAttributeNS(java.lang.String namespaceURI, java.lang.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(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.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(java.lang.String namespaceURI, java.lang.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(java.lang.String namespaceURI, java.lang.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
- WRONG_DOCUMENT_ERR: Raised if newAttr
was created from a
different document than the one that created the element.
newAttr
is already an
attribute of another Element
object. The DOM user must
explicitly clone Attr
nodes to re-use them in other
elements.
"XML"
and the language exposed
through the Document does not support XML Namespaces (such as [HTML 4.01]).public boolean hasAttributes()
hasAttributes
in interface Node
hasAttributes
in class NodeImpl
true
if this node has any attributes,
false
otherwise.ElementImpl
public boolean hasAttribute(java.lang.String name)
hasAttribute
in interface Element
name
- The name of the attribute to look for.
true
if an attribute with the given name is
specified on this element or has a default value, false
otherwise.public boolean hasAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
hasAttributeNS
in interface Element
namespaceURI
- The namespace URI of the attribute to look for.localName
- The local name of the attribute to look for.
true
if an attribute with the given local name
and namespace URI is specified or has a default value on this
element, false
otherwise.public NodeList getElementsByTagNameNS(java.lang.String namespaceURI, java.lang.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
at
- The attribute node.makeId
- Whether the attribute is a of type ID.public void setIdAttribute(java.lang.String name, boolean makeId)
setIdAttribute
in interface Element
name
- The name of the attribute.makeId
- Whether the attribute is a of type ID.public void setIdAttributeNS(java.lang.String namespaceURI, java.lang.String localName, boolean makeId)
setIdAttributeNS
in interface Element
namespaceURI
- The namespace URI of the attribute.localName
- The local name of the attribute.makeId
- Whether the attribute is a of type ID.public java.lang.String getTypeName()
TypeInfo
null
if unknown.
getTypeName
in interface TypeInfo
TypeInfo.getTypeName()
public java.lang.String getTypeNamespace()
TypeInfo
null
if the element does not have
declaration or if no namespace information is available.
getTypeNamespace
in interface TypeInfo
TypeInfo.getTypeNamespace()
public boolean isDerivedFrom(java.lang.String typeNamespaceArg, java.lang.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 method
public 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)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |