net.sf.saxon.style

Class Compilation

java.lang.Object

net.sf.saxon.style.Compilation

public class Compilation
extends Object

Represents an XSLT compilation episode, compiling a single package.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	TIMING

Constructor Summary

Constructors

Constructor and Description
Compilation(Configuration config, CompilerInfo info) Create a compilation object ready to perform an XSLT compilation

Method Summary

Methods

Modifier and Type	Method and Description
StylesheetPackage	compilePackage(Source source) Compile a stylesheet package
static PreparedStylesheet	compileSingletonPackage(Configuration config, CompilerInfo compilerInfo, Source source) Static factory method: Compile an XSLT stylesheet consisting of a single package
void	declareStaticVariable(StructuredQName name, GroundedValue value, NestedIntegerValue precedence) Declare a static variable
CompilerInfo	getCompilerInfo() Get the compilation options used by this compilation
Configuration	getConfiguration() Get the Saxon Configuration used by this Compilation
int	getErrorCount() Get the number of errors reported so far
Stack<DocumentURI>	getImportStack() Get the stack of include/imports, used to detect circularities
LocationMap	getLocationMap() Get the LocationMap which keeps track of module and line number information for diagnostics
PackageData	getPackageData() Get information about the package that was compiled in the course of this Compilation
GroundedValue	getStaticVariable(StructuredQName name) Get the value of a static variable
StyleNodeFactory	getStyleNodeFactory(boolean topLevel) Get the StyleNodeFactory used to build the stylesheet tree
Map<DocumentURI,DocumentInfo>	getStylesheetModules() Get the map of stylesheet modules.
StylesheetPackage	getStylesheetPackage() Get the (most recent) stylesheet package compiled using this Compilation
DecimalValue	getVersion() Get the XSLT version number that appeared at the outermost level of the root module (typically the version attribute on the xsl:package or xsl:stylesheet element)
boolean	isSchemaAware() Ask whether this compilation is schema-aware.
void	reportError(XPathException err) Report a compile time error.
void	reportWarning(XPathException err) Report a compile time warning.
void	setSchemaAware(boolean schemaAware) Say that this compilation is schema-aware.
void	setVersion(DecimalValue v) Internal method called during the compilation of a package to register the XSLT version number that appeared at the outermost level of the root module (typically the version attribute on the xsl:package or xsl:stylesheet element)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TIMING

public static final boolean TIMING

See Also:

Constant Field Values

Constructor Detail

Compilation

public Compilation(Configuration config,
           CompilerInfo info)

Create a compilation object ready to perform an XSLT compilation

Parameters:

config - the Saxon Configuration

info - compilation options

Method Detail

compileSingletonPackage

public static PreparedStylesheet compileSingletonPackage(Configuration config,
                                         CompilerInfo compilerInfo,
                                         Source source)
                                                  throws XPathException

Static factory method: Compile an XSLT stylesheet consisting of a single package

Parameters:

config - the Saxon Configuration

compilerInfo - the compilation options

source - the source of the root stylesheet module in the package to be compiled. This may contain an xsl:package element at its root, or it may be a conventional xsl:stylesheet or xsl:transform, or a "simplified stylesheet" rooted at a literal result element

Returns:

the PreparedStylesheet representing the result of the compilation

Throws:

XPathException - if any errors occur. The errors will have been reported to the ErrorListener contained in the CompilerInfo.

compilePackage

public StylesheetPackage compilePackage(Source source)
                                 throws XPathException

Compile a stylesheet package

Parameters:

source - the XML document containing the top-level stylesheet module in the package, which may be an xsl:package element, an xsl:stylesheet or xsl:transform element, or a "simplified stylesheet" rooted at a literal result element

Returns:

the StylesheetPackage representing the result of the compilation

Throws:

XPathException - if any error occurs while compiling the package

getConfiguration

public Configuration getConfiguration()

Get the Saxon Configuration used by this Compilation

Returns:

the Saxon Configuration

getLocationMap

public LocationMap getLocationMap()

Get the LocationMap which keeps track of module and line number information for diagnostics

Returns:

the LocationMap

getCompilerInfo

public CompilerInfo getCompilerInfo()

Get the compilation options used by this compilation

Returns:

the compilation options

getPackageData

public PackageData getPackageData()

Get information about the package that was compiled in the course of this Compilation

Returns:

package information

setVersion

public void setVersion(DecimalValue v)

Internal method called during the compilation of a package to register the XSLT version number that appeared at the outermost level of the root module (typically the version attribute on the xsl:package or xsl:stylesheet element)

Parameters:

v - the version number as a decimal value

getVersion

public DecimalValue getVersion()

Get the XSLT version number that appeared at the outermost level of the root module (typically the version attribute on the xsl:package or xsl:stylesheet element)

Returns:

the XSLT version number, assuming it has already been read; otherwise null.

isSchemaAware

public boolean isSchemaAware()

Ask whether this compilation is schema-aware. It is schema-aware either if this is explicitly requested in the supplied CompilerInfo, or if this is explicitly requested within the stylesheet source code, for example by the presence of an xsl:import-schema declaration or a validation attribute

Returns:

true if the compilation is schema-aware

setSchemaAware

public void setSchemaAware(boolean schemaAware)

Say that this compilation is schema-aware. This method is called internally during the course of a compilation if an xsl:import-schema declaration is encountered.

Parameters:

schemaAware - true if the compilation is schema-aware.

getStyleNodeFactory

public StyleNodeFactory getStyleNodeFactory(boolean topLevel)

Get the StyleNodeFactory used to build the stylesheet tree

Parameters:

topLevel - true if the factory is for the top-level (package) module of a package

Returns:

the StyleNodeFactory

getStylesheetPackage

public StylesheetPackage getStylesheetPackage()

Get the (most recent) stylesheet package compiled using this Compilation

Returns:

the most recent stylesheet package compiled

reportError

public void reportError(XPathException err)

Report a compile time error. This calls the errorListener to output details of the error, and increments an error count.

Parameters:

err - the exception containing details of the error

getErrorCount

public int getErrorCount()

Get the number of errors reported so far

Returns:

the number of errors reported

reportWarning

public void reportWarning(XPathException err)

Report a compile time warning. This calls the errorListener to output details of the warning.

Parameters:

err - an exception holding details of the warning condition to be reported

declareStaticVariable

public void declareStaticVariable(StructuredQName name,
                         GroundedValue value,
                         NestedIntegerValue precedence)
                           throws XPathException

Declare a static variable

Parameters:

name - the name of the variable

value - the value of the variable

precedence - the import precedence in the form of a "decimal" value (e.g. 2.14.6)

Throws:

XPathException - if, for example, the value of the variable is incompatible with other variables having the same name

getStaticVariable

public GroundedValue getStaticVariable(StructuredQName name)

Get the value of a static variable

Parameters:

name - the name of the required variable

Returns:

the value of the variable if there is one, or null if the variable is undeclared

getStylesheetModules

public Map<DocumentURI,DocumentInfo> getStylesheetModules()

Get the map of stylesheet modules. This includes an entry for every stylesheet module in the compilation; the key is the absolute URI, and the value is the corresponding document.

Returns:

the map from absolute URIs to (documents containing) stylesheet modules

getImportStack

public Stack<DocumentURI> getImportStack()

Get the stack of include/imports, used to detect circularities

Returns:

the include/import stack