B C D E G H I J M N O R S T V W X

B

BuilderFactory - class nux.xom.pool.BuilderFactory.

Creates and returns new Builder objects that validate against W3C XML Schemas, DTDs, RELAX NG, Schematron or do not validate at all (thread-safe).

BuilderFactory() - Constructor for class nux.xom.pool.BuilderFactory

Creates a factory instance for creating Builders with an underlying XMLReader that has no particular features and properties.

BuilderFactory(Map) - Constructor for class nux.xom.pool.BuilderFactory

Creates a factory instance for creating Builders with an underlying XMLReader that has the given features and properties.

BuilderPool - class nux.xom.pool.BuilderPool.

Efficient thread-safe pool/cache of XOM Builder objects, creating and holding zero or more Builders per thread.

BuilderPool() - Constructor for class nux.xom.pool.BuilderPool

Creates a new pool with default parameters.

BuilderPool(int, BuilderFactory) - Constructor for class nux.xom.pool.BuilderPool

Creates a new pool that uses the given factory on cache misses, and that can hold at most maxPoolEntries Builders.

BuilderPoolBenchmark - class nux.xom.tests.BuilderPoolBenchmark.

Benchmark / stress test of BuilderPool.

BuilderPoolBenchmark() - Constructor for class nux.xom.tests.BuilderPoolBenchmark

baseURI - Variable in class net.sf.saxon.xom.DocumentWrapper

C

compareOrder(NodeInfo) - Method in class net.sf.saxon.xom.NodeWrapper

Determine the relative position of this node and another node, in document order.

config - Variable in class net.sf.saxon.xom.DocumentWrapper

copy(Receiver, int, boolean, int) - Method in class net.sf.saxon.xom.NodeWrapper

Copy this node to a given outputter (deep copy)

createBuilder(boolean) - Method in class nux.xom.pool.BuilderFactory

Creates and returns a new validating or non-validating Builder.

createDTDBuilder(EntityResolver) - Method in class nux.xom.pool.BuilderFactory

Creates and returns a new Builder that validates against the DTD obtained by the given entity resolver.

createMSVBuilder(File) - Method in class nux.xom.pool.BuilderFactory

Creates and returns a new Builder that validates against the given MSV (Multi-Schema Validator) schema.

createNodeFactory(NodeFactory, StreamingTransform) - Method in class nux.xom.xquery.StreamingPathFilter

Creates and returns a new node factory for this path filter, to be be passed to a Builder.

createResolver(InputStream) - Method in class nux.xom.pool.BuilderFactory

Creates and returns a new EntityResolver that validates against the DTD obtained from the given input stream.

createTransform(Document) - Method in class nux.xom.pool.XSLTransformFactory

Creates and returns a new XSLTransform for the given stylesheet.

createTransform(File) - Method in class nux.xom.pool.XSLTransformFactory

Creates and returns a new XSLTransform for the given stylesheet.

createTransform(InputStream, URI) - Method in class nux.xom.pool.XSLTransformFactory

Creates and returns a new XSLTransform for the given stylesheet.

createW3CBuilder(Map) - Method in class nux.xom.pool.BuilderFactory

Creates and returns a new Builder that validates against W3C XML Schemas.

createXQuery(File) - Method in class nux.xom.pool.XQueryFactory

Creates and returns a new XQuery for the given input query.

createXQuery(String, URI) - Method in class nux.xom.pool.XQueryFactory

Creates and returns a new XQuery for the given input query, using the given base URI.

createXQuery(InputStream, URI) - Method in class nux.xom.pool.XQueryFactory

Creates and returns a new XQuery for the given input query, using the given base URI.

D

DocumentURIResolver - interface nux.xom.pool.DocumentURIResolver.

Called by the XQuery processor to turn a URI passed to the XQuery doc() function into a XOM Document object.

DocumentWrapper - class net.sf.saxon.xom.DocumentWrapper.

The root node of an XPath tree.

DocumentWrapper(Document, String, Configuration) - Constructor for class net.sf.saxon.xom.DocumentWrapper

Create a Saxon wrapper for a XOM document

docWrapper - Variable in class net.sf.saxon.xom.NodeWrapper

documentNumber - Variable in class net.sf.saxon.xom.DocumentWrapper

E

execute(ParentNode) - Method in class nux.xom.xquery.XQuery

Executes (evaluates) the query against the given node (subtree).

execute(ParentNode, DynamicQueryContext, Map) - Method in class nux.xom.xquery.XQuery

Executes (evaluates) the query against the given node (subtree), using the given dynamic context and external variables.

G

GLOBAL_POOL - Static variable in class nux.xom.pool.BuilderPool

A default pool (can be shared freely across threads without harm); global per class loader.

GLOBAL_POOL - Static variable in class nux.xom.pool.XQueryPool

A default pool (can be shared freely across threads without harm); global per class loader.

GLOBAL_POOL - Static variable in class nux.xom.pool.XSLTransformPool

A default pool (can be shared freely across threads without harm); global per class loader.

generateId() - Method in class net.sf.saxon.xom.NodeWrapper

Get a character string that uniquely identifies this node.

getAttributeValue(int) - Method in class net.sf.saxon.xom.NodeWrapper

Get the value of a given attribute of this node

getBaseURI() - Method in class net.sf.saxon.xom.NodeWrapper

Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.

getBuilder(boolean) - Method in class nux.xom.pool.BuilderPool

Returns a validating or non-validating Builder.

getConfiguration() - Method in class net.sf.saxon.xom.DocumentWrapper

Get the configuration previously set using setConfiguration

getDOMImplementation() - Static method in class nux.xom.pool.XOMUtil

Returns a DOMImplementation via the default JAXP lookup mechanism.

getDTDBuilder(EntityResolver) - Method in class nux.xom.pool.BuilderPool

Returns a Builder that validates against the DTD obtained by the given entity resolver.

getDisplayName() - Method in class net.sf.saxon.xom.NodeWrapper

Get the display name of this node.

getDocumentNumber() - Method in class net.sf.saxon.xom.DocumentWrapper

Get the unique document number for this document (the number is unique for all documents within a NamePool)

getDocumentNumber() - Method in class net.sf.saxon.xom.NodeWrapper

Get the document number of the document containing this node.

getDocumentRoot() - Method in class net.sf.saxon.xom.NodeWrapper

Get the root (document) node

getFingerprint() - Method in class net.sf.saxon.xom.NodeWrapper

Get fingerprint.

getIgnoreWhitespaceOnlyTextNodeFactory() - Static method in class nux.xom.pool.XOMUtil

Returns a node factory that removes each Text node that is empty or consists of whitespace characters only.

getLineNumber() - Method in class net.sf.saxon.xom.NodeWrapper

Get line number

getLocalPart() - Method in class net.sf.saxon.xom.NodeWrapper

Get the local part of the name of this node.

getMSVBuilder(File) - Method in class nux.xom.pool.BuilderPool

Returns a Builder that validates against the given MSV (Multi-Schema Validator) schema.

getNameCode() - Method in class net.sf.saxon.xom.NodeWrapper

Get name code.

getNamePool() - Method in class net.sf.saxon.xom.DocumentWrapper

Get the name pool used for the names in this document

getNamePool() - Method in class net.sf.saxon.xom.NodeWrapper

Get the name pool for this node

getNodeKind() - Method in class net.sf.saxon.xom.NodeWrapper

Return the type of node.

getNullNodeFactory() - Static method in class nux.xom.pool.XOMUtil

Returns a node factory for pure document validation.

getParent() - Method in class net.sf.saxon.xom.NodeWrapper

Get the NodeInfo object representing the parent of this node

getPreferredTransformerFactories() - Method in class nux.xom.pool.XSLTransformFactory

Callback that returns a search list of fully qualified class names of TRAX TransformerFactory implementations, given in order of preference from left to right.

getPrefix() - Method in class net.sf.saxon.xom.NodeWrapper

Get the prefix part of the name of this node.

getResourceAsStream(String) - Method in interface nux.xom.pool.ResourceResolver

Returns an input stream for reading the specified resource.

getRoot() - Method in class net.sf.saxon.xom.NodeWrapper

Get the root node - always a document node with this tree implementation

getSiblingPosition() - Method in class net.sf.saxon.xom.NodeWrapper

Get the index position of this node among its siblings (starting from 0)

getStringValue() - Method in class net.sf.saxon.xom.NodeWrapper

Return the string value of the node.

getSystemId() - Method in class net.sf.saxon.xom.NodeWrapper

Get the System ID for the node.

getTextTrimmingNodeFactory() - Static method in class nux.xom.pool.XOMUtil

Returns a node factory that removes leading and trailing whitespaces in each Text node, altogether removing a Text node that becomes empty after said trimming.

getTransform(Document) - Method in class nux.xom.pool.XSLTransformPool

Returns an XSLTransform for the given stylesheet.

getTransform(File) - Method in class nux.xom.pool.XSLTransformPool

Returns an XSLTransform for the given stylesheet.

getTransform(ResourceResolver, String, URI) - Method in class nux.xom.pool.XSLTransformPool

Returns an XSLTransform for the input stream obtained from resolving the given resourceName against the given resolver.

getTypeAnnotation() - Method in class net.sf.saxon.xom.NodeWrapper

Get the type annotation of this node, if any.

getTypedValue(Configuration) - Method in class net.sf.saxon.xom.NodeWrapper

Get the typed value of the item

getURI() - Method in class net.sf.saxon.xom.NodeWrapper

Get the URI part of the name of this node.

getUnderlyingNode() - Method in class net.sf.saxon.xom.NodeWrapper

Get the underlying XOM node, to implement the VirtualNode interface

getUnparsedEntity(String) - Method in class net.sf.saxon.xom.DocumentWrapper

Get the unparsed entity with a given name

getW3CBuilder(Map) - Method in class nux.xom.pool.BuilderPool

Returns a Builder that validates against W3C XML Schemas.

getXQuery(File) - Method in class nux.xom.pool.XQueryPool

Returns an XQuery for the given input query.

getXQuery(String, URI) - Method in class nux.xom.pool.XQueryPool

Returns an XQuery for the given input query, using the given base URI.

getXQuery(ResourceResolver, String, URI) - Method in class nux.xom.pool.XQueryPool

Returns an XQuery for the input stream obtained from resolving the given resourceName against the given resolver.

H

hasChildNodes() - Method in class net.sf.saxon.xom.NodeWrapper

Determine whether the node has any children.

I

index - Variable in class net.sf.saxon.xom.NodeWrapper

initFactory(TransformerFactory) - Method in class nux.xom.pool.XSLTransformFactory

Callback that initializes the supplied TransformerFactory with application-specific attributes and a URIResolver, if so desired.

isSameNodeInfo(NodeInfo) - Method in class net.sf.saxon.xom.NodeWrapper

Determine whether this is the same node as another node.

iterateAxis(byte) - Method in class net.sf.saxon.xom.NodeWrapper

Return an iteration over the nodes reached by the given axis from this node

iterateAxis(byte, NodeTest) - Method in class net.sf.saxon.xom.NodeWrapper

Return an iteration over the nodes reached by the given axis from this node

J

jaxbMarshal(Marshaller, Object) - Static method in class nux.xom.pool.XOMUtil

Marshals (serializes) the given JAXB object via the given marshaller into a new XOM Document (convenience method).

jaxbUnmarshal(Unmarshaller, ParentNode) - Static method in class nux.xom.pool.XOMUtil

Unmarshals (deserializes) the given XOM node via the given unmarshaller into a new JAXB object (convenience method).

M

main(String[]) - Static method in class nux.xom.tests.BuilderPoolBenchmark

main(String[]) - Static method in class nux.xom.tests.ValidationCommand

Run this program without any arguments to get help (including descriptions of all options).

makeWrapper(Object, DocumentWrapper) - Method in class net.sf.saxon.xom.NodeWrapper

Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface.

makeWrapper(Object, DocumentWrapper, NodeWrapper, int) - Method in class net.sf.saxon.xom.NodeWrapper

Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface.

N

NodeWrapper - class net.sf.saxon.xom.NodeWrapper.

A node in the XML parse tree representing an XML element, character content, or attribute.

NodeWrapper(Object, NodeWrapper, int) - Constructor for class net.sf.saxon.xom.NodeWrapper

This constructor is protected: nodes should be created using the wrap factory method on the DocumentWrapper class

net.sf.saxon.xom - package net.sf.saxon.xom

Low-level contributions for XOM integration with XQuery and XSLT that will become part of the Saxon-8.2 release (as already discussed with Michael Kay).

newBuilder(XMLReader, boolean) - Method in class nux.xom.pool.BuilderFactory

Callback that creates and returns a new validating or non-validating Builder for the given parser.

newResultSequence(XQueryExpression, DynamicQueryContext) - Method in class nux.xom.xquery.XQuery

Callback that returns a result sequence for the current query execution.

newTransform(Document, TransformerFactory) - Method in class nux.xom.pool.XSLTransformFactory

Callback that creates and returns a new XSLTransform for the given stylesheet and TransformerFactory.

next() - Method in interface nux.xom.xquery.ResultSequence

Returns the next node from the result sequence, or null if there are no more nodes available due too iterator exhaustion.

node - Variable in class net.sf.saxon.xom.NodeWrapper

nodeKind - Variable in class net.sf.saxon.xom.NodeWrapper

nux.xom.pool - package nux.xom.pool

Efficient and flexible pools and factories for XQueries, and XSL Transforms, as well as Builders that validate against W3C XML Schemas, DTDs, RELAX NG, Schematron, etc.

nux.xom.tests - package nux.xom.tests

JUnit tests.

nux.xom.xquery - package nux.xom.xquery

W3C XQuery support for XOM.

O

outputNamespaceNodes(Receiver, boolean) - Method in class net.sf.saxon.xom.NodeWrapper

Output all namespace nodes associated with this element.

R

ResourceResolver - interface nux.xom.pool.ResourceResolver.

Returns an input stream for a given named resource, for example a path or URL or some other form of identifier.

ResultSequence - interface nux.xom.xquery.ResultSequence.

An iterator representing an XQuery result sequence; allows to stream (pipeline) execution output, or to conveniently collect it in a batched manner.

resolve(String, String) - Method in interface nux.xom.pool.DocumentURIResolver

Called by the XQuery processor when it encounters a doc() function.

S

StreamingPathFilter - class nux.xom.xquery.StreamingPathFilter.

Streaming path filter node factory for continuous queries and/or transformations over very large or infinitely long XML input.

StreamingPathFilter(String, Map) - Constructor for class nux.xom.xquery.StreamingPathFilter

Constructs a compiled filter from the given location path and prefix --> namespaceURI map.

StreamingPathFilterException - exception nux.xom.xquery.StreamingPathFilterException.

An exception indicating a syntax error in the location path of a StreamingPathFilter.

StreamingPathFilterException(String, Throwable) - Constructor for class nux.xom.xquery.StreamingPathFilterException

Constructs an exception with the given message and underlying root cause.

StreamingPathFilterException(String) - Constructor for class nux.xom.xquery.StreamingPathFilterException

Constructs an exception with the given message.

StreamingTransform - interface nux.xom.xquery.StreamingTransform.

An application-specific callback called by the node factory of a StreamingPathFilter whenever an element matches the filter's entire location path.

selectID(String) - Method in class net.sf.saxon.xom.DocumentWrapper

Get the element with a given ID, if any

setConfiguration(Configuration) - Method in class net.sf.saxon.xom.DocumentWrapper

Set the configuration, which defines the name pool used for all names in this document.

setSystemId(String) - Method in class net.sf.saxon.xom.NodeWrapper

T

testW3CUseCases() - Method in class nux.xom.tests.XQueryTest

toByteArray(InputStream) - Static method in class nux.xom.pool.XOMUtil

Reads until end-of-stream and returns all read bytes, finally closes the stream.

toCanonicalXML(Document) - Static method in class nux.xom.pool.XOMUtil

