public class DOMObjectModel extends TreeModel implements ExternalObjectModel
LINKED_TREE, TINY_TREE, TINY_TREE_CONDENSED
Constructor and Description |
---|
DOMObjectModel()
Create an instance of the DOMObjectModel class.
|
Modifier and Type | Method and Description |
---|---|
static java.lang.Object |
convertXPathValueToObject(Sequence value,
java.lang.Class target)
Convert an XPath value to an object in this object model.
|
NodeInfo |
copy(org.w3c.dom.Node node,
TreeModel model,
Configuration config)
Copy a DOM node to create a node in a different tree model
|
Receiver |
getDocumentBuilder(javax.xml.transform.Result result)
Test whether this object model recognizes a particular kind of JAXP Result object,
and if it does, return a Receiver that builds an instance of this data model from
a sequence of events.
|
java.lang.String |
getDocumentClassName()
Get the name of a characteristic class, which, if it can be loaded, indicates that the supporting libraries
for this object model implementation are available on the classpath
|
java.lang.String |
getIdentifyingURI()
Get the URI of the external object model as used in the JAXP factory interfaces for obtaining
an XPath implementation
|
static DOMObjectModel |
getInstance()
Get a reusable instance instance of this class.
|
JPConverter |
getJPConverter(java.lang.Class sourceClass,
Configuration config)
Get a converter from values in the external object model to XPath values.
|
java.lang.String |
getName()
Get a name that identifies the tree model
|
PJConverter |
getNodeListCreator(java.lang.Object node)
Get a converter that converts a sequence of XPath nodes to this model's representation
of a node list.
|
PJConverter |
getPJConverter(java.lang.Class targetClass)
Get a converter from XPath values to values in the external object model
|
Builder |
makeBuilder(PipelineConfiguration pipe)
Make a Builder, which can then be used to construct an instance of this tree model
from a stream of events
|
static void |
sendDOMSource(javax.xml.transform.dom.DOMSource source,
Receiver receiver) |
boolean |
sendSource(javax.xml.transform.Source source,
Receiver receiver)
Test whether this object model recognizes a particular kind of JAXP Source object,
and if it does, send the contents of the document to a supplied Receiver, and return true.
|
NodeInfo |
unravel(javax.xml.transform.Source source,
Configuration config)
Wrap or unwrap a node using this object model to return the corresponding Saxon node.
|
NodeInfo |
wrap(org.w3c.dom.Node node,
Configuration config)
Wrap a DOM node using this object model to return the corresponding Saxon node.
|
getSymbolicValue, getTreeModel, isMutable, isSchemaAware
public DOMObjectModel()
When possible, use the getInstance() method in preference, as the instance is then reusable.
public static DOMObjectModel getInstance()
Note, this is not actually a singleton instance; the class also has a public constructor, which is needed to support the automatic loading of object models into the Configuration.
public java.lang.String getDocumentClassName()
getDocumentClassName
in interface ExternalObjectModel
public java.lang.String getIdentifyingURI()
getIdentifyingURI
in interface ExternalObjectModel
public java.lang.String getName()
TreeModel
public PJConverter getPJConverter(java.lang.Class targetClass)
getPJConverter
in interface ExternalObjectModel
targetClass
- the required class of the result of the conversion. If this class represents
a node or list of nodes in the external object model, the method should return a converter that takes
a native node or sequence of nodes as input and returns a node or sequence of nodes in the
external object model representation. Otherwise, it should return null.public JPConverter getJPConverter(java.lang.Class sourceClass, Configuration config)
ExternalObjectModel
getJPConverter
in interface ExternalObjectModel
sourceClass
- the class (static or dynamic) of values to be convertedpublic PJConverter getNodeListCreator(java.lang.Object node)
getNodeListCreator
in interface ExternalObjectModel
node
- an example of the kind of node used in this modelpublic Receiver getDocumentBuilder(javax.xml.transform.Result result) throws XPathException
getDocumentBuilder
in interface ExternalObjectModel
result
- a JAXP result objectXPathException
- if any failure occurspublic Builder makeBuilder(PipelineConfiguration pipe)
TreeModel
makeBuilder
in class TreeModel
pipe
- A PipelineConfiguration, which can be constructed using the method
Configuration.makePipelineConfiguration()
.public boolean sendSource(javax.xml.transform.Source source, Receiver receiver) throws XPathException
sendSource
in interface ExternalObjectModel
source
- a JAXP Source objectreceiver
- the Receiver that is to receive the data from the Source. The caller
is responsible for opening and closing the receiver.XPathException
- if any failure occurspublic static void sendDOMSource(javax.xml.transform.dom.DOMSource source, Receiver receiver) throws XPathException
XPathException
public NodeInfo wrap(org.w3c.dom.Node node, Configuration config)
node
- the DOM node to be wrappedconfig
- the Saxon Configurationpublic NodeInfo copy(org.w3c.dom.Node node, TreeModel model, Configuration config) throws XPathException
node
- the DOM node to be copiedmodel
- the target tree modelconfig
- the Saxon ConfigurationXPathException
- if the operation failspublic NodeInfo unravel(javax.xml.transform.Source source, Configuration config)
unravel
in interface ExternalObjectModel
source
- a JAXP Source objectconfig
- the Saxon configurationpublic static java.lang.Object convertXPathValueToObject(Sequence value, java.lang.Class target) throws XPathException
value
- the XPath value to be convertedtarget
- the class of object requiredXPathException
- if the target class is explicitly associated with this object model, but the
supplied value cannot be converted to the appropriate classCopyright (c) 2004-2018 Saxonica Limited. All rights reserved.