|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.sf.saxon.om.TreeModel
net.sf.saxon.option.xom.XOMObjectModel
public class XOMObjectModel
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 getInstance()
method. However, the constructor is public for backwards compatibility.
The class extends TreeModel so that any interface expected a TreeModel, for example
XdmDestination.setTreeModel(net.sf.saxon.om.TreeModel), can take XOMObjectModel.getInstance()
as an argument.
| Field Summary |
|---|
| Fields inherited from class net.sf.saxon.om.TreeModel |
|---|
LINKED_TREE, TINY_TREE, TINY_TREE_CONDENSED |
| Constructor Summary | |
|---|---|
XOMObjectModel()
|
|
| Method Summary | |
|---|---|
Object |
convertXPathValueToObject(Value value,
Object targetClass)
Convert an XPath value to an object in this object model. |
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. |
String |
getIdentifyingURI()
Get the URI of the external object model as used in the JAXP factory interfaces for obtaining an XPath implementation |
static XOMObjectModel |
getInstance()
|
JPConverter |
getJPConverter(Class sourceClass)
Get a converter from values in the external object model to XPath values. |
PJConverter |
getNodeListCreator(Object node)
Get a converter that converts a sequence of XPath nodes to this model's representation of a node list. |
PJConverter |
getPJConverter(Class targetClass)
Get a converter from XPath values to values in the external object model |
boolean |
isRecognizedNode(Object object)
Test whether this object model recognizes a given node as one of its own |
boolean |
isRecognizedNodeClass(Class nodeClass)
Test whether this object model recognizes a given class as representing a node in that object model. |
Builder |
makeBuilder(PipelineConfiguration pipe)
Make a Builder to construct an instance of this tree model from a stream of events |
boolean |
sendSource(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(Source source,
Configuration config)
Wrap or unwrap a node using this object model to return the corresponding Saxon node. |
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 |
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) |
| Methods inherited from class net.sf.saxon.om.TreeModel |
|---|
getSymbolicValue, getTreeModel, isMutable |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public XOMObjectModel()
| Method Detail |
|---|
public static XOMObjectModel getInstance()
public String getIdentifyingURI()
getIdentifyingURI in interface ExternalObjectModelpublic Builder makeBuilder(PipelineConfiguration pipe)
TreeModel
makeBuilder in class TreeModelpublic PJConverter getPJConverter(Class targetClass)
ExternalObjectModel
getPJConverter in interface ExternalObjectModeltargetClass - 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(Class sourceClass)
ExternalObjectModel
getJPConverter in interface ExternalObjectModelsourceClass - the class (static or dynamic) of values to be converted
public PJConverter getNodeListCreator(Object node)
getNodeListCreator in interface ExternalObjectModelnode - an example of the kind of node used in this model
public boolean isRecognizedNode(Object object)
public boolean isRecognizedNodeClass(Class nodeClass)
nodeClass - A class that possibly represents nodes
public Receiver getDocumentBuilder(Result result)
getDocumentBuilder in interface ExternalObjectModelresult - a JAXP result object
public boolean sendSource(Source source,
Receiver receiver)
throws XPathException
sendSource in interface ExternalObjectModelsource - a JAXP Source objectreceiver - the Receiver that is to receive the data from the Source
XPathException - if any failure occurs
public NodeInfo unravel(Source source,
Configuration config)
unravel in interface ExternalObjectModelsource - a JAXP Source objectconfig - the Saxon configuration
public Object convertXPathValueToObject(Value value,
Object targetClass)
throws XPathException
XPathException
public DocumentInfo wrapDocument(Object node,
String baseURI,
Configuration config)
node - a node (any node) in the third party documentbaseURI - the base URI of the node (supply "" if unknown)config - the Saxon configuration (which among other things provides access to the NamePool)
public NodeInfo wrapNode(DocumentInfo document,
Object node)
document - the document wrapper, as a DocumentInfo objectnode - the node to be wrapped. This must be a node within the document wrapped by the
DocumentInfo provided in the first argument
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||