net.sf.saxon.option.xom

Class XOMObjectModel

public class XOMObjectModel extends TreeModel 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 JDOM Documents.

This is a singleton class whose instance can be obtained using the XOMObjectModel method. However, the constructor is public for backwards compatibility.

The class extends TreeModel so that any interface expected a TreeModel, for example XdmDestination, can take XOMObjectModel.getInstance() as an argument.

Constructor Summary
XOMObjectModel()
Method Summary
ObjectconvertXPathValueToObject(Value value, Object targetClass)
Convert an XPath value to an object in this object 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 XOMObjectModelgetInstance()
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)
booleanisRecognizedNode(Object object)
Test whether this object model recognizes a given node as one of its own
booleanisRecognizedNodeClass(Class nodeClass)
Test whether this object model recognizes a given class as representing a node in that object model.
BuildermakeBuilder()
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.
DocumentInfowrapDocument(Object node, String baseURI, Configuration config)
Wrap a document node in the external object model in a document wrapper that implements the Saxon DocumentInfo interface
NodeInfowrapNode(DocumentInfo document, Object node)
Wrap a node within the external object model in a node wrapper that implements the Saxon VirtualNode interface (which is an extension of NodeInfo)

Constructor Detail

XOMObjectModel

public XOMObjectModel()

Method Detail

convertXPathValueToObject

public Object convertXPathValueToObject(Value value, Object targetClass)
Convert an XPath value to an object in this object model. If the supplied value can be converted to an object in this model, of the specified class, then the conversion should be done and the resulting object returned. If the value cannot be converted, the method should return null. Note that the supplied class might be a List, in which case the method should inspect the contents of the Value to see whether they belong to this object model.

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 XOMObjectModel getInstance()

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)

isRecognizedNode

public boolean isRecognizedNode(Object object)
Test whether this object model recognizes a given node as one of its own

isRecognizedNodeClass

public boolean isRecognizedNodeClass(Class nodeClass)
Test whether this object model recognizes a given class as representing a node in that object model. This method will generally be called at compile time.

Parameters: nodeClass A class that possibly represents nodes

Returns: true if the class is used to represent nodes in this object model

makeBuilder

public Builder makeBuilder()

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

wrapDocument

public DocumentInfo wrapDocument(Object node, String baseURI, Configuration config)
Wrap a document node in the external object model in a document wrapper that implements the Saxon DocumentInfo interface

Parameters: node a node (any node) in the third party document baseURI the base URI of the node (supply "" if unknown) config the Saxon configuration (which among other things provides access to the NamePool)

Returns: the wrapper, which must implement DocumentInfo

wrapNode

public NodeInfo wrapNode(DocumentInfo document, Object node)
Wrap a node within the external object model in a node wrapper that implements the Saxon VirtualNode interface (which is an extension of NodeInfo)

Parameters: document the document wrapper, as a DocumentInfo object node the node to be wrapped. This must be a node within the document wrapped by the DocumentInfo provided in the first argument

Returns: the wrapper for the node, as an instance of VirtualNode