Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
net.sf.saxon.dom.NodeOverNodeInfo
net.sf.saxon.dom.DocumentOverNodeInfo
Field Summary |
Fields inherited from class net.sf.saxon.dom.NodeOverNodeInfo | |
node |
Method Summary | |
Node |
|
Attr |
|
Attr |
|
CDATASection |
|
Comment |
|
DocumentFragment |
|
Element |
|
Element |
|
EntityReference |
|
ProcessingInstruction |
|
Text |
|
DocumentType |
|
Element |
|
String |
|
DOMConfiguration |
|
Element |
|
NodeList |
|
protected static NodeList |
|
NodeList |
|
static NodeList |
|
DOMImplementation |
|
String |
|
boolean |
|
String |
|
boolean |
|
String |
|
Node |
|
void |
|
Node |
|
void |
|
void |
|
void |
|
void |
|
public Node adoptNode(Node source) throws DOMException
Attempts to adopt a node from another document to this document. If supported, it changes theownerDocument
of the source node, its children, as well as the attached attribute nodes if there are any. If the source node has a parent it is first removed from the child list of its parent. This effectively allows moving a subtree from one document to another (unlikeimportNode()
which create a copy of the source node instead of moving it). When it fails, applications should useDocument.importNode()
instead. Note that if the adopted node is already part of this document (i.e. the source and target document are the same), this method still has the effect of removing the source node from the child list of its parent, if any. The following list describes the specifics for each type of node.Note: Since it does not create new nodes unlike the
ownerElement
null
specified
true
Attr
Attr
Document
DocumentType
- Specified
Entity
EntityReference
Notation
Document.importNode()
method, this method does not raise anINVALID_CHARACTER_ERR
exception, and applications should use theDocument.normalizeDocument()
method to check if an imported name is not an XML name according to the XML version in use.
- Parameters:
source
- The node to move into this document.
- Returns:
- The adopted node, or
null
if this operation fails, such as when the source node comes from a different implementation.
- Since:
- DOM Level 3
public Attr createAttribute(String name) throws DOMException
Create anAttr
of the given name. DOM method: always fails, because the Saxon tree is not updateable.
- Parameters:
name
- The name of the attribute.
- Returns:
- A new
Attr
object with thenodeName
attribute set toname
, andlocalName
,prefix
, andnamespaceURI
set tonull
.
public Attr createAttributeNS(String namespaceURI, String qualifiedName) throws DOMException
Create an attribute of the given qualified name and namespace URI. HTML-only DOM implementations do not need to implement this method. DOM method: returns null, because the Saxon tree is not updateable.
- Parameters:
namespaceURI
- The namespace URI of the attribute to create.qualifiedName
- The qualified name of the attribute to instantiate.
- Returns:
- A new
Attr
object.
public CDATASection createCDATASection(String data) throws DOMException
Create aCDATASection
node whose value is the specified string. DOM method: always fails, because the Saxon tree is not updateable.
- Parameters:
data
- The data for theCDATASection
contents.
- Returns:
- The new
CDATASection
object.
public Comment createComment(String data)
Create aComment
node given the specified string. DOM method: returns null, because the Saxon tree is not updateable.
- Parameters:
data
- The data for the node.
- Returns:
- The new
Comment
object.
public DocumentFragment createDocumentFragment()
Creates an emptyDocumentFragment
object.
- Returns:
- A new
DocumentFragment
. DOM method: returns null, because the Saxon tree is not updateable.
public Element createElement(String tagName) throws DOMException
Creates an element of the type specified. DOM method: always fails, because the Saxon tree is not updateable.
public Element createElementNS(String namespaceURI, String qualifiedName) throws DOMException
Create an element of the given qualified name and namespace URI. HTML-only DOM implementations do not need to implement this method. DOM method: always fails, because the Saxon tree is not updateable.
- Parameters:
namespaceURI
- The namespace URI of the element to create.qualifiedName
- The qualified name of the element type to instantiate.
- Returns:
- A new
Element
object
public EntityReference createEntityReference(String name) throws DOMException
Create anEntityReference
object. DOM method: returns null, because the Saxon tree is not updateable.
- Parameters:
name
- The name of the entity to reference.
- Returns:
- The new
EntityReference
object.
public ProcessingInstruction createProcessingInstruction(String target, String data) throws DOMException
Create aProcessingInstruction
node given the specified name and data strings. DOM method: returns null, because the Saxon tree is not updateable.
- Parameters:
target
- The target part of the processing instruction.data
- The data for the node.
- Returns:
- The new
ProcessingInstruction
object.
public Text createTextNode(String data)
Create aText
node given the specified string. DOM method: returns null, because the Saxon tree is not updateable.
- Parameters:
data
- The data for the node.
- Returns:
- The new
Text
object.
public DocumentType getDoctype()
Get the Document Type Declaration (seeDocumentType
) associated with this document. For HTML documents as well as XML documents without a document type declaration this returnsnull
. DOM method.
- Returns:
- null: The Saxon tree model does not include the document type information.
public Element getDocumentElement()
Get the outermost element of a document.
- Returns:
- the Element for the outermost element of the document. If the document is not well-formed, this returns the first element child of the root if there is one, otherwise null.
public String getDocumentURI()
The location of the document ornull
if undefined or if theDocument
was created usingDOMImplementation.createDocument
. No lexical checking is performed when setting this attribute; this could result in anull
value returned when usingNode.baseURI
.
Beware that when theDocument
supports the feature "HTML" [DOM Level 2 HTML] , the href attribute of the HTML BASE element takes precedence over this attribute when computingNode.baseURI
.
- Since:
- DOM Level 3
public DOMConfiguration getDomConfig()
The configuration used whenDocument.normalizeDocument()
is invoked.
- Since:
- DOM Level 3
public Element getElementById(String elementId)
Return theElement
whoseID
is given byelementId
. If no such element exists, returnsnull
. Behavior is not defined if more than one element has thisID
. The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to returnnull
.
- Parameters:
elementId
- The uniqueid
value for an element.
- Returns:
- The matching element, or null if there is none.
- Since:
- DOM Level 2
public NodeList getElementsByTagName(String tagname)
Return aNodeList
of all theElements
with a given tag name in the order in which they are encountered in a preorder traversal of theDocument
tree.
- Parameters:
tagname
- The name of the tag to match on. The special value "*" matches all tags.
- Returns:
- A new
NodeList
object containing all the matchedElements
.
public NodeList getElementsByTagNameNS(String namespaceURI, String localName)
Return aNodeList
of all theElements
with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of theDocument
tree. DOM method.
- Parameters:
namespaceURI
- The namespace URI of the elements to match on. The special value "*" matches all namespaces. The value null matches elements not in any namespacelocalName
- The local name of the elements to match on. The special value "*" matches all local names.
- Returns:
- A new
NodeList
object containing all the matchedElements
.
- Since:
- DOM Level 2
public static NodeList getElementsByTagNameNS(NodeInfo node, String namespaceURI, String localName)
public DOMImplementation getImplementation()
Get aDOMImplementation
object that handles this document. A DOM application may use objects from multiple implementations. DOM method.
public String getInputEncoding()
An attribute specifying the encoding used for this document at the time of the parsing. This isnull
when it is not known, such as when theDocument
was created in memory.
- Since:
- DOM Level 3
public boolean getStrictErrorChecking()
An attribute specifying whether error checking is enforced or not. When set tofalse
, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise anyDOMException
on DOM operations or report errors while usingDocument.normalizeDocument()
. In case of error, the behavior is undefined. This attribute istrue
by default.
- Since:
- DOM Level 3
public String getXmlEncoding()
An attribute specifying, as part of the XML declaration, the encoding of this document. This isnull
when unspecified or when it is not known, such as when theDocument
was created in memory.
- Since:
- DOM Level 3
public boolean getXmlStandalone()
An attribute specifying, as part of the XML declaration, whether this document is standalone. This isfalse
when unspecified. Note: No verification is done on the value when setting this attribute. Applications should useDocument.normalizeDocument()
with the "validate" parameter to verify if the value matches the validity constraint for standalone document declaration as defined in [XML 1.0].
- Since:
- DOM Level 3
public String getXmlVersion()
An attribute specifying, as part of the XML declaration, the version number of this document. If there is no declaration and if this document supports the "XML" feature, the value is"1.0"
. If this document does not support the "XML" feature, the value is alwaysnull
. Changing this attribute will affect methods that check for invalid characters in XML names. Application should invokeDocument.normalizeDocument()
in order to check for invalid characters in theNode
s that are already part of thisDocument
.
DOM applications may use theDOMImplementation.hasFeature(feature, version)
method with parameter values "XMLVersion" and "1.0" (respectively) to determine if an implementation supports [XML 1.0]. DOM applications may use the same method with parameter values "XMLVersion" and "1.1" (respectively) to determine if an implementation supports [XML 1.1]. In both cases, in order to support XML, an implementation must also support the "XML" feature defined in this specification.Document
objects supporting a version of the "XMLVersion" feature must not raise aNOT_SUPPORTED_ERR
exception for the same version number when usingDocument.xmlVersion
.
- Since:
- DOM Level 3
public Node importNode(Node importedNode, boolean deep) throws DOMException
Import a node from another document to this document. DOM method: always fails, because the Saxon tree is not updateable.
- Since:
- DOM Level 2
public void normalizeDocument()
This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form. As a consequence, this method updates the replacement tree ofEntityReference
nodes and normalizesText
nodes, as defined in the methodNode.normalize()
.
Otherwise, the actual result depends on the features being set on theDocument.domConfig
object and governing what operations actually take place. Noticeably this method could also make the document namespace well-formed according to the algorithm described in , check the character normalization, remove theCDATASection
nodes, etc. SeeDOMConfiguration
for details.// Keep in the document the information defined // in the XML Information Set (Java example) DOMConfiguration docConfig = myDocument.getDomConfig(); docConfig.setParameter("infoset", Boolean.TRUE); myDocument.normalizeDocument();
Mutation events, when supported, are generated to reflect the changes occurring on the document.
If errors occur during the invocation of this method, such as an attempt to update a read-only node or aNode.nodeName
contains an invalid character according to the XML version in use, errors or warnings (DOMError.SEVERITY_ERROR
orDOMError.SEVERITY_WARNING
) will be reported using theDOMErrorHandler
object associated with the "error-handler " parameter. Note this method might also report fatal errors (DOMError.SEVERITY_FATAL_ERROR
) if an implementation cannot recover from an error.
- Since:
- DOM Level 3
public Node renameNode(Node n, String namespaceURI, String qualifiedName) throws DOMException
Rename an existing node of typeELEMENT_NODE
orATTRIBUTE_NODE
. Not supported in this implementation
- Parameters:
n
- The node to rename.namespaceURI
- The new namespace URI.qualifiedName
- The new qualified name.
- Returns:
- The renamed node. This is either the specified node or the new node that was created to replace the specified node.
public void setDocumentURI(String documentURI)
The location of the document ornull
if undefined or if theDocument
was created usingDOMImplementation.createDocument
. No lexical checking is performed when setting this attribute; this could result in anull
value returned when usingNode.baseURI
.
Beware that when theDocument
supports the feature "HTML" [DOM Level 2 HTML] , the href attribute of the HTML BASE element takes precedence over this attribute when computingNode.baseURI
.
- Since:
- DOM Level 3
public void setStrictErrorChecking(boolean strictErrorChecking)
An attribute specifying whether error checking is enforced or not. When set tofalse
, the implementation is free to not test every possible error case normally defined on DOM operations, and not raise anyDOMException
on DOM operations or report errors while usingDocument.normalizeDocument()
. In case of error, the behavior is undefined. This attribute istrue
by default.
- Since:
- DOM Level 3
public void setXmlStandalone(boolean xmlStandalone) throws DOMException
An attribute specifying, as part of the XML declaration, whether this document is standalone. This isfalse
when unspecified. Note: No verification is done on the value when setting this attribute. Applications should useDocument.normalizeDocument()
with the "validate" parameter to verify if the value matches the validity constraint for standalone document declaration as defined in [XML 1.0].
- Since:
- DOM Level 3
public void setXmlVersion(String xmlVersion) throws DOMException
An attribute specifying, as part of the XML declaration, the version number of this document. If there is no declaration and if this document supports the "XML" feature, the value is"1.0"
. If this document does not support the "XML" feature, the value is alwaysnull
. Changing this attribute will affect methods that check for invalid characters in XML names. Application should invokeDocument.normalizeDocument()
in order to check for invalid characters in theNode
s that are already part of thisDocument
.
DOM applications may use theDOMImplementation.hasFeature(feature, version)
method with parameter values "XMLVersion" and "1.0" (respectively) to determine if an implementation supports [XML 1.0]. DOM applications may use the same method with parameter values "XMLVersion" and "1.1" (respectively) to determine if an implementation supports [XML 1.1]. In both cases, in order to support XML, an implementation must also support the "XML" feature defined in this specification.Document
objects supporting a version of the "XMLVersion" feature must not raise aNOT_SUPPORTED_ERR
exception for the same version number when usingDocument.xmlVersion
.
- Since:
- DOM Level 3