org.apache.xml.dtm.ref.dom2dtm
public class DOM2DTM extends DTMDefaultBaseIterators
DOM2DTM
class serves up a DOM's contents via the
DTM API.
Note that it doesn't necessarily represent a full Document
tree. You can wrap a DOM2DTM around a specific node and its subtree
and the right things should happen. (I don't _think_ we currently
support DocumentFrgment nodes as roots, though that might be worth
considering.)
Note too that we do not currently attempt to track document
mutation. If you alter the DOM after wrapping DOM2DTM around it,
all bets are off.
Nested Class Summary | |
---|---|
interface | DOM2DTM.CharacterNodeHandler |
Constructor Summary | |
---|---|
DOM2DTM(DTMManager mgr, DOMSource domSource, int dtmIdentity, DTMWSFilter whiteSpaceFilter, XMLStringFactory xstringfactory, boolean doIndexing)
Construct a DOM2DTM object from a DOM node.
|
Method Summary | |
---|---|
void | dispatchCharactersEvents(int nodeHandle, ContentHandler ch, boolean normalize)
Directly call the
characters method on the passed ContentHandler for the
string-value of the given node (see http://www.w3.org/TR/xpath#data-model
for the definition of a node's string-value). |
void | dispatchToEvents(int nodeHandle, ContentHandler ch)
Directly create SAX parser events from a subtree.
|
int | getAttributeNode(int nodeHandle, String namespaceURI, String name)
Retrieves an attribute node by by qualified name and namespace URI.
|
ContentHandler | getContentHandler() getContentHandler returns "our SAX builder" -- the thing that
someone else should send SAX events to in order to extend this
DTM model.
|
DeclHandler | getDeclHandler()
Return this DTM's DeclHandler.
|
String | getDocumentTypeDeclarationPublicIdentifier()
Return the public identifier of the external subset,
normalized as described in 4.2.2 External Entities [XML]. |
String | getDocumentTypeDeclarationSystemIdentifier()
A document type declaration information item has the following properties:
1. [system identifier] The system identifier of the external subset, if
it exists. |
DTDHandler | getDTDHandler()
Return this DTM's DTDHandler.
|
int | getElementById(String elementId)
Returns the Element whose ID is given by
elementId . |
EntityResolver | getEntityResolver()
Return this DTM's EntityResolver.
|
ErrorHandler | getErrorHandler()
Return this DTM's ErrorHandler.
|
int | getHandleOfNode(Node node) Get the handle from a Node. |
LexicalHandler | getLexicalHandler()
Return this DTM's lexical handler.
|
String | getLocalName(int nodeHandle)
Given a node handle, return its XPath-style localname.
|
String | getNamespaceURI(int nodeHandle)
Given a node handle, return its DOM-style namespace URI
(As defined in Namespaces, this is the declared URI which this node's
prefix -- or default in lieu thereof -- was mapped to.)
|
Node | getNode(int nodeHandle)
Return an DOM node for the given node.
|
String | getNodeName(int nodeHandle)
Given a node handle, return its DOM-style node name. |
String | getNodeNameX(int nodeHandle)
Given a node handle, return the XPath node name. |
String | getNodeValue(int nodeHandle)
Given a node handle, return its node value. |
int | getNumberOfNodes()
Get the number of nodes that have been added. |
String | getPrefix(int nodeHandle)
Given a namespace handle, return the prefix that the namespace decl is
mapping.
|
SourceLocator | getSourceLocatorFor(int node)
No source information is available for DOM2DTM, so return
null here.
|
XMLString | getStringValue(int nodeHandle)
Get the string-value of a node as a String object
(see http://www.w3.org/TR/xpath#data-model
for the definition of a node's string-value).
|
String | getUnparsedEntityURI(String name)
The getUnparsedEntityURI function returns the URI of the unparsed
entity with the specified name in the same document as the context
node (see [3.3 Unparsed Entities]). |
boolean | isAttributeSpecified(int attributeHandle)
5. [specified] A flag indicating whether this attribute was actually
specified in the start-tag of its element, or was defaulted from the
DTD.
|
boolean | isWhitespace(int nodeHandle)
Determine if the string-value of a node is whitespace
|
boolean | needsTwoThreads() |
void | setIncrementalSAXSource(IncrementalSAXSource source) Bind an IncrementalSAXSource to this DTM. |
void | setProperty(String property, Object value)
For the moment all the run time properties are ignored by this
class.
|
Parameters: mgr The DTMManager who owns this DTM. domSource the DOM source that this DTM will wrap. dtmIdentity The DTM identity ID for this DTM. whiteSpaceFilter The white space filter for this DTM, which may be null. xstringfactory XMLString factory for creating character content. doIndexing true if the caller considers it worth it to use indexing schemes.
Parameters: nodeHandle The node ID. ch A non-null reference to a ContentHandler.
Throws: org.xml.sax.SAXException
Parameters: nodeHandle The node ID. ch A non-null reference to a ContentHandler.
Throws: org.xml.sax.SAXException
Parameters: nodeHandle int Handle of the node upon which to look up this attribute.. namespaceURI The namespace URI of the attribute to retrieve, or null. name The local name of the attribute to retrieve.
Returns: The attribute node handle with the specified name (
nodeName
) or DTM.NULL
if there is no such
attribute.
Returns: null if this model doesn't respond to SAX events, "this" if the DTM object has a built-in SAX ContentHandler, the IncrmentalSAXSource if we're bound to one and should receive the SAX stream via it for incremental build purposes...
Returns: null if this model doesn't respond to SAX Decl events.
Returns: the public identifier String object, or null if there is none.
Returns: the system identifier String object, or null if there is none.
Returns: null if this model doesn't respond to SAX dtd events.
Element
whose ID
is given by
elementId
. If no such element exists, returns
DTM.NULL
. Behavior is not defined if more than one element
has this ID
. Attributes (including those
with the name "ID") are not of type ID unless so defined by DTD/Schema
information available to the DTM implementation.
Implementations that do not know whether attributes are of type ID or
not are expected to return DTM.NULL
.
%REVIEW% Presumably IDs are still scoped to a single document, and this operation searches only within a single document, right? Wouldn't want collisions between DTMs in the same process.
Parameters: elementId The unique id
value for an element.
Returns: The handle of the matching element.
Returns: null if this model doesn't respond to SAX entity ref events.
Returns: null if this model doesn't respond to SAX error events.
%OPT% This will be pretty slow.
%REVIEW% This relies on being able to test node-identity via object-identity. DTM2DOM proxying is a great example of a case where that doesn't work. DOM Level 3 will provide the isSameNode() method to fix that, but until then this is going to be flaky.Parameters: node A node, which may be null.
Returns: The node handle or DTM.NULL
.
Returns: null if this model doesn't respond to lexical SAX events, "this" if the DTM object has a built-in SAX ContentHandler, the IncrementalSAXSource if we're bound to one and should receive the SAX stream via it for incremental build purposes...
Parameters: nodeHandle the id of the node.
Returns: String Local name of this node.
%REVIEW% Null or ""? -sb
Parameters: nodeHandle the id of the node.
Returns: String URI value of this node's namespace, or null if no namespace was resolved.
Parameters: nodeHandle The node ID.
Returns: A node representation of the DTM node.
Parameters: nodeHandle the id of the node.
Returns: String Name of this node, which may be an empty string. %REVIEW% Document when empty string is possible... %REVIEW-COMMENT% It should never be empty, should it?
Parameters: nodeHandle the id of the node.
Returns: String Name of this node, which may be an empty string.
Parameters: nodeHandle The node id.
Returns: String Value of this node, or null if not meaningful for this node type.
%REVIEW% Are you sure you want "" for no prefix?
%REVIEW-COMMENT% I think so... not totally sure. -sb
Parameters: nodeHandle the id of the node.
Returns: String prefix of this node's name, or "" if no explicit namespace prefix was given.
null
here.
Parameters: node an int
value
Returns: null
Parameters: nodeHandle The node ID.
Returns: A string object that represents the string-value of the given node.
XML processors may choose to use the System Identifier (if one is provided) to resolve the entity, rather than the URI in the Public Identifier. The details are dependent on the processor, and we would have to support some form of plug-in resolver to handle this properly. Currently, we simply return the System Identifier if present, and hope that it a usable URI or that our caller can map it to one. TODO: Resolve Public Identifiers... or consider changing function name.
If we find a relative URI reference, XML expects it to be resolved in terms of the base URI of the document. The DOM doesn't do that for us, and it isn't entirely clear whether that should be done here; currently that's pushed up to a higher level of our application. (Note that DOM Level 1 didn't store the document's base URI.) TODO: Consider resolving Relative URIs.
(The DOM's statement that "An XML processor may choose to completely expand entities before the structure model is passed to the DOM" refers only to parsed entities, not unparsed, and hence doesn't affect this function.)
Parameters: name A string containing the Entity Name of the unparsed entity.
Returns: String containing the URI of the Unparsed Entity, or an empty string if no such entity exists.
Parameters: attributeHandle the attribute handle
Returns: true
if the attribute was specified;
false
if it was defaulted.
Parameters: nodeHandle The node Handle.
Returns: Return true if the given node is whitespace.
Returns: true iff we're building this model incrementally (eg we're partnered with a IncrementalSAXSource) and thus require that the transformation and the parse run simultaneously. Guidance to the DTMManager.
Parameters: source The IncrementalSAXSource that we want to recieve events from on demand.
Parameters: property a String
value value an Object
value