Nux 1.0
B C D E G I J M N R S T V X

B

BinaryParsingException - exception nux.xom.binary.BinaryParsingException.
An exception indicating corrupt binary XML data on deserialization input to a BinaryXMLCodec.
BinaryXMLCodec - class nux.xom.binary.BinaryXMLCodec.
Serializes (encodes) and deserializes (decodes) XOM XML documents to and from an efficient and compact custom binary XML data format (termed bnux format), without loss or change of any information.
BinaryXMLCodec() - Constructor for class nux.xom.binary.BinaryXMLCodec
Constructs an instance of this class.
BinaryXMLConverter - class nux.xom.tests.BinaryXMLConverter.
Command-line demo that converts a set of standard textual XML files to and from binary xml (bnux) files; Bnux files are indicated by a ".bnux" file name extension.
BinaryXMLTest - class nux.xom.tests.BinaryXMLTest.
Tests and benchmarks bnux format against a set of standard textual XML files.
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.

C

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(InputStream, URI) - 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.
deserialize(byte[]) - Method in class nux.xom.binary.BinaryXMLCodec
Returns the XOM document obtained by deserializing the given binary XML document (bnux document).

E

execute(Node) - Method in class nux.xom.xquery.XQuery
Executes (evaluates) the query against the given node (subtree).
execute(Node, 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.
explain() - Method in class nux.xom.xquery.XQuery
Returns a description of the compiled and optimized expression tree; useful for advanced performance diagnostics only.

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.
generateTestData(String[]) - Static method in class nux.xom.tests.XQueryBenchmark
Reads an XML file and multiplies its size by concatenating it N times.
getBuilder(boolean) - Method in class nux.xom.pool.BuilderPool
Returns a validating or non-validating Builder.
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.
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.
getMSVBuilder(URI) - Method in class nux.xom.pool.BuilderPool
Returns a Builder that validates against the given MSV (Multi-Schema Validator) schema.
getNullNodeFactory() - Static method in class nux.xom.pool.XOMUtil
Returns a node factory for pure document validation.
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.
getResourceAsStream(String) - Method in interface nux.xom.pool.ResourceResolver
Returns an input stream for reading the specified resource.
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.
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.

I

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.

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.BinaryXMLConverter
Runs the demo program.
main(String[]) - Static method in class nux.xom.tests.BinaryXMLTest
 
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).
main(String[]) - Static method in class nux.xom.tests.XQueryBenchmark
Runs the benchmark
main(String[]) - Static method in class nux.xom.tests.XQueryCommand
 
main(String[]) - Static method in class nux.xom.tests.XQueryUseCasesTest
 

N

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.
normalizeTexts(ParentNode) - Static method in class nux.xom.xquery.XQueryUtil
Recursively walks the given node subtree and merges runs of consecutive (adjacent) Text nodes (if present) into a single Text node containing their string concatenation; Empty Text nodes are removed.
nux.xom.binary - package nux.xom.binary
Serializes (encodes) and deserializes (decodes) XOM XML documents to and from an efficient and compact custom binary XML data format, without loss or change of any information.
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
Tests and example demos.
nux.xom.xquery - package nux.xom.xquery
W3C XQuery and XPath support for XOM.

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.
A forward-only iterator representing an XQuery result sequence of zero or more results; 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.
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.
serialize(Document, int) - Method in class nux.xom.binary.BinaryXMLCodec
Returns the binary XML document ( bnux document) obtained by serializing the given XOM document.

T

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.

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.
XQueryBenchmark - class nux.xom.tests.XQueryBenchmark.
Simple benchmark measuring XQuery and/or XPath performance of a given set of queries.
XQueryCommand - class nux.xom.tests.XQueryCommand.
Simple command line demo that runs a given XQuery against a set of files and prints the result sequence.
XQueryException - exception nux.xom.xquery.XQueryException.
An exception indicating a static or dynamic XQuery error.
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.
XQueryUseCasesTest - class nux.xom.tests.XQueryUseCasesTest.
Demo that runs the W3C XQuery use cases (part of saxon download) against our XQuery implementation.
XQueryUtil - class nux.xom.xquery.XQueryUtil.
Various utilities avoiding redundant code in several classes.
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.
xquery(Node, String) - Static method in class nux.xom.xquery.XQueryUtil
Executes the given W3C XQuery or XPath against the given context node (subtree); convenience method.

B C D E G I J M N R S T V X
Nux 1.0