Package com.saxonica.ee.domino
Class DominoTreeModel
java.lang.Object
net.sf.saxon.om.TreeModel
com.saxonica.ee.domino.DominoTreeModel
- All Implemented Interfaces:
ExternalObjectModel
Tree model implementation for the DOMINO tree
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
A Builder class for the Domino tree model -
Field Summary
Fields inherited from class net.sf.saxon.om.TreeModel
IMMUTABLE_LINKED_TREE, LINKED_TREE, TINY_TREE, TINY_TREE_CONDENSED
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetActiveSource
(Source supplied) Give this ExternalObjectModel the opportunity of recognising a Source object and returning an ActiveSource, which will be used to send an instance of this external model to a supplied 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.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 classpathGet the URI of the external object model as used in the JAXP factory interfaces for obtaining an XPath implementationstatic DominoTreeModel
getJPConverter
(Class sourceClass, Configuration config) Get a converter from values in the external object model to XPath values.getName()
Get a name that identifies the tree modelgetNodeListCreator
(Object node) Get a converter that converts a sequence of XPath nodes to this model's representation of a node list.getPJConverter
(Class<?> targetClass) Get a converter from XPath values to values in the external object modelint
Get the integer constant used to identify this tree model in some legacy interfacesMake a Builder, which can then be used to construct an instance of this tree model from a stream of eventsunravel
(Source source, Configuration config) Wrap or unwrap a node using this object model to return the corresponding Saxon node.Methods inherited from class net.sf.saxon.om.TreeModel
getTreeModel, isMutable, isSchemaAware
-
Constructor Details
-
DominoTreeModel
public DominoTreeModel()
-
-
Method Details
-
getInstance
-
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- Specified by:
getDocumentClassName
in interfaceExternalObjectModel
- Returns:
- by convention (but not necessarily) the class that implements a document node in the relevant external model
-
getIdentifyingURI
Get the URI of the external object model as used in the JAXP factory interfaces for obtaining an XPath implementation- Specified by:
getIdentifyingURI
in interfaceExternalObjectModel
- Returns:
- the URI used to identify this object model in the JAXP XPath factory mechanism.
-
makeBuilder
Description copied from class:TreeModel
Make a Builder, which can then be used to construct an instance of this tree model from a stream of events- Specified by:
makeBuilder
in classTreeModel
- Parameters:
pipe
- A PipelineConfiguration, which can be constructed using the methodConfiguration.makePipelineConfiguration()
.- Returns:
- a newly created Builder
-
getSymbolicValue
public int getSymbolicValue()Description copied from class:TreeModel
Get the integer constant used to identify this tree model in some legacy interfaces- Overrides:
getSymbolicValue
in classTreeModel
- Returns:
- an integer constant used to identify the model, for example
Builder.TINY_TREE
-
getName
Description copied from class:TreeModel
Get a name that identifies the tree model -
getActiveSource
Give this ExternalObjectModel the opportunity of recognising a Source object and returning an ActiveSource, which will be used to send an instance of this external model to a supplied Receiver. The default implementation returns null.- Specified by:
getActiveSource
in interfaceExternalObjectModel
- Parameters:
supplied
- a supplied Source- Returns:
- an ActiveSource object if the source is recognised, or null if not
-
getDocumentBuilder
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.This implementation always returns null (the Domino model is never used for transformation or query results)
- Specified by:
getDocumentBuilder
in interfaceExternalObjectModel
- Parameters:
result
- a JAXP result object- Returns:
- a Receiver that writes to that result, if available; or null otherwise
- Throws:
XPathException
- if any failure occurs
-
getPJConverter
Get a converter from XPath values to values in the external object model- Specified by:
getPJConverter
in interfaceExternalObjectModel
- 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
-
getJPConverter
Get a converter from values in the external object model to XPath values.- Specified by:
getJPConverter
in interfaceExternalObjectModel
- Parameters:
sourceClass
- the class (static or dynamic) of values to be convertedconfig
- the Saxon Configuration- Returns:
- a converter, if the sourceClass is recognized as belonging to this object model; otherwise null
-
getNodeListCreator
Get a converter that converts a sequence of XPath nodes to this model's representation of a node list.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
- Specified by:
getNodeListCreator
in interfaceExternalObjectModel
- 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
-
unravel
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- Specified by:
unravel
in interfaceExternalObjectModel
- Parameters:
source
- a JAXP Source objectconfig
- the Saxon configuration- Returns:
- a NodeInfo corresponding to the Source, if this can be constructed; otherwise null
-