net.sf.saxon.dom

Class DOMObjectModel

public class DOMObjectModel extends Object implements ExternalObjectModel, Serializable

This interface must be implemented by any third-party object model that can be wrapped with a wrapper that implements the Saxon Object Model (the NodeInfo interface). This implementation of the interface supports wrapping of DOM Documents.
Constructor Summary
DOMObjectModel()
Create an instance of the DOMObjectModel class.
Method Summary
NodeInfocopy(Node node, TreeModel model, Configuration config)
Copy a DOM node to create a node in a different tree model
ReceivergetDocumentBuilder(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.
StringgetIdentifyingURI()
Get the URI of the external object model as used in the JAXP factory interfaces for obtaining an XPath implementation
static DOMObjectModelgetInstance()
Get a reusable instance instance of this class.
JPConvertergetJPConverter(Class sourceClass)
PJConvertergetNodeListCreator(Object node)
Get a converter that converts a sequence of XPath nodes to this model's representation of a node list.
PJConvertergetPJConverter(Class targetClass)
Get a converter from XPath values to values in the external object model
booleansendSource(Source source, Receiver receiver, PipelineConfiguration pipe)
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.
NodeInfounravel(Source source, Configuration config)
Wrap or unwrap a node using this object model to return the corresponding Saxon node.
NodeInfowrap(Node node, Configuration config)
Wrap a DOM node using this object model to return the corresponding Saxon node.

Constructor Detail

DOMObjectModel

public DOMObjectModel()
Create an instance of the DOMObjectModel class.

When possible, use the getInstance() method in preference, as the instance is then reusable.

Method Detail

copy

public NodeInfo copy(Node node, TreeModel model, Configuration config)
Copy a DOM node to create a node in a different tree model

Parameters: node the DOM node to be copied model the target tree model config the Saxon Configuration

Returns: the copied node

Since: 9.2

getDocumentBuilder

public Receiver getDocumentBuilder(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. If the Result is not recognised, return null.

getIdentifyingURI

public String getIdentifyingURI()
Get the URI of the external object model as used in the JAXP factory interfaces for obtaining an XPath implementation

getInstance

public static DOMObjectModel getInstance()
Get a reusable instance instance of this class.

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.

Returns: the singleton instance

getJPConverter

public JPConverter getJPConverter(Class sourceClass)

getNodeListCreator

public PJConverter getNodeListCreator(Object node)
Get a converter that converts a sequence of XPath nodes to this model's representation of a node list.

Parameters: node an example of the kind of node used in this model

Returns: if the model does not recognize this node as one of its own, return null. Otherwise return a PJConverter that takes a list of XPath nodes (represented as NodeInfo objects) and returns a collection of nodes in this object model

getPJConverter

public PJConverter getPJConverter(Class targetClass)
Get a converter from XPath values to values in the external object model

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

Returns: a converter, if the targetClass is recognized as belonging to this object model; otherwise null

sendSource

public boolean sendSource(Source source, Receiver receiver, PipelineConfiguration pipe)
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. Otherwise, return false

unravel

public NodeInfo unravel(Source source, Configuration config)
Wrap or unwrap a node using this object model to return the corresponding Saxon node. If the supplied source does not belong to this object model, return null

wrap

public NodeInfo wrap(Node node, Configuration config)
Wrap a DOM node using this object model to return the corresponding Saxon node.

Parameters: node the DOM node to be wrapped config the Saxon Configuration

Returns: the wrapped DOM node

Since: 9.2