net.sf.saxon.option.xom.XOMObjectModel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of saxon-he Show documentation
Show all versions of saxon-he Show documentation
An OSGi bundle for Saxon-HE
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2013 Saxonica Limited.
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
package net.sf.saxon.option.xom;
import net.sf.saxon.Configuration;
import net.sf.saxon.event.Builder;
import net.sf.saxon.event.PipelineConfiguration;
import net.sf.saxon.event.Receiver;
import net.sf.saxon.expr.JPConverter;
import net.sf.saxon.expr.PJConverter;
import net.sf.saxon.expr.XPathContext;
import net.sf.saxon.lib.ExternalObjectModel;
import net.sf.saxon.lib.NamespaceConstant;
import net.sf.saxon.om.*;
import net.sf.saxon.pattern.AnyNodeTest;
import net.sf.saxon.trans.XPathException;
import net.sf.saxon.tree.wrapper.VirtualNode;
import net.sf.saxon.type.ItemType;
import net.sf.saxon.value.SequenceExtent;
import nu.xom.Document;
import nu.xom.Node;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import java.io.Serializable;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
/**
* 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 {@link #getInstance}
* method. However, the constructor is public for backwards compatibility.
*
* The class extends {@link TreeModel} so that any interface expected a TreeModel, for example
* {@link net.sf.saxon.s9api.XdmDestination#setTreeModel}, can take XOMObjectModel.getInstance()
* as an argument.
*/
public class XOMObjectModel extends TreeModel implements ExternalObjectModel, Serializable {
private static XOMObjectModel THE_INSTANCE = new XOMObjectModel();
public static XOMObjectModel getInstance() {
return THE_INSTANCE;
}
public XOMObjectModel() {}
/**
* Get the URI of the external object model as used in the JAXP factory interfaces for obtaining
* an XPath implementation
*/
public String getIdentifyingURI() {
return NamespaceConstant.OBJECT_MODEL_XOM;
}
public String getName() {
return "XOM";
}
public Builder makeBuilder(PipelineConfiguration pipe) {
return new XOMWriter(pipe);
}
/*@Nullable*/ public PJConverter getPJConverter(Class targetClass) {
if (isRecognizedNodeClass(targetClass)) {
return new PJConverter() {
public Object convert(Sequence value, Class targetClass, XPathContext context) throws XPathException {
return convertXPathValueToObject(value, targetClass);
}
};
} else {
return null;
}
}
public JPConverter getJPConverter(Class sourceClass, Configuration config) {
if (isRecognizedNodeClass(sourceClass)) {
return new JPConverter() {
public Sequence convert(Object object, XPathContext context) throws XPathException {
return convertObjectToXPathValue(object, context.getConfiguration());
}
public ItemType getItemType() {
return AnyNodeTest.getInstance();
}
};
} else {
return null;
}
}
/**
* Get a converter that converts a sequence of XPath nodes to this model's representation
* of a node list.
* @param node an example of the kind of node used in this model
* @return 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
*/
public PJConverter getNodeListCreator(Object node) {
return null;
}
/**
* Test whether this object model recognizes a given node as one of its own
*/
public boolean isRecognizedNode(Object object) {
return (object instanceof nu.xom.Node);
}
/**
* 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.
*
* @param nodeClass A class that possibly represents nodes
* @return true if the class is used to represent nodes in this object model
*/
public boolean isRecognizedNodeClass(Class nodeClass) {
return nu.xom.Node.class.isAssignableFrom(nodeClass);
}
/**
* 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.
*/
public Receiver getDocumentBuilder(Result result) {
return null;
}
/**
* 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.
*/
public boolean sendSource(Source source, Receiver receiver) throws XPathException {
return false;
}
/**
* 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
*/
public NodeInfo unravel(Source source, Configuration config) {
return null;
}
/**
* Convert a Java object to an XPath value. If the supplied object is recognized as a representation
* of a value using this object model, the object model should convert the value to an XPath value
* and return this as the result. If not, it should return null. If the object is recognized but cannot
* be converted, an exception should be thrown
*/
private Sequence convertObjectToXPathValue(Object object, Configuration config) throws XPathException {
if (object instanceof Node) {
return wrapNode((Node)object, config);
} else if (object instanceof Node[]) {
NodeInfo[] nodes = new NodeInfo[((Node[])object).length];
for (int i=0; i