Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
gnu.xml.libxmlj.dom.GnomeNode
gnu.xml.libxmlj.dom.GnomeDocument
public class GnomeDocument
extends gnu.xml.libxmlj.dom.GnomeNode
implements Document, DOMConfiguration, XPathEvaluator, DocumentTraversal
Method Summary | |
Node | |
boolean |
|
Attr |
|
Attr |
|
CDATASection |
|
Comment |
|
DocumentFragment |
|
DocumentType |
|
Element |
|
Element |
|
EntityReference |
|
XPathExpression |
|
XPathNSResolver |
|
NodeIterator |
|
ProcessingInstruction |
|
Text |
|
TreeWalker |
|
Object |
|
protected void |
|
DocumentType |
|
Element |
|
String |
|
DOMConfiguration |
|
Element |
|
NodeList |
|
NodeList |
|
DOMImplementation |
|
String |
|
Object |
|
DOMStringList | |
boolean |
|
String |
|
boolean |
|
String |
|
Node |
|
void |
|
Node |
|
void |
|
void |
|
void |
|
void |
|
void |
|
String |
|
Methods inherited from class gnu.xml.libxmlj.dom.GnomeNode | |
appendChild , cloneNode , compareDocumentPosition , compareTo , equals , getAttributes , getBaseURI , getChildNodes , getFeature , getFirstChild , getLastChild , getLocalName , getNamespaceURI , getNextSibling , getNodeName , getNodeType , getNodeValue , getOwnerDocument , getParentNode , getPrefix , getPreviousSibling , getTextContent , getUserData , hasAttributes , hasChildNodes , hashCode , insertBefore , isDefaultNamespace , isEqualNode , isSameNode , isSupported , lookupNamespaceURI , lookupPrefix , normalize , removeChild , replaceChild , setNodeValue , setPrefix , setTextContent , setUserData , toString |
Methods inherited from class java.lang.Object | |
clone , equals , extends Object> getClass , finalize , hashCode , notify , notifyAll , toString , wait , wait , wait |
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.
ownerElement
null
specified
true
Attr
Attr
Document
DocumentType
- Specified
Entity
EntityReference
Notation
Note: Since it does not create new nodes unlike the
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.
- Throws:
DOMException
- NOT_SUPPORTED_ERR: Raised if the source node is of typeDOCUMENT
,DOCUMENT_TYPE
.
NO_MODIFICATION_ALLOWED_ERR: Raised when the source node is readonly.
- Since:
- DOM Level 3
public boolean canSetParameter(String name, Object value)
- Specified by:
- canSetParameter in interface DOMConfiguration
public Attr createAttribute(String name) throws DOMException
Creates anAttr
of the given name. Note that theAttr
instance can then be set on anElement
using thesetAttributeNode
method.
To create an attribute with a qualified name and namespace URI, use thecreateAttributeNS
method.
- Specified by:
- createAttribute in interface Document
- Parameters:
name
- The name of the attribute.
- Returns:
- A new
Attr
object with thenodeName
attribute set toname
, andlocalName
,prefix
, andnamespaceURI
set tonull
. The value of the attribute is the empty string.
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
public Attr createAttributeNS(String namespaceURI, String qualifiedName) throws DOMException
Creates an attribute of the given qualified name and namespace URI.
Per [XML Namespaces] , applications must use the valuenull
as thenamespaceURI
parameter for methods if they wish to have no namespace.
- Specified by:
- createAttributeNS in interface Document
- Parameters:
namespaceURI
- The namespace URI of the attribute to create.qualifiedName
- The qualified name of the attribute to instantiate.
- Returns:
- A new
Attr
object with the following attributes:
Attribute Value Node.nodeName
qualifiedName Node.namespaceURI
namespaceURI
Node.prefix
prefix, extracted from qualifiedName
, ornull
if there is no prefixNode.localName
local name, extracted from qualifiedName
Attr.name
qualifiedName
Node.nodeValue
the empty string
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specifiedqualifiedName
is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
NAMESPACE_ERR: Raised if thequalifiedName
is a malformed qualified name, if thequalifiedName
has a prefix and thenamespaceURI
isnull
, if thequalifiedName
has a prefix that is "xml" and thenamespaceURI
is different from " http://www.w3.org/XML/1998/namespace", if thequalifiedName
or its prefix is "xmlns" and thenamespaceURI
is different from "http://www.w3.org/2000/xmlns/", or if thenamespaceURI
is "http://www.w3.org/2000/xmlns/" and neither thequalifiedName
nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the"XML"
feature, since namespaces were defined by XML.
- Since:
- DOM Level 2
public CDATASection createCDATASection(String data) throws DOMException
Creates aCDATASection
node whose value is the specified string.
- Specified by:
- createCDATASection in interface Document
- Parameters:
data
- The data for theCDATASection
contents.
- Returns:
- The new
CDATASection
object.
- Throws:
DOMException
- NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
public Comment createComment(String data)
Creates aComment
node given the specified string.
- Specified by:
- createComment in interface Document
- Parameters:
data
- The data for the node.
- Returns:
- The new
Comment
object.
public DocumentFragment createDocumentFragment()
Creates an emptyDocumentFragment
object.
- Specified by:
- createDocumentFragment in interface Document
- Returns:
- A new
DocumentFragment
.
public DocumentType createDocumentType(String name, String publicId, String systemId)
public Element createElement(String tagName) throws DOMException
Creates an element of the type specified. Note that the instance returned implements theElement
interface, so attributes can be specified directly on the returned object.
In addition, if there are known attributes with default values,Attr
nodes representing them are automatically created and attached to the element.
To create an element with a qualified name and namespace URI, use thecreateElementNS
method.
- Specified by:
- createElement in interface Document
- Parameters:
tagName
- The name of the element type to instantiate. For XML, this is case-sensitive, otherwise it depends on the case-sensitivity of the markup language in use. In that case, the name is mapped to the canonical form of that markup by the DOM implementation.
- Returns:
- A new
Element
object with thenodeName
attribute set totagName
, andlocalName
,prefix
, andnamespaceURI
set tonull
.
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
public Element createElementNS(String namespaceURI, String qualifiedName) throws DOMException
Creates an element of the given qualified name and namespace URI.
Per [XML Namespaces] , applications must use the valuenull
as the namespaceURI parameter for methods if they wish to have no namespace.
- Specified by:
- createElementNS in interface Document
- 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 with the following attributes:
Attribute Value Node.nodeName
qualifiedName
Node.namespaceURI
namespaceURI
Node.prefix
prefix, extracted from qualifiedName
, ornull
if there is no prefixNode.localName
local name, extracted from qualifiedName
Element.tagName
qualifiedName
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specifiedqualifiedName
is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
NAMESPACE_ERR: Raised if thequalifiedName
is a malformed qualified name, if thequalifiedName
has a prefix and thenamespaceURI
isnull
, or if thequalifiedName
has a prefix that is "xml" and thenamespaceURI
is different from " http://www.w3.org/XML/1998/namespace" [XML Namespaces] , or if thequalifiedName
or its prefix is "xmlns" and thenamespaceURI
is different from "http://www.w3.org/2000/xmlns/", or if thenamespaceURI
is "http://www.w3.org/2000/xmlns/" and neither thequalifiedName
nor its prefix is "xmlns".
NOT_SUPPORTED_ERR: Always thrown if the current document does not support the"XML"
feature, since namespaces were defined by XML.
- Since:
- DOM Level 2
public EntityReference createEntityReference(String name) throws DOMException
Creates anEntityReference
object. In addition, if the referenced entity is known, the child list of theEntityReference
node is made the same as that of the correspondingEntity
node.Note: If any descendant of the
Entity
node has an unbound namespace prefix, the corresponding descendant of the createdEntityReference
node is also unbound; (itsnamespaceURI
isnull
). The DOM Level 2 and 3 do not support any mechanism to resolve namespace prefixes in this case.
- Specified by:
- createEntityReference in interface Document
- Parameters:
name
- The name of the entity to reference.UnlikeDocument.createElementNS
orDocument.createAttributeNS
, no namespace well-formed checking is done on the entity name. Applications should invokeDocument.normalizeDocument()
with the parameter " namespaces" set totrue
in order to ensure that the entity name is namespace well-formed.
- Returns:
- The new
EntityReference
object.
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
public XPathExpression createExpression(String expression, XPathNSResolver resolver) throws XPathException, DOMException
Creates a parsed XPath expression with resolved namespaces. This is useful when an expression will be reused in an application since it makes it possible to compile the expression string into a more efficient internal form and preresolve all namespace prefixes which occur within the expression.
- Specified by:
- createExpression in interface XPathEvaluator
- Parameters:
expression
- The XPath expression string to be parsed.resolver
- Theresolver
permits translation of all prefixes, including thexml
namespace prefix, within the XPath expression into appropriate namespace URIs. If this is specified asnull
, any namespace prefix within the expression will result inDOMException
being thrown with the codeNAMESPACE_ERR
.
- Returns:
- The compiled form of the XPath expression.
- Throws:
XPathException
- INVALID_EXPRESSION_ERR: Raised if the expression is not legal according to the rules of theXPathEvaluator
.DOMException
- NAMESPACE_ERR: Raised if the expression contains namespace prefixes which cannot be resolved by the specifiedXPathNSResolver
.
public XPathNSResolver createNSResolver(Node nodeResolver)
Adapts any DOM node to resolve namespaces so that an XPath expression can be easily evaluated relative to the context of the node where it appeared within the document. This adapter works like the DOM Level 3 methodlookupNamespaceURI
on nodes in resolving the namespaceURI from a given prefix using the current information available in the node's hierarchy at the time lookupNamespaceURI is called. also correctly resolving the implicit xml prefix.
- Specified by:
- createNSResolver in interface XPathEvaluator
- Parameters:
nodeResolver
- The node to be used as a context for namespace resolution.
- Returns:
XPathNSResolver
which resolves namespaces with respect to the definitions in scope for a specified node.
public NodeIterator createNodeIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) throws DOMException
- Specified by:
- createNodeIterator in interface DocumentTraversal
public ProcessingInstruction createProcessingInstruction(String target, String data) throws DOMException
Creates aProcessingInstruction
node given the specified name and data strings.
- Specified by:
- createProcessingInstruction in interface Document
- Parameters:
target
- The target part of the processing instruction.UnlikeDocument.createElementNS
orDocument.createAttributeNS
, no namespace well-formed checking is done on the target name. Applications should invokeDocument.normalizeDocument()
with the parameter " namespaces" set totrue
in order to ensure that the target name is namespace well-formed.data
- The data for the node.
- Returns:
- The new
ProcessingInstruction
object.
- Throws:
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified target is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
public Text createTextNode(String data)
Creates aText
node given the specified string.
- Specified by:
- createTextNode in interface Document
- Parameters:
data
- The data for the node.
- Returns:
- The new
Text
object.
public TreeWalker createTreeWalker(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) throws DOMException
- Specified by:
- createTreeWalker in interface DocumentTraversal
public Object evaluate(String expression, Node contextNode, XPathNSResolver resolver, short type, Object result) throws XPathException, DOMException
Evaluates an XPath expression string and returns a result of the specified type if possible.
- Specified by:
- evaluate in interface XPathEvaluator
- Parameters:
expression
- The XPath expression string to be parsed and evaluated.contextNode
- Thecontext
is context node for the evaluation of this XPath expression. If the XPathEvaluator was obtained by casting theDocument
then this must be owned by the same document and must be aDocument
,Element
,Attribute
,Text
,CDATASection
,Comment
,ProcessingInstruction
, orXPathNamespace
node. If the context node is aText
or aCDATASection
, then the context is interpreted as the whole logical text node as seen by XPath, unless the node is empty in which case it may not serve as the XPath context.resolver
- Theresolver
permits translation of all prefixes, including thexml
namespace prefix, within the XPath expression into appropriate namespace URIs. If this is specified asnull
, any namespace prefix within the expression will result inDOMException
being thrown with the codeNAMESPACE_ERR
.type
- If a specifictype
is specified, then the result will be returned as the corresponding type.For XPath 1.0 results, this must be one of the codes of theXPathResult
interface.result
- Theresult
specifies a specific result object which may be reused and returned by this method. If this is specified asnull
or the implementation does not reuse the specified result, a new result object will be constructed and returned.For XPath 1.0 results, this object will be of typeXPathResult
.
- Returns:
- The result of the evaluation of the XPath expression.For XPath 1.0 results, this object will be of type
XPathResult
.
- Throws:
XPathException
- INVALID_EXPRESSION_ERR: Raised if the expression is not legal according to the rules of theXPathEvaluator
i
TYPE_ERR: Raised if the result cannot be converted to return the specified type.DOMException
- NAMESPACE_ERR: Raised if the expression contains namespace prefixes which cannot be resolved by the specifiedXPathNSResolver
.
WRONG_DOCUMENT_ERR: The Node is from a document that is not supported by thisXPathEvaluator
.
NOT_SUPPORTED_ERR: The Node is not a type permitted as an XPath context node or the request type is not permitted by thisXPathEvaluator
.
protected void finalize()
Called on an object by the Virtual Machine at most once, at some point after the Object is determined unreachable but before it is destroyed. You would think that this means it eventually is called on every Object, but this is not necessarily the case. If execution terminates abnormally, garbage collection does not always happen. Thus you cannot rely on this method to always work. For finer control over garbage collection, use references from thejava.lang.ref
package.Virtual Machines are free to not call this method if they can determine that it does nothing important; for example, if your class extends Object and overrides finalize to do simply
super.finalize()
.finalize() will be called by a
Thread
that has no locks on any Objects, and may be called concurrently. There are no guarantees on the order in which multiple objects are finalized. This means that finalize() is usually unsuited for performing actions that must be thread-safe, and that your implementation must be use defensive programming if it is to always work.If an Exception is thrown from finalize() during garbage collection, it will be patently ignored and the Object will still be destroyed.
It is allowed, although not typical, for user code to call finalize() directly. User invocation does not affect whether automatic invocation will occur. It is also permitted, although not recommended, for a finalize() method to "revive" an object by making it reachable from normal code again.
Unlike constructors, finalize() does not get called for an object's superclass unless the implementation specifically calls
super.finalize()
.The default implementation does nothing.
- See Also:
System.gc()
,System.runFinalizersOnExit(boolean)
,java.lang.ref
public DocumentType getDoctype()
The Document Type Declaration (seeDocumentType
) associated with this document. For XML documents without a document type declaration this returnsnull
. For HTML documents, aDocumentType
object may be returned, independently of the presence or absence of document type declaration in the HTML document.
This provides direct access to theDocumentType
node, child node of thisDocument
. This node can be set at document creation time and later changed through the use of child nodes manipulation methods, such asNode.insertBefore
, orNode.replaceChild
. Note, however, that while some implementations may instantiate different types ofDocument
objects supporting additional features than the "Core", such as "HTML" [DOM Level 2 HTML] , based on theDocumentType
specified at creation time, changing it afterwards is very unlikely to result in a change of the features supported.
- Specified by:
- getDoctype in interface Document
public Element getDocumentElement()
This is a convenience attribute that allows direct access to the child node that is the document element of the document.
- Specified by:
- getDocumentElement in interface Document
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
.
- Specified by:
- getDocumentURI in interface Document
- Since:
- DOM Level 3
public DOMConfiguration getDomConfig()
The configuration used whenDocument.normalizeDocument()
is invoked.
- Specified by:
- getDomConfig in interface Document
- Since:
- DOM Level 3
public Element getElementById(String elementId)
Returns theElement
that has an ID attribute with the given value. If no such element exists, this returnsnull
. If more than one element has an ID attribute with that value, what is returned is undefined.
The DOM implementation is expected to use the attributeAttr.isId
to determine if an attribute is of type ID.Note: Attributes with the name "ID" or "id" are not of type ID unless so defined.
- Specified by:
- getElementById in interface Document
- 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)
Returns aNodeList
of all theElements
in document order with a given tag name and are contained in the document.
- Specified by:
- getElementsByTagName in interface Document
- Parameters:
- Returns:
- A new
NodeList
object containing all the matchedElements
.
public NodeList getElementsByTagNameNS(String namespaceURI, String localName)
Returns aNodeList
of all theElements
with a given local name and namespace URI in document order.
- Specified by:
- getElementsByTagNameNS in interface Document
- Parameters:
namespaceURI
- The namespace URI of the elements to match on. The special value"*"
matches all namespaces.localName
- 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 DOMImplementation getImplementation()
TheDOMImplementation
object that handles this document. A DOM application may use objects from multiple implementations.
- Specified by:
- getImplementation in interface Document
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.
- Specified by:
- getInputEncoding in interface Document
- Since:
- DOM Level 3
public Object getParameter(String name) throws DOMException
- Specified by:
- getParameter in interface DOMConfiguration
public DOMStringList getParameterNames()
- Specified by:
- getParameterNames in interface DOMConfiguration
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.
- Specified by:
- getStrictErrorChecking in interface Document
- 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.
- Specified by:
- getXmlEncoding in interface Document
- 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 use
Document.normalizeDocument()
with the "validate" parameter to verify if the value matches the validity constraint for standalone document declaration as defined in [XML 1.0].
- Specified by:
- getXmlStandalone in interface Document
- 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
.
- Specified by:
- getXmlVersion in interface Document
- Since:
- DOM Level 3
public Node importNode(Node importedNode, boolean deep) throws DOMException
Imports a node from another document to this document, without altering or removing the source node from the original document; this method creates a new copy of the source node. The returned node has no parent; (parentNode
isnull
).
For all nodes, importing a node creates a node object owned by the importing document, with attribute values identical to the source node'snodeName
andnodeType
, plus the attributes related to namespaces (prefix
,localName
, andnamespaceURI
). As in thecloneNode
operation, the source node is not altered. User data associated to the imported node is not carried over. However, if anyUserDataHandlers
has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
Additional information is copied as appropriate to thenodeType
, attempting to mirror the behavior expected if a fragment of XML or HTML source was copied from one document to another, recognizing that the two documents may have different DTDs in the XML case. The following list describes the specifics for each type of node.
ownerElement
null
specified
true
Attr
Attr
deep
Attr
deep
true
DocumentFragment
DocumentFragment
DocumentFragment
Document
DocumentType
- Specified
Attr
Element
notimportNode
deep
true
Entity
DocumentType
DocumentType
publicId
systemId
notationName
deep
Entity
EntityReference
deep
Notation
DocumentType
DocumentType
publicId
systemId
deep
target
data
deep
CharacterData
data
length
deep
- Specified by:
- importNode in interface Document
- Parameters:
importedNode
- The node to import.deep
- Iftrue
, recursively import the subtree under the specified node; iffalse
, import only the node itself, as explained above. This has no effect on nodes that cannot have any children, and onAttr
, andEntityReference
nodes.
- Returns:
- The imported node that belongs to this
Document
.
- Throws:
DOMException
- NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.
INVALID_CHARACTER_ERR: Raised if one of the imported names is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute. This may happen when importing an XML 1.1 [XML 1.1] element into an XML 1.0 document, for instance.
- 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.
- Specified by:
- normalizeDocument in interface Document
- Since:
- DOM Level 3
public Node renameNode(Node n, String namespaceURI, String qualifiedName)
Rename an existing node of typeELEMENT_NODE
orATTRIBUTE_NODE
.
When possible this simply changes the name of the given node, otherwise this creates a new node with the specified name and replaces the existing node with the new node as described below.
If simply changing the name of the given node is not possible, the following operations are performed: a new node is created, any registered event listener is registered on the new node, any user data attached to the old node is removed from that node, the old node is removed from its parent if it has one, the children are moved to the new node, if the renamed node is anElement
its attributes are moved to the new node, the new node is inserted at the position the old node used to have in its parent's child nodes list if it has one, the user data that was attached to the old node is attached to the new node.
When the node being renamed is anElement
only the specified attributes are moved, default attributes originated from the DTD are updated according to the new element name. In addition, the implementation may update default attributes from other schemas. Applications should useDocument.normalizeDocument()
to guarantee these attributes are up-to-date.
When the node being renamed is anAttr
that is attached to anElement
, the node is first removed from theElement
attributes map. Then, once renamed, either by modifying the existing node or creating a new one as described above, it is put back.
In addition,
- a user data event
NODE_RENAMED
is fired,- when the implementation supports the feature "MutationNameEvents", each mutation operation involved in this method fires the appropriate event, and in the end the event {
http://www.w3.org/2001/xml-events
,DOMElementNameChanged
} or {http://www.w3.org/2001/xml-events
,DOMAttributeNameChanged
} is fired.
- Specified by:
- renameNode in interface Document
- 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.
- Throws:
DOMException
- NOT_SUPPORTED_ERR: Raised when the type of the specified node is neitherELEMENT_NODE
norATTRIBUTE_NODE
, or if the implementation does not support the renaming of the document element.
INVALID_CHARACTER_ERR: Raised if the new qualified name is not an XML name according to the XML version in use specified in theDocument.xmlVersion
attribute.
WRONG_DOCUMENT_ERR: Raised when the specified node was created from a different document than this document.
NAMESPACE_ERR: Raised if thequalifiedName
is a malformed qualified name, if thequalifiedName
has a prefix and thenamespaceURI
isnull
, or if thequalifiedName
has a prefix that is "xml" and thenamespaceURI
is different from " http://www.w3.org/XML/1998/namespace" [XML Namespaces] . Also raised, when the node being renamed is an attribute, if thequalifiedName
, or its prefix, is "xmlns" and thenamespaceURI
is different from "http://www.w3.org/2000/xmlns/".
- Since:
- DOM Level 3
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
.
- Specified by:
- setDocumentURI in interface Document
- Since:
- DOM Level 3
public void setParameter(String name, Object value) throws DOMException
- Specified by:
- setParameter in interface DOMConfiguration
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.
- Specified by:
- setStrictErrorChecking in interface Document
- Since:
- DOM Level 3
public void setXmlStandalone(boolean xmlStandalone)
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 use
Document.normalizeDocument()
with the "validate" parameter to verify if the value matches the validity constraint for standalone document declaration as defined in [XML 1.0].
- Specified by:
- setXmlStandalone in interface Document
- Throws:
DOMException
- NOT_SUPPORTED_ERR: Raised if this document does not support the "XML" feature.
- Since:
- DOM Level 3
public void setXmlVersion(String xmlVersion)
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
.
- Specified by:
- setXmlVersion in interface Document
- Throws:
DOMException
- NOT_SUPPORTED_ERR: Raised if the version is set to a value that is not supported by thisDocument
or if this document does not support the "XML" feature.
- Since:
- DOM Level 3
public String toString()
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it intoSystem.out.println()
and such.It is typical, but not required, to ensure that this method never completes abruptly with a
RuntimeException
.This method will be called when performing string concatenation with this object. If the result is
null
, string concatenation will instead use"null"
.The default implementation returns
getClass().getName() + "@" + Integer.toHexString(hashCode())
.
- Overrides:
- toString in interface gnu.xml.libxmlj.dom.GnomeNode
- Returns:
- the String representing this Object, which may be null
- See Also:
getClass()
,Object.hashCode()
,Class.getName()
,Integer.toHexString(int)