net.sf.saxon.s9api
Class XQueryExecutable

java.lang.Object
  extended by net.sf.saxon.s9api.XQueryExecutable

public class XQueryExecutable
extends Object

An XQueryExecutable represents the compiled form of a query. To execute the query, it must first be loaded to form an XQueryEvaluator.

An XQueryExecutable is immutable, and therefore thread-safe. It is simplest to load a new XsltTransformer each time the stylesheet is to be run. However, the XsltTransformer is serially reusable within a single thread.

An XQueryExecutable is created by using one of the compile methods on the XQueryCompiler class.


Method Summary
 XQueryExpression getUnderlyingCompiledQuery()
          Get the underlying implementation object representing the compiled stylesheet.
 XQueryEvaluator load()
          Load the stylesheet to prepare it for execution.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

load

public XQueryEvaluator load()
Load the stylesheet to prepare it for execution.

Returns:
An XsltTransformer. The returned XsltTransformer can be used to set up the dynamic context for stylesheet evaluation, and to run the stylesheet.

getUnderlyingCompiledQuery

public XQueryExpression getUnderlyingCompiledQuery()
Get the underlying implementation object representing the compiled stylesheet. This provides an escape hatch into lower-level APIs. The object returned by this method may change from release to release.

Returns:
the underlying implementation of the compiled stylesheet


Copyright (C) Michael H. Kay. All rights reserved.