Package net.sf.saxon.dom
Class DOMEnvelope
- java.lang.Object
-
- net.sf.saxon.dom.DOMEnvelope
-
- All Implemented Interfaces:
ExternalObjectModel
public class DOMEnvelope extends java.lang.Object implements ExternalObjectModel
DOMEnvelope is an object model representation in which DOM interfaces are wrapped around Saxon NodeInfo nodes: that is, it implements the DOM on top of a Saxon tree implementation such as the tiny tree or linked tree.
-
-
Constructor Summary
Constructors Constructor Description DOMEnvelope()Public constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ReceivergetDocumentBuilder(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.StringgetDocumentClassName()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 classpathjava.lang.StringgetIdentifyingURI()Get the URI of the external object model as used in the JAXP factory interfaces for obtaining an XPath implementationstatic DOMEnvelopegetInstance()Get the singular instance (this class is stateless)JPConvertergetJPConverter(java.lang.Class sourceClass, Configuration config)Get a converter from values in the external object model to XPath values.PJConvertergetNodeListCreator(java.lang.Object node)Get a converter that converts a sequence of XPath nodes to this model's representation of a node list.PJConvertergetPJConverter(java.lang.Class<?> targetClass)Get a converter from XPath values to values in the external object modelbooleanisRecognizedNode(java.lang.Object object)Test whether this object model recognizes a given node as one of its ownbooleanisRecognizedNodeClass(java.lang.Class nodeClass)Test whether this object model recognizes a given class as representing a node in that object model.booleansendSource(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.NodeInfounravel(javax.xml.transform.Source source, Configuration config)Wrap or unwrap a node using this object model to return the corresponding Saxon node.
-
-
-
Method Detail
-
getInstance
public static DOMEnvelope getInstance()
Get the singular instance (this class is stateless)- Returns:
- the singular instance
-
getDocumentClassName
public 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- Specified by:
getDocumentClassNamein interfaceExternalObjectModel- Returns:
- by convention (but not necessarily) the class that implements a document node in the relevant external model
-
getIdentifyingURI
public java.lang.String getIdentifyingURI()
Get the URI of the external object model as used in the JAXP factory interfaces for obtaining an XPath implementation- Specified by:
getIdentifyingURIin interfaceExternalObjectModel- Returns:
- the URI used to identify this object model in the JAXP XPath factory mechanism.
-
getPJConverter
public PJConverter getPJConverter(java.lang.Class<?> targetClass)
Description copied from interface:ExternalObjectModelGet a converter from XPath values to values in the external object model- Specified by:
getPJConverterin 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
public JPConverter getJPConverter(java.lang.Class sourceClass, Configuration config)
Description copied from interface:ExternalObjectModelGet a converter from values in the external object model to XPath values.- Specified by:
getJPConverterin interfaceExternalObjectModel- Parameters:
sourceClass- the class (static or dynamic) of values to be convertedconfig- the Saxon Configuration object- Returns:
- a converter, if the sourceClass is recognized as belonging to this object model; otherwise null
-
getNodeListCreator
public 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.- Specified by:
getNodeListCreatorin 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
-
isRecognizedNode
public boolean isRecognizedNode(java.lang.Object object)
Test whether this object model recognizes a given node as one of its own- Parameters:
object- the object to be tested- Returns:
- true if the supplied object is a node in this object model
-
isRecognizedNodeClass
public boolean isRecognizedNodeClass(java.lang.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
-
getDocumentBuilder
public 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. If the Result is not recognised, return null.This implementation always returns null: it is not possible to construct an instance of this object model implementation directly as the result of a JAXP transformation.
- Specified by:
getDocumentBuilderin interfaceExternalObjectModel- Parameters:
result- a JAXP result object- Returns:
- always null in this implementation
-
sendSource
public boolean sendSource(javax.xml.transform.Source source, Receiver receiver) throws XPathExceptionTest 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.This implementation returns true only if the source is a DOMSource whose contained node is a a "NodeOverNodeInfo".
- Specified by:
sendSourcein interfaceExternalObjectModel- Parameters:
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.- Returns:
- true if the data from the Source has been sent to the Receiver, false otherwise
- Throws:
XPathException- if any failure occurs
-
unravel
public NodeInfo unravel(javax.xml.transform.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- Specified by:
unravelin interfaceExternalObjectModel- Parameters:
source- a JAXP Source objectconfig- the Saxon configuration- Returns:
- a NodeInfo corresponding to the Source, if this can be constructed; otherwise null
-
-