|
||||||||||
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.CoreDocumentImpl
public class CoreDocumentImpl
The Document interface represents the entire HTML or XML document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data.
Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a Document, the Document interface also contains the factory methods needed to create these objects. The Node objects created have a ownerDocument attribute which associates them with the Document within whose context they were created.
The CoreDocumentImpl class only implements the DOM Core. Additional modules are supported by the more complete DocumentImpl subclass.
Note: When any node in the document is serialized, the entire document is serialized along with it.
Field Summary |
---|
Constructor Summary | |
---|---|
CoreDocumentImpl()
NON-DOM: Actually creating a Document is outside the DOM's spec, since it has to operate in terms of a particular implementation. |
|
CoreDocumentImpl(boolean grammarAccess)
Constructor. |
|
CoreDocumentImpl(DocumentType doctype)
For DOM2 support. |
|
CoreDocumentImpl(DocumentType doctype,
boolean grammarAccess)
For DOM2 support. |
Method Summary | |
---|---|
void |
abort()
DOM Level 3 WD - Experimental. |
Node |
adoptNode(Node source)
DOM Level 3 WD - Experimental Change the node's ownerDocument, and its subtree, to this Document |
java.lang.Object |
clone()
Clone. |
Node |
cloneNode(boolean deep)
Deep-clone a document, including fixing ownerDoc for the cloned children. |
Attr |
createAttribute(java.lang.String name)
Factory method; creates an Attribute having this Document as its OwnerDoc. |
Attr |
createAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
Introduced in DOM Level 2. |
Attr |
createAttributeNS(java.lang.String namespaceURI,
java.lang.String qualifiedName,
java.lang.String localpart)
NON-DOM: a factory method used by the Xerces DOM parser to create an element. |
CDATASection |
createCDATASection(java.lang.String data)
Factory method; creates a CDATASection having this Document as its OwnerDoc. |
Comment |
createComment(java.lang.String data)
Factory method; creates a Comment having this Document as its OwnerDoc. |
DocumentFragment |
createDocumentFragment()
Factory method; creates a DocumentFragment having this Document as its OwnerDoc. |
DocumentType |
createDocumentType(java.lang.String qualifiedName,
java.lang.String publicID,
java.lang.String systemID)
NON-DOM Factory method; creates a DocumentType having this Document as its OwnerDoc. |
Element |
createElement(java.lang.String tagName)
Factory method; creates an Element having this Document as its OwnerDoc. |
ElementDefinitionImpl |
createElementDefinition(java.lang.String name)
NON-DOM Factory method: creates an element definition. |
Element |
createElementNS(java.lang.String namespaceURI,
java.lang.String qualifiedName)
Introduced in DOM Level 2. |
Element |
createElementNS(java.lang.String namespaceURI,
java.lang.String qualifiedName,
java.lang.String localpart)
NON-DOM: a factory method used by the Xerces DOM parser to create an element. |
Entity |
createEntity(java.lang.String name)
NON-DOM Factory method; creates an Entity having this Document as its OwnerDoc. |
EntityReference |
createEntityReference(java.lang.String name)
Factory method; creates an EntityReference having this Document as its OwnerDoc. |
Notation |
createNotation(java.lang.String name)
NON-DOM Factory method; creates a Notation having this Document as its OwnerDoc. |
ProcessingInstruction |
createProcessingInstruction(java.lang.String target,
java.lang.String data)
Factory method; creates a ProcessingInstruction having this Document as its OwnerDoc. |
Text |
createTextNode(java.lang.String data)
Factory method; creates a Text node having this Document as its OwnerDoc. |
boolean |
getAsync()
DOM Level 3 WD - Experimental. |
java.lang.String |
getBaseURI()
Returns the absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI. |
DocumentType |
getDoctype()
For XML, this provides access to the Document Type Definition. |
Element |
getDocumentElement()
Convenience method, allowing direct access to the child node which is considered the root of the actual document content. |
java.lang.String |
getDocumentURI()
DOM Level 3 WD - Experimental. |
DOMConfiguration |
getDomConfig()
DOM Level 3 CR - Experimental The configuration used when Document.normalizeDocument is
invoked. |
Element |
getElementById(java.lang.String elementId)
Introduced in DOM Level 2 Returns the Element whose ID is given by elementId. |
NodeList |
getElementsByTagName(java.lang.String tagname)
Return a live collection of all descendent Elements (not just immediate children) having the specified tag name. |
NodeList |
getElementsByTagNameNS(java.lang.String namespaceURI,
java.lang.String localName)
Introduced in DOM Level 2. |
java.lang.String |
getEncoding()
Deprecated. This method is internal and only exists for compatibility with older applications. New applications should never call this method. |
boolean |
getErrorChecking()
Returns true if the DOM implementation performs error checking. |
java.lang.Object |
getFeature(java.lang.String feature,
java.lang.String version)
This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . |
Element |
getIdentifier(java.lang.String idName)
Returns a previously registered element with the specified identifier name, or null if no element is registered. |
java.util.Enumeration |
getIdentifiers()
Returns an enumeration registered of identifier names. |
DOMImplementation |
getImplementation()
Retrieve information describing the abilities of this particular DOM implementation. |
java.lang.String |
getInputEncoding()
DOM Level 3 CR - Experimental. |
java.lang.String |
getNodeName()
Returns the node name. |
short |
getNodeType()
Returns the node type. |
Document |
getOwnerDocument()
Find the Document that this Node belongs to (the document in whose context the Node was created). |
boolean |
getStandalone()
Deprecated. This method is internal and only exists for compatibility with older applications. New applications should never call this method. |
boolean |
getStrictErrorChecking()
An attribute specifying whether error checking is enforced or not. |
java.lang.String |
getTextContent()
This attribute returns the text content of this node and its descendants. |
java.lang.Object |
getUserData(Node n,
java.lang.String key)
Retrieves the object associated to a key on a this node. |
java.lang.String |
getVersion()
Deprecated. This method is internal and only exists for compatibility with older applications. New applications should never call this method. |
java.lang.String |
getXmlEncoding()
DOM Level 3 WD - Experimental. |
boolean |
getXmlStandalone()
DOM Level 3 WD - Experimental. |
java.lang.String |
getXmlVersion()
DOM Level 3 WD - Experimental. |
Node |
importNode(Node source,
boolean deep)
Copies a node from another document to this document. |
Node |
insertBefore(Node newChild,
Node refChild)
Since a Document may contain at most one top-level Element child, and at most one DocumentType declaraction, we need to subclass our add-children methods to implement this constraint. |
static boolean |
isValidQName(java.lang.String prefix,
java.lang.String local,
boolean xml11Version)
Checks if the given qualified name is legal with respect to the version of XML to which this document must conform. |
static boolean |
isXMLName(java.lang.String s,
boolean xml11Version)
Check the string against XML's definition of acceptable names for elements and attributes and so on using the XMLCharacterProperties utility class |
boolean |
load(java.lang.String uri)
DOM Level 3 WD - Experimental. |
boolean |
loadXML(java.lang.String source)
DOM Level 3 WD - Experimental. |
void |
normalizeDocument()
DOM Level 3 WD - Experimental Normalize document. |
void |
putIdentifier(java.lang.String idName,
Element element)
Registers an identifier name with a specified element node. |
Node |
removeChild(Node oldChild)
Since insertBefore caches the docElement (and, currently, docType), removeChild has to know how to undo the cache REVISIT: According to the spec it is not allowed to alter neither the document element nor the document type in any way |
void |
removeIdentifier(java.lang.String idName)
Removes a previously registered element with the specified identifier name. |
Node |
renameNode(Node n,
java.lang.String namespaceURI,
java.lang.String name)
DOM Level 3 WD - Experimental. |
Node |
replaceChild(Node newChild,
Node oldChild)
Since we cache the docElement (and, currently, docType), replaceChild has to update the cache REVISIT: According to the spec it is not allowed to alter neither the document element nor the document type in any way |
java.lang.String |
saveXML(Node node)
DOM Level 3 WD - Experimental. |
void |
setAsync(boolean async)
DOM Level 3 WD - Experimental. |
void |
setDocumentURI(java.lang.String documentURI)
DOM Level 3 WD - Experimental. |
void |
setEncoding(java.lang.String value)
Deprecated. This method is internal and only exists for compatibility with older applications. New applications should never call this method. |
void |
setErrorChecking(boolean check)
Sets whether the DOM implementation performs error checking upon operations. |
void |
setInputEncoding(java.lang.String value)
DOM Internal (Was a DOM L3 Core WD public interface method setActualEncoding ) An attribute specifying the actual encoding of this document. |
void |
setStandalone(boolean value)
Deprecated. This method is internal and only exists for compatibility with older applications. New applications should never call this method. |
void |
setStrictErrorChecking(boolean check)
An attribute specifying whether error checking is enforced or not. |
void |
setTextContent(java.lang.String textContent)
This attribute returns the text content of this node and its descendants. |
java.lang.Object |
setUserData(Node n,
java.lang.String key,
java.lang.Object data,
UserDataHandler handler)
Associate an object to a key on this node. |
void |
setVersion(java.lang.String value)
Deprecated. This method is internal and only exists for compatibility with older applications. New applications should never call this method. |
void |
setXmlEncoding(java.lang.String value)
DOM Internal (Was a DOM L3 Core WD public interface method setXMLEncoding ) An attribute specifying, as part of the XML declaration, the encoding of this document. |
void |
setXmlStandalone(boolean value)
DOM Level 3 CR - Experimental. |
void |
setXmlVersion(java.lang.String value)
DOM Level 3 CR - Experimental. |
Methods inherited from class org.apache.xerces.dom.ParentNode |
---|
getChildNodes, getFirstChild, getLastChild, getLength, hasChildNodes, isEqualNode, item, normalize, setReadOnly |
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, getAttributes, getLocalName, getNamespaceURI, getNodeValue, getPrefix, getReadOnly, getUserData, getUserData, hasAttributes, 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, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getParentNode, getPrefix, getPreviousSibling, getUserData, hasAttributes, hasChildNodes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, setNodeValue, setPrefix, setUserData |
Constructor Detail |
---|
public CoreDocumentImpl()
public CoreDocumentImpl(boolean grammarAccess)
public CoreDocumentImpl(DocumentType doctype)
public CoreDocumentImpl(DocumentType doctype, boolean grammarAccess)
Method Detail |
---|
public final Document getOwnerDocument()
ParentNode
getOwnerDocument
in interface Node
getOwnerDocument
in class ParentNode
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 Node cloneNode(boolean deep)
cloneNode
in interface Node
cloneNode
in class ParentNode
deep
- boolean, iff true replicate children
Example: Cloning a Text node will copy both the node and the text it
contains.
Example: Cloning something that has children -- Element or Attr, for
example -- will _not_ clone those children unless a "deep clone"
has been requested. A shallow clone of an Attr node will yield an
empty Attr of the same name.
NOTE: Clones will always be read/write, even if the node being cloned
is read-only, to permit applications using only the DOM API to obtain
editable copies of locked portions of the tree.
public Node insertBefore(Node newChild, Node refChild) throws DOMException
While I'm doing so, I've taken advantage of the opportunity to cache documentElement and docType so we don't have to search for them. REVISIT: According to the spec it is not allowed to alter neither the document element nor the document type in any way
insertBefore
in interface Node
insertBefore
in class ParentNode
newChild
- The Node to be moved to our subtree. As a
convenience feature, inserting a DocumentNode will instead insert
all its children.refChild
- Current child which newChild should be placed
immediately before. If refChild is null, the insertion occurs
after all existing Nodes, like appendChild().
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not
allow children of the type of the newChild
node, or if
the node to insert is one of this node's ancestors or this node
itself, or if this node is of type Document
and the
DOM application attempts to insert a second
DocumentType
or Element
node.
newChild
was created
from a different document than the one that created this node.
refChild
is not a child of
this node.
Document
,
this exception might be raised if the DOM implementation doesn't
support the insertion of a DocumentType
or
Element
node.ParentNode
public Node removeChild(Node oldChild) throws DOMException
removeChild
in interface Node
removeChild
in class ParentNode
oldChild
- The node being removed.
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
oldChild
is not a child of
this node.
Document
,
this exception might be raised if the DOM implementation doesn't
support the removal of the DocumentType
child or the
Element
child.ParentNode
public Node replaceChild(Node newChild, Node oldChild) throws DOMException
replaceChild
in interface Node
replaceChild
in class ParentNode
newChild
- The new node to put in the child list.oldChild
- The node being replaced in the list.
DOMException
- HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not
allow children of the type of the newChild
node, or if
the node to put in is one of this node's ancestors or this node
itself, or if this node is of type Document
and the
result of the replacement operation would add a second
DocumentType
or Element
on the
Document
node.
newChild
was created
from a different document than the one that created this node.
oldChild
is not a child of
this node.
Document
,
this exception might be raised if the DOM implementation doesn't
support the replacement of the DocumentType
child or
Element
child.ParentNode
public java.lang.String getTextContent() throws DOMException
NodeImpl
Text
node containing the string
this attribute is set to. On getting, no serialization is performed,
the returned string does not contain any markup. No whitespace
normalization is performed, the returned string does not contain the
element content whitespaces . Similarly, on setting, no parsing is
performed either, the input string is taken as pure textual content.
Node type | Content |
---|
Node type | Content |
---|---|
ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE | concatenation of the textContent
attribute value of every child node, excluding COMMENT_NODE and
PROCESSING_INSTRUCTION_NODE nodes |
ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE |
nodeValue |
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null |
getTextContent
in interface Node
getTextContent
in class ParentNode
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.public void setTextContent(java.lang.String textContent) throws DOMException
NodeImpl
Text
node containing the string
this attribute is set to. On getting, no serialization is performed,
the returned string does not contain any markup. No whitespace
normalization is performed, the returned string does not contain the
element content whitespaces . Similarly, on setting, no parsing is
performed either, the input string is taken as pure textual content.
Node type | Content |
---|---|
ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE | concatenation of the textContent
attribute value of every child node, excluding COMMENT_NODE and
PROCESSING_INSTRUCTION_NODE nodes |
ATTRIBUTE_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE |
nodeValue |
DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null |
setTextContent
in interface Node
setTextContent
in class ParentNode
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.public java.lang.Object getFeature(java.lang.String feature, java.lang.String version)
Node
Node
interface.
getFeature
in interface Node
getFeature
in class NodeImpl
feature
- The name of the feature requested. Note that any plus
sign "+" prepended to the name of the feature will be ignored since
it is not significant in the context of this method.version
- This is the version number of the feature to test.
null
if
there is no object which implements interfaces associated with that
feature. If the DOMObject
returned by this method
implements the Node
interface, it must delegate to the
primary core Node
and not return results inconsistent
with the primary core Node
such as attributes,
childNodes, etc.public Attr createAttribute(java.lang.String name) throws DOMException
createAttribute
in interface Document
name
- The name of the attribute. Note that the attribute's value is
_not_ established at the factory; remember to set it!
Attr
object with the nodeName
attribute set to name
, and localName
,
prefix
, and namespaceURI
set to
null
. The value of the attribute is the empty string.
DOMException(INVALID_NAME_ERR)
- if the attribute name is not acceptable.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name is not an XML
name according to the XML version in use specified in the
Document.xmlVersion
attribute.public CDATASection createCDATASection(java.lang.String data) throws DOMException
createCDATASection
in interface Document
data
- The initial contents of the CDATA
CDATASection
object.
DOMException(NOT_SUPPORTED_ERR)
- for HTML documents. (HTML
not yet implemented.)
DOMException
- NOT_SUPPORTED_ERR: Raised if this document is an HTML document.public Comment createComment(java.lang.String data)
createComment
in interface Document
data
- The initial contents of the Comment.
Comment
object.public DocumentFragment createDocumentFragment()
createDocumentFragment
in interface Document
DocumentFragment
.public Element createElement(java.lang.String tagName) throws DOMException
createElement
in interface Document
tagName
- The name of the element type to instantiate. For
XML, this is case-sensitive. For HTML, the tagName parameter may
be provided in any case, but it must be mapped to the canonical
uppercase form by the DOM implementation.
Element
object with the
nodeName
attribute set to tagName
, and
localName
, prefix
, and
namespaceURI
set to null
.
DOMException(INVALID_NAME_ERR)
- if the tag name is not
acceptable.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name is not an XML
name according to the XML version in use specified in the
Document.xmlVersion
attribute.public EntityReference createEntityReference(java.lang.String name) throws DOMException
createEntityReference
in interface Document
name
- The name of the Entity we wish to refer to
EntityReference
object.
DOMException(NOT_SUPPORTED_ERR)
- for HTML documents, where
nonstandard entities are not permitted. (HTML not yet
implemented.)
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified name is not an XML
name according to the XML version in use specified in the
Document.xmlVersion
attribute.
public ProcessingInstruction createProcessingInstruction(java.lang.String target, java.lang.String data) throws DOMException
createProcessingInstruction
in interface Document
target
- The target "processor channel"data
- Parameter string to be passed to the target.
ProcessingInstruction
object.
DOMException(INVALID_NAME_ERR)
- if the target name is not
acceptable.
DOMException(NOT_SUPPORTED_ERR)
- for HTML documents. (HTML
not yet implemented.)
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified target is not an XML
name according to the XML version in use specified in the
Document.xmlVersion
attribute.
public Text createTextNode(java.lang.String data)
createTextNode
in interface Document
data
- The initial contents of the Text.
Text
object.public DocumentType getDoctype()
getDoctype
in interface Document
public Element getDocumentElement()
getDocumentElement
in interface Document
public NodeList getElementsByTagName(java.lang.String tagname)
getElementsByTagName
in interface Document
tagname
- The type of Element we want to gather. "*" will be
taken as a wildcard, meaning "all elements in the document."
NodeList
object containing all the matched
Elements
.DeepNodeListImpl
public DOMImplementation getImplementation()
getImplementation
in interface Document
public void setErrorChecking(boolean check)
Turning off error checking does not turn off the following checks:
public void setStrictErrorChecking(boolean check)
Document
false
, the implementation is free to not test
every possible error case normally defined on DOM operations, and not
raise any DOMException
on DOM operations or report
errors while using Document.normalizeDocument()
. In case
of error, the behavior is undefined. This attribute is
true
by default.
setStrictErrorChecking
in interface Document
public boolean getErrorChecking()
public boolean getStrictErrorChecking()
Document
false
, the implementation is free to not test
every possible error case normally defined on DOM operations, and not
raise any DOMException
on DOM operations or report
errors while using Document.normalizeDocument()
. In case
of error, the behavior is undefined. This attribute is
true
by default.
getStrictErrorChecking
in interface Document
public java.lang.String getInputEncoding()
null
when
it is not known, such as when the Document
was
created in memory.
getInputEncoding
in interface Document
public void setInputEncoding(java.lang.String value)
null
otherwise.
public void setXmlEncoding(java.lang.String value)
public void setEncoding(java.lang.String value)
public java.lang.String getXmlEncoding()
getXmlEncoding
in interface Document
public java.lang.String getEncoding()
public void setXmlVersion(java.lang.String value)
setXmlVersion
in interface Document
public void setVersion(java.lang.String value)
public java.lang.String getXmlVersion()
getXmlVersion
in interface Document
public java.lang.String getVersion()
public void setXmlStandalone(boolean value) throws DOMException
setXmlStandalone
in interface Document
DOMException
- NOT_SUPPORTED_ERR: Raised if this document does not support the
"XML" feature.public void setStandalone(boolean value)
public boolean getXmlStandalone()
getXmlStandalone
in interface Document
public boolean getStandalone()
public java.lang.String getDocumentURI()
null
if undefined.
Document
supports the feature
"HTML" , the href attribute of the HTML BASE element takes precedence
over this attribute.
getDocumentURI
in interface Document
public Node renameNode(Node n, java.lang.String namespaceURI, java.lang.String name) throws DOMException
renameNode
in interface Document
n
- The node to rename.namespaceURI
- The new namespace URI.name
- The new qualified name.
DOMException
- NOT_SUPPORTED_ERR: Raised when the type of the specified node is
neither ELEMENT_NODE
nor ATTRIBUTE_NODE
,
or if the implementation does not support the renaming of the
document element.
Document.xmlVersion
attribute.
qualifiedName
is a
malformed qualified name, if the qualifiedName
has a
prefix and the namespaceURI
is null
, or
if the qualifiedName
has a prefix that is "xml" and
the namespaceURI
is different from "
http://www.w3.org/XML/1998/namespace" [XML Namespaces]
. Also raised, when the node being renamed is an attribute, if the
qualifiedName
, or its prefix, is "xmlns" and the
namespaceURI
is different from "http://www.w3.org/2000/xmlns/".public void normalizeDocument()
normalizeDocument
in interface Document
public DOMConfiguration getDomConfig()
Document.normalizeDocument
is
invoked.
getDomConfig
in interface Document
public java.lang.String getBaseURI()
getBaseURI
in interface Node
getBaseURI
in class NodeImpl
public void setDocumentURI(java.lang.String documentURI)
setDocumentURI
in interface Document
public boolean getAsync()
true
the load method returns control to the caller before the document has
completed loading. The default value of this property is
false
.
false
but we
need to check with Mozilla and IE.
public void setAsync(boolean async)
true
the load method returns control to the caller before the document has
completed loading. The default value of this property is
false
.
false
but we
need to check with Mozilla and IE.
public void abort()
load
being invoked the loading and parsing is
immediately aborted. The possibly partial result of parsing the
document is discarded and the document is cleared.
public boolean load(java.lang.String uri)
Event.targetNode
will be the document,
not an element) will be dispatched on the document. If an error
occurs, an implementation dependent "error" event will be dispatched
on the document. If this method is called on a document that is
currently loading, the current load is interrupted and the new URI
load is initiated.
DOMParser
interface are assumed to have their default
values with the exception that the parameters "entities"
, "normalize-characters"
,
"check-character-normalization"
are set to
"false"
.
DOMParser.parseWithContext
with an input stream
referencing the URI that was passed to this call, the document as the
context node, and the action ACTION_REPLACE_CHILDREN
.
uri
- The URI reference for the XML file to be loaded. If this is
a relative URI, the base URI used by the implementation is
implementation dependent.
true
load
returns
true
if the document load was successfully initiated.
If an error occurred when initiating the document load,
load
returns false
.If async is set to
false
load
returns true
if
the document was successfully loaded and parsed. If an error
occurred when either loading or parsing the URI, load
returns false
.public boolean loadXML(java.lang.String source)
source
- A string containing an XML document.
true
if parsing the input string succeeded
without errors, otherwise false
.public java.lang.String saveXML(Node node) throws DOMException
LSSerializer
interface are
assumed to have their default values when invoking this method.
LSSerializer.writeToString
with the document as
the node to write.
node
- Specifies what to serialize, if this parameter is
null
the whole document is serialized, if it's
non-null the given node is serialized.
null
in case an error
occurred.
DOMException
- WRONG_DOCUMENT_ERR: Raised if the node passed in as the node
parameter is from an other document.public DocumentType createDocumentType(java.lang.String qualifiedName, java.lang.String publicID, java.lang.String systemID) throws DOMException
qualifiedName
- publicID
- systemID
-
DOMException(NOT_SUPPORTED_ERR)
- for HTML documents, where
DTDs are not permitted. (HTML not yet implemented.)
DOMException
public Entity createEntity(java.lang.String name) throws DOMException
name
- The name of the Entity we wish to provide a value for.
DOMException(NOT_SUPPORTED_ERR)
- for HTML documents, where
nonstandard entities are not permitted. (HTML not yet
implemented.)
DOMException
public Notation createNotation(java.lang.String name) throws DOMException
name
- The name of the Notation we wish to describe
DOMException(NOT_SUPPORTED_ERR)
- for HTML documents, where
notations are not permitted. (HTML not yet
implemented.)
DOMException
public ElementDefinitionImpl createElementDefinition(java.lang.String name) throws DOMException
DOMException
public Node importNode(Node source, boolean deep) throws DOMException
According to the DOM specifications, document nodes cannot be imported and a NOT_SUPPORTED_ERR exception is thrown if attempted.
importNode
in interface Document
source
- The node to import.deep
- If true
, recursively import the subtree under
the specified node; if false
, import only the node
itself, as explained above. This has no effect on nodes that cannot
have any children, and on Attr
, and
EntityReference
nodes.
Document
.
DOMException
- NOT_SUPPORTED_ERR: Raised if the type of node being imported is not
supported.
Document.xmlVersion
attribute. This may happen when
importing an XML 1.1 [XML 1.1] element
into an XML 1.0 document, for instance.public Node adoptNode(Node source)
source
- The node to adopt.
null
if this operation
fails, such as when the source node comes from a different
implementation.importNode(org.w3c.dom.Node, boolean)
public Element getElementById(java.lang.String elementId)
Note: 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 return null.
getElementById
in interface Document
elementId
- The unique id
value for an element.
null
if there is none.getIdentifier(java.lang.String)
public void putIdentifier(java.lang.String idName, Element element)
public Element getIdentifier(java.lang.String idName)
public void removeIdentifier(java.lang.String idName)
public java.util.Enumeration getIdentifiers()
public Element createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName) throws DOMException
Creates an element of the given qualified name and namespace URI. If the given namespaceURI is null or an empty string and the qualifiedName has a prefix that is "xml", the created element is bound to the predefined namespace "http://www.w3.org/XML/1998/namespace" [Namespaces].
createElementNS
in interface Document
namespaceURI
- The namespace URI of the element to
create.qualifiedName
- The qualified name of the element type to
instantiate.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified
name contains an invalid character.
DOMException
- 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 different
from "xml" and the namespaceURI is null or an
empty string.public Element createElementNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String localpart) throws DOMException
namespaceURI
- The namespace URI of the element to
create.qualifiedName
- The qualified name of the element type to
instantiate.localpart
- The local name of the attribute to instantiate.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified
name contains an invalid character.public Attr createAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName) throws DOMException
Creates an attribute of the given qualified name and namespace URI. If the given namespaceURI is null or an empty string and the qualifiedName has a prefix that is "xml", the created element is bound to the predefined namespace "http://www.w3.org/XML/1998/namespace" [Namespaces].
createAttributeNS
in interface Document
namespaceURI
- The namespace URI of the attribute to
create. When it is null or an empty string,
this method behaves like createAttribute.qualifiedName
- The qualified name of the attribute to
instantiate.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified
name contains an invalid character.public Attr createAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String localpart) throws DOMException
namespaceURI
- The namespace URI of the attribute to
create. When it is null or an empty string,
this method behaves like createAttribute.qualifiedName
- The qualified name of the attribute to
instantiate.localpart
- The local name of the attribute to instantiate.
DOMException
- INVALID_CHARACTER_ERR: Raised if the specified
name contains an invalid character.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.
getElementsByTagNameNS
in interface Document
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 java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public static final boolean isXMLName(java.lang.String s, boolean xml11Version)
public static final boolean isValidQName(java.lang.String prefix, java.lang.String local, boolean xml11Version)
prefix
- prefix of qualified namelocal
- local part of qualified namepublic java.lang.Object setUserData(Node n, java.lang.String key, java.lang.Object data, UserDataHandler handler)
getUserData
with the
same key.
n
- The node to associate the object to.key
- The key to associate the object to.data
- The object to associate to the given key, or
null
to remove any existing association to that key.handler
- The handler to associate to that key, or
null
.
DOMObject
previously associated to
the given key on this node, or null
if there was none.public java.lang.Object getUserData(Node n, java.lang.String key)
setUserData
with the same key.
n
- The node the object is associated to.key
- The key the object is associated to.
DOMObject
associated to the given key
on this node, or null
if there was none.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |