gnu.xml.dom

Class DomImpl

Implemented Interfaces:
DOMImplementation, DOMImplementationLS

public class DomImpl
extends java.lang.Object
implements DOMImplementation, DOMImplementationLS

"DOMImplementation" implementation.

At this writing, the following features are supported: "XML" (L1, L2, L3), "Events" (L2), "MutationEvents" (L2), "USER-Events" (a conformant extension), "HTMLEvents" (L2), "UIEvents" (L2), "Traversal" (L2), "XPath" (L3), "LS" (L3) "LS-Async" (L3). It is possible to compile the package so it doesn't support some of these features (notably, Traversal).

Fields inherited from interface org.w3c.dom.ls.DOMImplementationLS

MODE_ASYNCHRONOUS, MODE_SYNCHRONOUS

Constructor Summary

DomImpl()
Constructs a DOMImplementation object which supports "XML" and other DOM Level 2 features.

Method Summary

Document
createDocument(String namespaceURI, String rootName, DocumentType doctype)
DOM L2 Creates and returns a Document, populated only with a root element and optionally a document type(if that was provided).
DocumentType
createDocumentType(String rootName, String publicId, String systemId)
DOM L2 Creates and returns a DocumentType, associated with this implementation.
LSInput
createLSInput()
Create a new empty input source object where LSInput.characterStream, LSInput.byteStream , LSInput.stringData LSInput.systemId, LSInput.publicId, LSInput.baseURI, and LSInput.encoding are null, and LSInput.certifiedText is false.
LSOutput
createLSOutput()
Create a new empty output destination object where LSOutput.characterStream, LSOutput.byteStream, LSOutput.systemId, LSOutput.encoding are null.
LSParser
createLSParser(short mode, String schemaType)
Create a new LSParser.
LSSerializer
createLSSerializer()
Create a new LSSerializer object.
Object
getFeature(String feature, String version)
This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in .
boolean
hasFeature(String name, String version)
DOM L1 Returns true if the specified feature and version are supported.

Constructor Details

DomImpl

public DomImpl()
Constructs a DOMImplementation object which supports "XML" and other DOM Level 2 features.

Method Details

createDocument

public Document createDocument(String namespaceURI,
                               String rootName,
                               DocumentType doctype)
DOM L2 Creates and returns a Document, populated only with a root element and optionally a document type(if that was provided).
Specified by:
createDocument in interface DOMImplementation


createDocumentType

public DocumentType createDocumentType(String rootName,
                                       String publicId,
                                       String systemId)
DOM L2 Creates and returns a DocumentType, associated with this implementation. This DocumentType can have no associated objects(notations, entities) until the DocumentType is first associated with a document.

Note that there is no implication that this DTD will be parsed by the DOM, or ever have contents. Moreover, the DocumentType created here can only be added to a document by the createDocument method(below). That means that the only portable way to create a Document object is to start parsing, queue comment and processing instruction (PI) nodes, and then only create a DOM Document after (a) it's known if a DocumentType object is needed, and (b) the name and namespace of the root element is known. Queued comment and PI nodes would then be inserted appropriately in the document prologue, both before and after the DTD node, and additional attributes assigned to the root element. (One hopes that the final DOM REC fixes this serious botch.)

Specified by:
createDocumentType in interface DOMImplementation


createLSInput

public LSInput createLSInput()
Create a new empty input source object where LSInput.characterStream, LSInput.byteStream , LSInput.stringData LSInput.systemId, LSInput.publicId, LSInput.baseURI, and LSInput.encoding are null, and LSInput.certifiedText is false.
Specified by:
createLSInput in interface DOMImplementationLS

Returns:
The newly created input object.


createLSOutput

public LSOutput createLSOutput()
Create a new empty output destination object where LSOutput.characterStream, LSOutput.byteStream, LSOutput.systemId, LSOutput.encoding are null.
Specified by:
createLSOutput in interface DOMImplementationLS

Returns:
The newly created output object.


createLSParser

public LSParser createLSParser(short mode,
                               String schemaType)
            throws DOMException
Create a new LSParser. The newly constructed parser may then be configured by means of its DOMConfiguration object, and used to parse documents by means of its parse method.
Specified by:
createLSParser in interface DOMImplementationLS

Parameters:
mode - The mode argument is either MODE_SYNCHRONOUS or MODE_ASYNCHRONOUS, if mode is MODE_SYNCHRONOUS then the LSParser that is created will operate in synchronous mode, if it's MODE_ASYNCHRONOUS then the LSParser that is created will operate in asynchronous mode.
schemaType - An absolute URI representing the type of the schema language used during the load of a Document using the newly created LSParser. Note that no lexical checking is done on the absolute URI. In order to create a LSParser for any kind of schema types (i.e. the LSParser will be free to use any schema found), use the value null.

Note: For W3C XML Schema [XML Schema Part 1] , applications must use the value "http://www.w3.org/2001/XMLSchema". For XML DTD [XML 1.0], applications must use the value "http://www.w3.org/TR/REC-xml". Other Schema languages are outside the scope of the W3C and therefore should recommend an absolute URI in order to use this method.

Returns:
The newly created LSParser object. This LSParser is either synchronous or asynchronous depending on the value of the mode argument.

Note: By default, the newly created LSParser does not contain a DOMErrorHandler, i.e. the value of the " error-handler" configuration parameter is null. However, implementations may provide a default error handler at creation time. In that case, the initial value of the "error-handler" configuration parameter on the new LSParser object contains a reference to the default error handler.

Throws:
DOMException - NOT_SUPPORTED_ERR: Raised if the requested mode or schema type is not supported.


createLSSerializer

public LSSerializer createLSSerializer()
Create a new LSSerializer object.
Specified by:
createLSSerializer in interface DOMImplementationLS

Returns:
The newly created LSSerializer object.

Note: By default, the newly created LSSerializer has no DOMErrorHandler, i.e. the value of the "error-handler" configuration parameter is null. However, implementations may provide a default error handler at creation time. In that case, the initial value of the "error-handler" configuration parameter on the new LSSerializer object contains a reference to the default error handler.


getFeature

public Object getFeature(String feature,
                         String version)
This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . The specialized object may also be obtained by using binding-specific casting methods but is not necessarily expected to, as discussed in . This method also allow the implementation to provide specialized objects which do not support the DOMImplementation interface.
Specified by:
getFeature in interface DOMImplementation

Parameters:
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.

Returns:
Returns an object which implements the specialized APIs of the specified feature and version, if any, or null if there is no object which implements interfaces associated with that feature. If the DOMObject returned by this method implements the DOMImplementation interface, it must delegate to the primary core DOMImplementation and not return results inconsistent with the primary core DOMImplementation such as hasFeature, getFeature, etc.

Since:
DOM Level 3


hasFeature

public boolean hasFeature(String name,
                          String version)
DOM L1 Returns true if the specified feature and version are supported. Note that the case of the feature name is ignored.
Specified by:
hasFeature in interface DOMImplementation