public interface ExternalObjectModel
This interface is designed to enable advanced applications to implement and register new object model implementations that Saxon can then use without change. Although it is intended for external use, it cannot at this stage be considered part of the stable Saxon Public API. In particular, it is likely that the interface will grow by the addition of new methods.
For maximum integration, an object may extend TreeModel
as well as implementing
this interface. To implement TreeModel
, it must supply a Builder; in effect this
means that it will be possible to use the external object model for output as well as for
input.
Modifier and Type | Method and Description |
---|---|
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
|
JPConverter |
getJPConverter(java.lang.Class sourceClass,
Configuration config)
Get a converter from values in the external object model to XPath values.
|
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
|
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.
|
java.lang.String getDocumentClassName()
java.lang.String getIdentifyingURI()
PJConverter getPJConverter(java.lang.Class targetClass)
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.JPConverter getJPConverter(java.lang.Class sourceClass, Configuration config)
sourceClass
- the class (static or dynamic) of values to be convertedconfig
- PJConverter getNodeListCreator(java.lang.Object node)
This method is primarily for the benefit of DOM, which uses its own NodeList class to represent collections of nodes. Most other object models use standard Java collection objects such as java.util.List
node
- an example of the kind of node used in this modelReceiver getDocumentBuilder(javax.xml.transform.Result result) throws XPathException
result
- a JAXP result objectXPathException
- if any failure occursboolean sendSource(javax.xml.transform.Source source, Receiver receiver) throws XPathException
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 occursNodeInfo unravel(javax.xml.transform.Source source, Configuration config)
source
- a JAXP Source objectconfig
- the Saxon configurationCopyright (c) 2004-2018 Saxonica Limited. All rights reserved.