Returns the W3C Canonical XML representation of the given document.

toNodes() - Method in interface nux.xom.xquery.ResultSequence

Returns all remaining nodes from the result sequence, collected into a list of zero or more Node objects.

toPrettyXML(Node) - Static method in class nux.xom.pool.XOMUtil

Returns a pretty-printed String representation of the given node (subtree).

toString(InputStream, Charset) - Static method in class nux.xom.pool.XOMUtil

Reads until end-of-stream and returns all read bytes as a string, finally closes the stream, converting the data with the given charset encoding, or the system's default platform encoding if charset == null.

transform(Element) - Method in interface nux.xom.xquery.StreamingTransform

Called by the node factory of a StreamingPathFilterwhenever an element matches the filter's entire location path.

V

ValidationCommand - class nux.xom.tests.ValidationCommand.

Command line program that validates a set of local XML document files against a W3C XML Schema.

W

wrap(Object) - Method in class net.sf.saxon.xom.DocumentWrapper

Wrap a node in the XOM document.

X

XOMUtil - class nux.xom.pool.XOMUtil.

Various utilities avoiding redundant code in several classes.

XQuery - class nux.xom.xquery.XQuery.

Compiled representation of a W3C XQuery (thread-safe).

XQuery(String, URI) - Constructor for class nux.xom.xquery.XQuery

Constructs a new compiled XQuery from the given query.

XQuery(String, URI, StaticQueryContext, DocumentURIResolver) - Constructor for class nux.xom.xquery.XQuery

Constructs a new compiled XQuery from the given query, base URI, static context and resolver.

XQueryException - exception nux.xom.xquery.XQueryException.

An exception indicating a static or dynamic XQuery error.

XQueryException(String, Throwable) - Constructor for class nux.xom.xquery.XQueryException

Constructs an exception with the given message and underlying root cause.

XQueryException(Throwable) - Constructor for class nux.xom.xquery.XQueryException

Constructs an exception with the given underlying root cause.

XQueryFactory - class nux.xom.pool.XQueryFactory.

Creates and returns new XQuery objects using flexible parametrization (thread-safe).

XQueryFactory() - Constructor for class nux.xom.pool.XQueryFactory

Equivalent to new XQueryFactory(null, null).

XQueryFactory(Charset, DocumentURIResolver) - Constructor for class nux.xom.pool.XQueryFactory

Creates a factory instance that uses the given DocumentResolver and character encoding.

XQueryPool - class nux.xom.pool.XQueryPool.

Efficient thread-safe pool/cache of XQuery objects, creating and holding at most maxPoolEntries XQuery objects (each representing a compiled query).

XQueryPool() - Constructor for class nux.xom.pool.XQueryPool

Creates a new pool with default parameters.

XQueryPool(int, XQueryFactory) - Constructor for class nux.xom.pool.XQueryPool

Creates a new pool that uses the given factory on cache misses, and that can hold at most maxPoolEntries queries.

XQueryTest - class nux.xom.tests.XQueryTest.

Runs the official W3C XQuery use cases (part of saxon download) against our XQuery implementation.

XQueryTest(String) - Constructor for class nux.xom.tests.XQueryTest

XSLTransformFactory - class nux.xom.pool.XSLTransformFactory.

Creates and returns new XSLTransform objects using flexible parametrization (thread-safe).

XSLTransformFactory() - Constructor for class nux.xom.pool.XSLTransformFactory

Creates a factory instance.

XSLTransformPool - class nux.xom.pool.XSLTransformPool.

Efficient thread-safe pool/cache of XOM XSLTransform objects, creating and holding at most maxPoolEntries XSLTransform objects (each representing a compiled stylesheet).

XSLTransformPool() - Constructor for class nux.xom.pool.XSLTransformPool

Creates a new pool with default parameters.

XSLTransformPool(int, XSLTransformFactory) - Constructor for class nux.xom.pool.XSLTransformPool

Creates a new pool that uses the given factory on cache misses, and that can hold at most maxPoolEntries stylesheets.

B C D E G H I J M N O R S T V W X