Package com.icl.saxon.tree
Class ElementWithAttributes
- java.lang.Object
-
- com.icl.saxon.om.AbstractNode
-
- com.icl.saxon.tree.NodeImpl
-
- com.icl.saxon.tree.ParentNodeImpl
-
- com.icl.saxon.tree.ElementImpl
-
- com.icl.saxon.tree.ElementWithAttributes
-
- All Implemented Interfaces:
NodeInfo
,javax.xml.transform.dom.DOMLocator
,javax.xml.transform.Source
,javax.xml.transform.SourceLocator
,org.w3c.dom.Element
,org.w3c.dom.NamedNodeMap
,org.w3c.dom.Node
- Direct Known Subclasses:
StyleElement
public class ElementWithAttributes extends ElementImpl implements org.w3c.dom.Element, org.w3c.dom.NamedNodeMap
A node in the XML parse tree representing an XML element.This class is an implementation of NodeInfo
- Version:
- 8 August 2000: separated from ElementImpl
- Author:
- Michael H. Kay
-
-
Field Summary
Fields Modifier and Type Field Description protected AttributeCollection
attributeList
protected int[]
namespaceList
-
Fields inherited from class com.icl.saxon.tree.ElementImpl
nameCode, root
-
Fields inherited from class com.icl.saxon.tree.ParentNodeImpl
sequence
-
Fields inherited from class com.icl.saxon.tree.NodeImpl
emptyArray, index, parent
-
Fields inherited from class com.icl.saxon.om.AbstractNode
NODE_LETTER
-
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
-
-
Constructor Summary
Constructors Constructor Description ElementWithAttributes()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addNamespaceNodes(ElementImpl owner, java.util.Vector list, boolean addXML)
Make the set of all namespace nodes associated with this element.void
copy(Outputter out, boolean allNamespaces)
Copy this node to a given outputter (supporting xsl:copy-of)java.lang.String
getAttribute(java.lang.String name)
Retrieves an attribute value by name.AttributeCollection
getAttributeList()
Get the attribute list for this element.org.w3c.dom.Attr
getAttributeNode(java.lang.String name)
Retrieves an attribute node by name.org.w3c.dom.Attr
getAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName)
Retrieves anAttr
node by local name and namespace URI.java.lang.String
getAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
Retrieves an attribute value by local name and namespace URI.org.w3c.dom.NamedNodeMap
getAttributes()
ANamedNodeMap
containing the attributes of this element.java.lang.String
getAttributeValue(int fingerprint)
Get the value of a given attribute of this nodejava.lang.String
getAttributeValue(java.lang.String name)
Find the value of a given attribute of this element.java.lang.String
getAttributeValue(java.lang.String uri, java.lang.String localName)
Find the value of a given attribute of this node.int
getLength()
Get number of attributes (DOM NamedNodeMap method).org.w3c.dom.Node
getNamedItem(java.lang.String name)
Get named attribute (DOM NamedNodeMap method) Treats namespace declarations as attributes.org.w3c.dom.Node
getNamedItemNS(java.lang.String uri, java.lang.String localName)
Get named attribute (DOM NamedNodeMap method) Treats namespace declarations as attributes.protected int[]
getNamespaceCodes()
Get the list of in-scope namespaces for this element as an array of namespace codes.java.lang.String
getPrefixForURI(java.lang.String uri)
Search the NamespaceList for a given URI, returning the corresponding prefix.short
getURICodeForPrefix(java.lang.String prefix)
Search the NamespaceList for a given prefix, returning the corresponding URI.boolean
hasAttribute(java.lang.String name)
Returnstrue
when an attribute with a given name is specified on this element or has a default value,false
otherwise.boolean
hasAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
Returnstrue
when an attribute with a given local name and namespace URI is specified on this element or has a default value,false
otherwise.boolean
hasAttributes()
Returns whether this node (if it is an element) has any attributes.void
initialise(int nameCode, AttributeCollection atts, NodeInfo parent, java.lang.String baseURI, int lineNumber, int sequenceNumber)
Initialise a new ElementWithAttributes with an element name and attribute listorg.w3c.dom.Node
item(int index)
Get n'th attribute (DOM NamedNodeMap method).void
outputNamespaceNodes(Outputter out, boolean includeAncestors)
Output all namespace nodes associated with this element.void
removeAttribute(java.lang.String name)
Removes an attribute by name.org.w3c.dom.Attr
removeAttributeNode(org.w3c.dom.Attr oldAttr)
Removes the specified attribute node.void
removeAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
Removes an attribute by local name and namespace URI.org.w3c.dom.Node
removeNamedItem(java.lang.String name)
Remove named attribute (DOM NamedNodeMap method: always fails)org.w3c.dom.Node
removeNamedItemNS(java.lang.String uri, java.lang.String localName)
Remove named attribute (DOM NamedNodeMap method: always fails)void
setAttribute(java.lang.String name, java.lang.String value)
Set the value of an attribute on the current element.org.w3c.dom.Attr
setAttributeNode(org.w3c.dom.Attr newAttr)
Adds a new attribute node.org.w3c.dom.Attr
setAttributeNodeNS(org.w3c.dom.Attr newAttr)
Add a new attribute.void
setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value)
Adds a new attribute.org.w3c.dom.Node
setNamedItem(org.w3c.dom.Node arg)
Set named attribute (DOM NamedNodeMap method: always fails)org.w3c.dom.Node
setNamedItemNS(org.w3c.dom.Node arg)
Set named attribute (DOM NamedNodeMap method: always fails)void
setNamespaceDeclarations(int[] namespaces, int namespacesUsed)
Set the namespace declarations for the element-
Methods inherited from class com.icl.saxon.tree.ElementImpl
copy, generateId, getBaseURI, getDocumentRoot, getLineNumber, getNameCode, getNodeType, getSystemId, makeNameCode, setLineNumber, setNameCode, setSystemId
-
Methods inherited from class com.icl.saxon.tree.ParentNodeImpl
addChild, compact, copyStringValue, dropChildren, enumerateChildren, getChildNodes, getFirstChild, getLastChild, getNodeValue, getNthChild, getSequenceNumber, getStringValue, hasChildNodes, removeChild, renumberChildren, useChildrenArray
-
Methods inherited from class com.icl.saxon.tree.NodeImpl
compareOrder, getDisplayName, getDocumentElement, getEnumeration, getFingerprint, getLocalName, getNamePool, getNextInDocument, getNextSibling, getOriginatingNode, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getURI, isSameNodeInfo, removeNode
-
Methods inherited from class com.icl.saxon.om.AbstractNode
appendChild, appendData, cloneNode, compareDocumentPosition, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, disallowUpdate, getColumnNumber, getData, getDoctype, getElementById, getElementsByTagName, getElementsByTagNameNS, getFeature, getImplementation, getName, getNamespaceURI, getNodeName, getOwnerDocument, getOwnerElement, getParentNode, getPublicId, getSchemaTypeInfo, getSpecified, getTagName, getTextContent, getUserData, getValue, getWholeText, importNode, insertBefore, insertData, isDefaultNamespace, isElementContentWhitespace, isEqualNode, isId, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, replaceData, replaceWholeText, setData, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setNodeValue, setPrefix, setTextContent, setUserData, setValue, splitText, substringData, supports
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.w3c.dom.Element
getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, setIdAttribute, setIdAttributeNode, setIdAttributeNS
-
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
-
-
-
-
Field Detail
-
attributeList
protected AttributeCollection attributeList
-
namespaceList
protected int[] namespaceList
-
-
Method Detail
-
initialise
public void initialise(int nameCode, AttributeCollection atts, NodeInfo parent, java.lang.String baseURI, int lineNumber, int sequenceNumber)
Initialise a new ElementWithAttributes with an element name and attribute list- Overrides:
initialise
in classElementImpl
- Parameters:
name
- The element name, with namespaces resolvedatts
- The attribute list, after namespace processingparent
- The parent node
-
setNamespaceDeclarations
public void setNamespaceDeclarations(int[] namespaces, int namespacesUsed)
Set the namespace declarations for the element
-
getURICodeForPrefix
public short getURICodeForPrefix(java.lang.String prefix) throws NamespaceException
Search the NamespaceList for a given prefix, returning the corresponding URI.- Overrides:
getURICodeForPrefix
in classElementImpl
- Parameters:
prefix
- The prefix to be matched. To find the default namespace, supply ""- Returns:
- The URI code corresponding to this namespace. If it is an unnamed default namespace, return Namespace.NULL_CODE.
- Throws:
NamespaceException
- if the prefix has not been declared on this NamespaceList.
-
getPrefixForURI
public java.lang.String getPrefixForURI(java.lang.String uri)
Search the NamespaceList for a given URI, returning the corresponding prefix.- Overrides:
getPrefixForURI
in classElementImpl
- Parameters:
uri
- The URI to be matched.- Returns:
- The prefix corresponding to this URI. If not found, return null. If there is more than one prefix matching the URI, the first one found is returned. If the URI matches the default namespace, return an empty string.
-
addNamespaceNodes
public void addNamespaceNodes(ElementImpl owner, java.util.Vector list, boolean addXML)
Make the set of all namespace nodes associated with this element.- Overrides:
addNamespaceNodes
in classElementImpl
- Parameters:
owner
- The element owning these namespace nodes.list
- a Vector containing NamespaceImpl objects representing the namespaces in scope for this element; the method appends nodes to this Vector, which should initially be empty. Note that the returned list will never contain the XML namespace (to get this, the NamespaceEnumeration class adds it itself). The list WILL include an entry for the undeclaration xmlns=""; again it is the job of NamespaceEnumeration to ignore this, since it doesn't represent a true namespace node.addXML
- Add a namespace node for the XML namespace
-
outputNamespaceNodes
public void outputNamespaceNodes(Outputter out, boolean includeAncestors) throws javax.xml.transform.TransformerException
Output all namespace nodes associated with this element.- Specified by:
outputNamespaceNodes
in interfaceNodeInfo
- Overrides:
outputNamespaceNodes
in classElementImpl
- Parameters:
out
- The relevant outputterincludeAncestors
- True if namespaces declared on ancestor elements must be output; false if it is known that these are already on the result tree- Throws:
javax.xml.transform.TransformerException
-
getNamespaceCodes
protected int[] getNamespaceCodes()
Get the list of in-scope namespaces for this element as an array of namespace codes. (Used by LiteralResultElement)
-
getAttributeList
public AttributeCollection getAttributeList()
Get the attribute list for this element.- Overrides:
getAttributeList
in classElementImpl
- Returns:
- The attribute list. This will not include any namespace attributes. The attribute names will be in expanded form, with prefixes replaced by URIs
-
hasAttributes
public boolean hasAttributes()
Returns whether this node (if it is an element) has any attributes.- Specified by:
hasAttributes
in interfaceorg.w3c.dom.Node
- Overrides:
hasAttributes
in classNodeImpl
- Returns:
true
if this node has any attributes,false
otherwise.- Since:
- DOM Level 2
-
getAttributeValue
public java.lang.String getAttributeValue(java.lang.String uri, java.lang.String localName)
Find the value of a given attribute of this node.
This method is defined on all nodes to meet XSL requirements, but for nodes other than elements it will always return null.- Specified by:
getAttributeValue
in interfaceNodeInfo
- Overrides:
getAttributeValue
in classNodeImpl
- Parameters:
uri
- the namespace uri of an attributelocalName
- the local name of an attribute- Returns:
- the value of the attribute, if it exists, otherwise null
-
getAttributeValue
public java.lang.String getAttributeValue(java.lang.String name)
Find the value of a given attribute of this element.
This is a short-cut method; the full capability to examine attributes is offered via the getAttributeList() method.
The attribute may either be one that was present in the original XML document, or one that has been set by the application using setAttribute().- Overrides:
getAttributeValue
in classElementImpl
- Parameters:
name
- the name of an attribute. There must be no prefix in the name.- Returns:
- the value of the attribute, if it exists, otherwise null
-
getAttributeValue
public java.lang.String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node- Specified by:
getAttributeValue
in interfaceNodeInfo
- Overrides:
getAttributeValue
in classNodeImpl
- Parameters:
fingerprint
- The fingerprint of the attribute name- Returns:
- the attribute value if it exists or null if not
-
setAttribute
public void setAttribute(java.lang.String name, java.lang.String value) throws org.w3c.dom.DOMException
Set the value of an attribute on the current element. This affects subsequent calls of getAttribute() for that element.- Specified by:
setAttribute
in interfaceorg.w3c.dom.Element
- Overrides:
setAttribute
in classElementImpl
- Parameters:
name
- The name of the attribute to be set. Any prefix is interpreted relative to the namespaces defined for this element.value
- The new value of the attribute. Set this to null to remove the attribute.- Throws:
org.w3c.dom.DOMException
- (always): Saxon trees are immutable.
-
copy
public void copy(Outputter out, boolean allNamespaces) throws javax.xml.transform.TransformerException
Copy this node to a given outputter (supporting xsl:copy-of)- Overrides:
copy
in classElementImpl
- Parameters:
out
- The outputterallNamespaces
- true if namespaces for ancestor nodes must be output- Throws:
javax.xml.transform.TransformerException
-
getAttribute
public java.lang.String getAttribute(java.lang.String name)
Retrieves an attribute value by name. Namespace declarations are not returned.- Specified by:
getAttribute
in interfaceorg.w3c.dom.Element
- Overrides:
getAttribute
in classAbstractNode
- Parameters:
name
- The name of the attribute to retrieve.- Returns:
- The
Attr
value as a string, or the empty string if that attribute does not have a specified or default value. (Note the difference from getAttributeValue(), which returns null if there is no value).
-
getAttributes
public org.w3c.dom.NamedNodeMap getAttributes()
ANamedNodeMap
containing the attributes of this element. This is a DOM method, so the list of attributes includes namespace declarations.- Specified by:
getAttributes
in interfaceorg.w3c.dom.Node
- Overrides:
getAttributes
in classNodeImpl
-
removeAttribute
public void removeAttribute(java.lang.String name)
Removes an attribute by name.- Specified by:
removeAttribute
in interfaceorg.w3c.dom.Element
- Overrides:
removeAttribute
in classAbstractNode
- Parameters:
name
- The name of the attribute to remove.
-
getAttributeNode
public org.w3c.dom.Attr getAttributeNode(java.lang.String name)
Retrieves an attribute node by name. Namespace declarations are not returned.
To retrieve an attribute node by qualified name and namespace URI, use thegetAttributeNodeNS
method.- Specified by:
getAttributeNode
in interfaceorg.w3c.dom.Element
- Overrides:
getAttributeNode
in classAbstractNode
- Parameters:
name
- The name (nodeName
) of the attribute to retrieve.- Returns:
- The
Attr
node with the specified name (nodeName
) ornull
if there is no such attribute.
-
setAttributeNode
public org.w3c.dom.Attr setAttributeNode(org.w3c.dom.Attr newAttr) throws org.w3c.dom.DOMException
Adds a new attribute node. Always fails- Specified by:
setAttributeNode
in interfaceorg.w3c.dom.Element
- Overrides:
setAttributeNode
in classAbstractNode
- Throws:
org.w3c.dom.DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
-
removeAttributeNode
public org.w3c.dom.Attr removeAttributeNode(org.w3c.dom.Attr oldAttr) throws org.w3c.dom.DOMException
Removes the specified attribute node. Always fails- Specified by:
removeAttributeNode
in interfaceorg.w3c.dom.Element
- Overrides:
removeAttributeNode
in classAbstractNode
- Throws:
org.w3c.dom.DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
-
getAttributeNS
public java.lang.String getAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
Retrieves an attribute value by local name and namespace URI. HTML-only DOM implementations do not need to implement this method.- Specified by:
getAttributeNS
in interfaceorg.w3c.dom.Element
- Overrides:
getAttributeNS
in classAbstractNode
- Parameters:
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.- Returns:
- The
Attr
value as a string, or the empty string if that attribute does not have a specified or default value. - Since:
- DOM Level 2
-
setAttributeNS
public void setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value) throws org.w3c.dom.DOMException
Adds a new attribute. Always fails.- Specified by:
setAttributeNS
in interfaceorg.w3c.dom.Element
- Overrides:
setAttributeNS
in classAbstractNode
- Parameters:
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.- Throws:
org.w3c.dom.DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
-
removeAttributeNS
public void removeAttributeNS(java.lang.String namespaceURI, java.lang.String localName) throws org.w3c.dom.DOMException
Removes an attribute by local name and namespace URI. Always fails- Specified by:
removeAttributeNS
in interfaceorg.w3c.dom.Element
- Overrides:
removeAttributeNS
in classAbstractNode
- Throws:
org.w3c.dom.DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.- Since:
- DOM Level 2
-
getAttributeNodeNS
public org.w3c.dom.Attr getAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName)
Retrieves anAttr
node by local name and namespace URI. DOM method, so namespace declarations count as attributes.- Specified by:
getAttributeNodeNS
in interfaceorg.w3c.dom.Element
- Overrides:
getAttributeNodeNS
in classAbstractNode
- Parameters:
namespaceURI
- The namespace URI of the attribute to retrieve.localName
- The local name of the attribute to retrieve.- Returns:
- The
Attr
node with the specified attribute local name and namespace URI ornull
if there is no such attribute. - Since:
- DOM Level 2
-
setAttributeNodeNS
public org.w3c.dom.Attr setAttributeNodeNS(org.w3c.dom.Attr newAttr) throws org.w3c.dom.DOMException
Add a new attribute. Always fails.- Specified by:
setAttributeNodeNS
in interfaceorg.w3c.dom.Element
- Overrides:
setAttributeNodeNS
in classAbstractNode
- Parameters:
newAttr
- TheAttr
node to add to the attribute list.- Returns:
- If the
newAttr
attribute replaces an existing attribute with the same local name and namespace URI , the replacedAttr
node is returned, otherwisenull
is returned. - Throws:
org.w3c.dom.DOMException
-
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.- Since:
- DOM Level 2
-
hasAttribute
public boolean hasAttribute(java.lang.String name)
Returnstrue
when an attribute with a given name is specified on this element or has a default value,false
otherwise. Namespace declarations are not included.- Specified by:
hasAttribute
in interfaceorg.w3c.dom.Element
- Overrides:
hasAttribute
in classAbstractNode
- Parameters:
name
- The name of the attribute to look for.- Returns:
true
if an attribute with the given name is specified on this element or has a default value,false
otherwise.- Since:
- DOM Level 2
-
hasAttributeNS
public boolean hasAttributeNS(java.lang.String namespaceURI, java.lang.String localName)
Returnstrue
when an attribute with a given local name and namespace URI is specified on this element or has a default value,false
otherwise. This is a DOM method so namespace declarations are treated as attributes.- Specified by:
hasAttributeNS
in interfaceorg.w3c.dom.Element
- Overrides:
hasAttributeNS
in classAbstractNode
- Parameters:
namespaceURI
- The namespace URI of the attribute to look for.localName
- The local name of the attribute to look for.- Returns:
true
if an attribute with the given local name and namespace URI is specified or has a default value on this element,false
otherwise.- Since:
- DOM Level 2
-
getNamedItem
public org.w3c.dom.Node getNamedItem(java.lang.String name)
Get named attribute (DOM NamedNodeMap method) Treats namespace declarations as attributes.- Specified by:
getNamedItem
in interfaceorg.w3c.dom.NamedNodeMap
-
setNamedItem
public org.w3c.dom.Node setNamedItem(org.w3c.dom.Node arg) throws org.w3c.dom.DOMException
Set named attribute (DOM NamedNodeMap method: always fails)- Specified by:
setNamedItem
in interfaceorg.w3c.dom.NamedNodeMap
- Throws:
org.w3c.dom.DOMException
-
removeNamedItem
public org.w3c.dom.Node removeNamedItem(java.lang.String name) throws org.w3c.dom.DOMException
Remove named attribute (DOM NamedNodeMap method: always fails)- Specified by:
removeNamedItem
in interfaceorg.w3c.dom.NamedNodeMap
- Throws:
org.w3c.dom.DOMException
-
item
public org.w3c.dom.Node item(int index)
Get n'th attribute (DOM NamedNodeMap method). Namespace declarations are not returned.- Specified by:
item
in interfaceorg.w3c.dom.NamedNodeMap
-
getLength
public int getLength()
Get number of attributes (DOM NamedNodeMap method). Treats namespace declarations as attributes.- Specified by:
getLength
in interfaceorg.w3c.dom.NamedNodeMap
- Overrides:
getLength
in classAbstractNode
-
getNamedItemNS
public org.w3c.dom.Node getNamedItemNS(java.lang.String uri, java.lang.String localName)
Get named attribute (DOM NamedNodeMap method) Treats namespace declarations as attributes.- Specified by:
getNamedItemNS
in interfaceorg.w3c.dom.NamedNodeMap
-
setNamedItemNS
public org.w3c.dom.Node setNamedItemNS(org.w3c.dom.Node arg) throws org.w3c.dom.DOMException
Set named attribute (DOM NamedNodeMap method: always fails)- Specified by:
setNamedItemNS
in interfaceorg.w3c.dom.NamedNodeMap
- Throws:
org.w3c.dom.DOMException
-
removeNamedItemNS
public org.w3c.dom.Node removeNamedItemNS(java.lang.String uri, java.lang.String localName) throws org.w3c.dom.DOMException
Remove named attribute (DOM NamedNodeMap method: always fails)- Specified by:
removeNamedItemNS
in interfaceorg.w3c.dom.NamedNodeMap
- Throws:
org.w3c.dom.DOMException
-
-