|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.jscience.ml.cml.dom.pmr.PMRNodeImpl
org.jscience.ml.cml.dom.pmr.PMRDocumentImpl
public class PMRDocumentImpl
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.
| Field Summary |
|---|
| Fields inherited from class org.jscience.ml.cml.dom.pmr.PMRNodeImpl |
|---|
childNodes, delegateNode, parentNode, pmrDocument, siblingNodes |
| 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 | |
|---|---|
protected |
PMRDocumentImpl()
|
|
PMRDocumentImpl(org.w3c.dom.Document document)
|
protected |
PMRDocumentImpl(PMRDocumentImpl oldPmrDoc)
|
| Method Summary | |
|---|---|
org.w3c.dom.Node |
adoptNode(org.w3c.dom.Node source)
Attempts to adopt a node from another document to this document. |
org.w3c.dom.Attr |
createAttribute(java.lang.String name)
Creates an Attr of the given name. |
org.w3c.dom.Attr |
createAttributeNS(java.lang.String s,
java.lang.String t)
|
org.w3c.dom.CDATASection |
createCDATASection(java.lang.String data)
Creates a CDATASection node whose value is the specified
string. |
org.w3c.dom.Comment |
createComment(java.lang.String data)
Creates a Comment node given the specified string. |
org.w3c.dom.DocumentFragment |
createDocumentFragment()
Creates an empty DocumentFragment object. |
org.w3c.dom.Element |
createElement(java.lang.String tagName)
Creates an element of the type specified. |
org.w3c.dom.Element |
createElementNS(java.lang.String s,
java.lang.String t)
|
org.w3c.dom.EntityReference |
createEntityReference(java.lang.String name)
Creates an EntityReference object. |
org.w3c.dom.ProcessingInstruction |
createProcessingInstruction(java.lang.String target,
java.lang.String data)
Creates a ProcessingInstruction node given the specified
name and data strings. |
org.w3c.dom.Text |
createTextNode(java.lang.String data)
Creates a Text node given the specified string. |
org.w3c.dom.DocumentType |
getDoctype()
The Document Type Declaration (see DocumentType) associated
with this document. |
org.w3c.dom.Element |
getDocumentElement()
This is a convenience attribute that allows direct access to the child node that is the root element of the document. |
java.lang.String |
getDocumentURI()
The location of the document or null if undefined or if
the Document was created using
DOMImplementation.createDocument. |
org.w3c.dom.DOMConfiguration |
getDomConfig()
The configuration used when Document.normalizeDocument()
is invoked. |
org.w3c.dom.Element |
getElementById(java.lang.String id)
very crude |
org.w3c.dom.NodeList |
getElementsByTagName(java.lang.String name)
Returns a NodeList of all the Elements with a
given tag name in the order in which they would be encountered in a
preorder traversal of the Document tree. |
org.w3c.dom.NodeList |
getElementsByTagNameNS(java.lang.String s,
java.lang.String t)
|
org.w3c.dom.DOMImplementation |
getImplementation()
The DOMImplementation object that handles this document. |
java.lang.String |
getInputEncoding()
An attribute specifying the encoding used for this document at the time of the parsing. |
boolean |
getStrictErrorChecking()
An attribute specifying whether error checking is enforced or not. |
java.lang.String |
getXmlEncoding()
An attribute specifying, as part of the XML declaration, the encoding of this document. |
boolean |
getXmlStandalone()
An attribute specifying, as part of the XML declaration, whether this document is standalone. |
java.lang.String |
getXmlVersion()
An attribute specifying, as part of the XML declaration, the version number of this document. |
org.w3c.dom.Node |
importNode(org.w3c.dom.Node node,
boolean deepCopy)
hopefully supported now |
static void |
main(java.lang.String[] args)
|
void |
normalizeDocument()
This method acts as if the document was going through a save and load cycle, putting the document in a "normal" form. |
org.w3c.dom.Node |
renameNode(org.w3c.dom.Node n,
java.lang.String namespaceURI,
java.lang.String qualifiedName)
Rename an existing node of type ELEMENT_NODE or
ATTRIBUTE_NODE. |
void |
setDocumentURI(java.lang.String documentURI)
The location of the document or null if undefined or if
the Document was created using
DOMImplementation.createDocument. |
void |
setStrictErrorChecking(boolean strictErrorChecking)
An attribute specifying whether error checking is enforced or not. |
void |
setXmlStandalone(boolean xmlStandalone)
An attribute specifying, as part of the XML declaration, whether this document is standalone. |
void |
setXmlVersion(java.lang.String xmlVersion)
An attribute specifying, as part of the XML declaration, the version number of this document. |
static void |
test()
|
static void |
test(java.lang.String inFile)
|
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.w3c.dom.Node |
|---|
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData |
| Constructor Detail |
|---|
protected PMRDocumentImpl()
protected PMRDocumentImpl(PMRDocumentImpl oldPmrDoc)
public PMRDocumentImpl(org.w3c.dom.Document document)
| Method Detail |
|---|
public org.w3c.dom.DocumentType getDoctype()
DocumentType) associated
with this document. For HTML documents as well as XML documents without
a document type declaration this returns null. The DOM Level
1 does not support editing the Document Type Declaration, therefore
docType cannot be altered in any way.
getDoctype in interface org.w3c.dom.Documentpublic org.w3c.dom.DOMImplementation getImplementation()
DOMImplementation object that handles this document. A
DOM application may use objects from multiple implementations.
getImplementation in interface org.w3c.dom.Documentpublic org.w3c.dom.Element getDocumentElement()
getDocumentElement in interface org.w3c.dom.Document
public org.w3c.dom.Element createElement(java.lang.String tagName)
throws org.w3c.dom.DOMException
createElement in interface org.w3c.dom.DocumenttagName - 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.
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an
invalid character.public org.w3c.dom.DocumentFragment createDocumentFragment()
DocumentFragment object.
createDocumentFragment in interface org.w3c.dom.DocumentDocumentFragment.public org.w3c.dom.Text createTextNode(java.lang.String data)
Text node given the specified string.
createTextNode in interface org.w3c.dom.Documentdata - The data for the node.
Text object.public org.w3c.dom.Comment createComment(java.lang.String data)
Comment node given the specified string.
createComment in interface org.w3c.dom.Documentdata - The data for the node.
Comment object.
public org.w3c.dom.CDATASection createCDATASection(java.lang.String data)
throws org.w3c.dom.DOMException
CDATASection node whose value is the specified
string.
createCDATASection in interface org.w3c.dom.Documentdata - The data for the CDATASection contents.
CDATASection object.
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
public org.w3c.dom.ProcessingInstruction createProcessingInstruction(java.lang.String target,
java.lang.String data)
throws org.w3c.dom.DOMException
ProcessingInstruction node given the specified
name and data strings.
createProcessingInstruction in interface org.w3c.dom.Documenttarget - The target part of the processing instruction.data - The data for the node.
ProcessingInstruction object.
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if an invalid character is specified.
public org.w3c.dom.Attr createAttribute(java.lang.String name)
throws org.w3c.dom.DOMException
Attr of the given name. Note that the
Attr instance can then be set on an Element
using the setAttribute method.
createAttribute in interface org.w3c.dom.Documentname - The name of the attribute.
Attr object.
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an
invalid character.
public org.w3c.dom.EntityReference createEntityReference(java.lang.String name)
throws org.w3c.dom.DOMException
createEntityReference in interface org.w3c.dom.Documentname - The name of the entity to reference.
EntityReference object.
org.w3c.dom.DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an
invalid character.
public org.w3c.dom.NodeList getElementsByTagName(java.lang.String name)
NodeList of all the Elements with a
given tag name in the order in which they would be encountered in a
preorder traversal of the Document tree.
getElementsByTagName in interface org.w3c.dom.Documentname - The name of the tag to match on. The special value "*"
matches all tags.
NodeList object containing all the matched
Elements.
public org.w3c.dom.Element createElementNS(java.lang.String s,
java.lang.String t)
createElementNS in interface org.w3c.dom.Document
public org.w3c.dom.NodeList getElementsByTagNameNS(java.lang.String s,
java.lang.String t)
getElementsByTagNameNS in interface org.w3c.dom.Document
public org.w3c.dom.Node importNode(org.w3c.dom.Node node,
boolean deepCopy)
importNode in interface org.w3c.dom.Document
public org.w3c.dom.Attr createAttributeNS(java.lang.String s,
java.lang.String t)
createAttributeNS in interface org.w3c.dom.Documentpublic java.lang.String getInputEncoding()
null when it is not known, such
as when the Document was created in memory.
getInputEncoding in interface org.w3c.dom.Documentpublic java.lang.String getXmlEncoding()
null when
unspecified or when it is not known, such as when the
Document was created in memory.
getXmlEncoding in interface org.w3c.dom.Documentpublic boolean getXmlStandalone()
false 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].
getXmlStandalone in interface org.w3c.dom.Document
public void setXmlStandalone(boolean xmlStandalone)
throws org.w3c.dom.DOMException
false 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].
setXmlStandalone in interface org.w3c.dom.Documentorg.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if this document does not support the
"XML" feature.public java.lang.String getXmlVersion()
"1.0". If this document does not support the "XML"
feature, the value is always null. Changing this
attribute will affect methods that check for invalid characters in
XML names. Application should invoke
Document.normalizeDocument() in order to check for
invalid characters in the Nodes that are already part of
this Document.
DOMImplementation.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 a NOT_SUPPORTED_ERR exception for the same version
number when using Document.xmlVersion.
getXmlVersion in interface org.w3c.dom.Document
public void setXmlVersion(java.lang.String xmlVersion)
throws org.w3c.dom.DOMException
"1.0". If this document does not support the "XML"
feature, the value is always null. Changing this
attribute will affect methods that check for invalid characters in
XML names. Application should invoke
Document.normalizeDocument() in order to check for
invalid characters in the Nodes that are already part of
this Document.
DOMImplementation.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 a NOT_SUPPORTED_ERR exception for the same version
number when using Document.xmlVersion.
setXmlVersion in interface org.w3c.dom.Documentorg.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if the version is set to a value that is
not supported by this Document or if this document
does not support the "XML" feature.public boolean getStrictErrorChecking()
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 org.w3c.dom.Documentpublic void setStrictErrorChecking(boolean strictErrorChecking)
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 org.w3c.dom.Documentpublic java.lang.String getDocumentURI()
null if undefined or if
the Document was created using
DOMImplementation.createDocument. No lexical checking is
performed when setting this attribute; this could result in a
null value returned when using Node.baseURI
.
Document supports the feature
"HTML" [DOM Level 2 HTML]
, the href attribute of the HTML BASE element takes precedence over
this attribute when computing Node.baseURI.
getDocumentURI in interface org.w3c.dom.Documentpublic void setDocumentURI(java.lang.String documentURI)
null if undefined or if
the Document was created using
DOMImplementation.createDocument. No lexical checking is
performed when setting this attribute; this could result in a
null value returned when using Node.baseURI
.
Document supports the feature
"HTML" [DOM Level 2 HTML]
, the href attribute of the HTML BASE element takes precedence over
this attribute when computing Node.baseURI.
setDocumentURI in interface org.w3c.dom.Document
public org.w3c.dom.Node adoptNode(org.w3c.dom.Node source)
throws org.w3c.dom.DOMException
ownerDocument 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 (unlike importNode() which
create a copy of the source node instead of moving it). When it
fails, applications should use Document.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 attribute is set to null and
the specified flag is set to true on the
adopted Attr. The descendants of the source
Attr are recursively adopted.Document nodes cannot be adopted.DocumentType nodes cannot be adopted.Entity nodes cannot be adopted.EntityReference node itself is adopted, the
descendants are discarded, since the source and destination documents
might have defined the entity differently. If the document being
imported into provides a definition for this entity name, its value
is assigned.Notation nodes cannot be
adopted.Note: Since it does not create new nodes unlike the
Document.importNode() method, this method does not raise
an INVALID_CHARACTER_ERR exception, and applications
should use the Document.normalizeDocument() method to
check if an imported name is not an XML name according to the XML
version in use.
adoptNode in interface org.w3c.dom.Documentsource - The node to move into this document.
null if this operation
fails, such as when the source node comes from a different
implementation.
org.w3c.dom.DOMException - NOT_SUPPORTED_ERR: Raised if the source node is of type
DOCUMENT, DOCUMENT_TYPE.
public org.w3c.dom.DOMConfiguration getDomConfig()
Document.normalizeDocument()
is invoked.
getDomConfig in interface org.w3c.dom.Documentpublic void normalizeDocument()
EntityReference nodes and normalizes Text
nodes, as defined in the method Node.normalize().
Document.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 the
CDATASection nodes, etc. See
DOMConfiguration 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();
Node.nodeName
contains an invalid character according to the XML version in use,
errors or warnings (DOMError.SEVERITY_ERROR or
DOMError.SEVERITY_WARNING) will be reported using the
DOMErrorHandler 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.
normalizeDocument in interface org.w3c.dom.Document
public org.w3c.dom.Node renameNode(org.w3c.dom.Node n,
java.lang.String namespaceURI,
java.lang.String qualifiedName)
throws org.w3c.dom.DOMException
ELEMENT_NODE or
ATTRIBUTE_NODE.
Element 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.
Element 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 use Document.normalizeDocument() to
guarantee these attributes are up-to-date.
Attr that is
attached to an Element, the node is first removed from
the Element attributes map. Then, once renamed, either
by modifying the existing node or creating a new one as described
above, it is put back.
NODE_RENAMED is fired,
http://www.w3.org/2001/xml-events,
DOMElementNameChanged} or {
http://www.w3.org/2001/xml-events,
DOMAttributeNameChanged} is fired.
renameNode in interface org.w3c.dom.Documentn - The node to rename.namespaceURI - The new namespace URI.qualifiedName - The new qualified name.
org.w3c.dom.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 org.w3c.dom.Element getElementById(java.lang.String id)
getElementById in interface org.w3c.dom.Documentpublic java.lang.String toString()
toString in class PMRNodeImpl
public static void test(java.lang.String inFile)
throws java.lang.Exception
java.lang.Exception
public static void test()
throws java.lang.Exception
java.lang.Exceptionpublic static void main(java.lang.String[] args)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||