net.sf.saxon.style

Class ExpressionContext

Implemented Interfaces:
StaticContext, XSLTStaticContext

public class ExpressionContext
extends java.lang.Object
implements XSLTStaticContext

An ExpressionContext represents the context for an XPath expression written in the stylesheet.

Constructor Summary

ExpressionContext(StyleElement styleElement)
Create a static context for XPath expressions in an XSLT stylesheet

Method Summary

VariableReference
bindVariable(StructuredQName qName)
Bind a variable to an object that can be used to refer to it
String
getBaseURI()
Get the Base URI of the element containing the expression, for resolving any relative URI's used in the expression.
StringCollator
getCollation(String name)
Get a named collation.
Configuration
getConfiguration()
Get the system configuration
String
getDefaultCollationName()
Get the default collation.
String
getDefaultElementNamespace()
Get the default XPath namespace for elements and types Return NamespaceConstant.NULL for the non-namespace
String
getDefaultFunctionNamespace()
Get the default function namespace
Executable
getExecutable()
Get the executable
int
getFingerprint(String qname, boolean useDefault)
Get a fingerprint for a name, using this as the context for namespace resolution
FunctionLibrary
getFunctionLibrary()
Get the function library containing all the in-scope functions available in this static context
Set
getImportedSchemaNamespaces()
Get the set of imported schemas
int
getLineNumber()
Get the line number of the expression within its containing entity Returns -1 if no line number is available
LocationMap
getLocationMap()
Get the location map
NamePool
getNamePool()
Get the NamePool used for compiling expressions
NamespaceResolver
getNamespaceResolver()
Get a copy of the Namespace Context
StructuredQName
getStructuredQName(String qname, boolean useDefault)
Get a StructuredQName for a name, using this as the context for namespace resolution
StyleElement
getStyleElement()
Get the stylesheet element containing this XPath expression
String
getSystemId()
Get the System ID of the entity containing the expression (used for diagnostics)
String
getURIForPrefix(String prefix)
Get the URI for a prefix, using this Element as the context for namespace resolution.
XSLStylesheet
getXSLStylesheet()
Get the XSLStylesheet object
boolean
isAllowedBuiltInType(BuiltInAtomicType type)
Determine whether a built-in type is available in this context.
boolean
isElementAvailable(String qname)
Determine if an extension element is available
boolean
isImportedSchema(String namespace)
Test whether a schema has been imported for a given namespace
boolean
isInBackwardsCompatibleMode()
Determine whether Backwards Compatible Mode is used
void
issueWarning(String s, SourceLocator locator)
Issue a compile-time warning
XPathContext
makeEarlyEvaluationContext()
Construct a dynamic context for early evaluation of constant subexpressions

Constructor Details

ExpressionContext

public ExpressionContext(StyleElement styleElement)
Create a static context for XPath expressions in an XSLT stylesheet
Parameters:
styleElement - the element on which the XPath expression appears

Method Details

bindVariable

public VariableReference bindVariable(StructuredQName qName)
            throws XPathException
Bind a variable to an object that can be used to refer to it
Specified by:
bindVariable in interface StaticContext
Parameters:
qName - the name of the variable
Returns:
a VariableDeclaration object that can be used to identify it in the Bindery
Throws:
XPathException - if the variable has not been declared

getBaseURI

public String getBaseURI()
Get the Base URI of the element containing the expression, for resolving any relative URI's used in the expression. Used by the document() function.
Specified by:
getBaseURI in interface StaticContext

getCollation

public StringCollator getCollation(String name)
Get a named collation.
Specified by:
getCollation in interface StaticContext
Parameters:
name - The name of the required collation. Supply null to get the default collation.
Returns:
the collation; or null if the required collation is not found.

getConfiguration

public Configuration getConfiguration()
Get the system configuration
Specified by:
getConfiguration in interface StaticContext

getDefaultCollationName

public String getDefaultCollationName()
Get the default collation. Return null if no default collation has been defined
Specified by:
getDefaultCollationName in interface StaticContext

getDefaultElementNamespace

public String getDefaultElementNamespace()
Get the default XPath namespace for elements and types Return NamespaceConstant.NULL for the non-namespace
Specified by:
getDefaultElementNamespace in interface StaticContext

getDefaultFunctionNamespace

public String getDefaultFunctionNamespace()
Get the default function namespace
Specified by:
getDefaultFunctionNamespace in interface StaticContext

getExecutable

public Executable getExecutable()
Get the executable
Returns:
the executable

getFingerprint

public int getFingerprint(String qname,
                          boolean useDefault)
            throws XPathException
Get a fingerprint for a name, using this as the context for namespace resolution
Parameters:
qname - The name as written, in the form "[prefix:]localname"
useDefault - Defines the action when there is no prefix. If true, use the default namespace URI (as for element names). If false, use no namespace URI (as for attribute names).
Returns:
-1 if the name is not already present in the name pool

getFunctionLibrary

public FunctionLibrary getFunctionLibrary()
Get the function library containing all the in-scope functions available in this static context
Specified by:
getFunctionLibrary in interface StaticContext

getImportedSchemaNamespaces

public Set getImportedSchemaNamespaces()
Get the set of imported schemas
Specified by:
getImportedSchemaNamespaces in interface StaticContext
Returns:
a Set, the set of URIs representing the names of imported schemas

getLineNumber

public int getLineNumber()
Get the line number of the expression within its containing entity Returns -1 if no line number is available
Specified by:
getLineNumber in interface StaticContext

getLocationMap

public LocationMap getLocationMap()
Get the location map
Specified by:
getLocationMap in interface StaticContext

getNamePool

public NamePool getNamePool()
Get the NamePool used for compiling expressions
Specified by:
getNamePool in interface StaticContext

getNamespaceResolver

public NamespaceResolver getNamespaceResolver()
Get a copy of the Namespace Context
Specified by:
getNamespaceResolver in interface StaticContext

getStructuredQName

public StructuredQName getStructuredQName(String qname,
                                          boolean useDefault)
            throws XPathException
Get a StructuredQName for a name, using this as the context for namespace resolution
Parameters:
qname - The name as written, in the form "[prefix:]localname"
useDefault - Defines the action when there is no prefix. If true, use the default namespace URI (as for element names). If false, use no namespace URI (as for attribute names).
Returns:
-1 if the name is not already present in the name pool

getStyleElement

public StyleElement getStyleElement()
Get the stylesheet element containing this XPath expression
Returns:
the element in the tree representation of the source stylesheet

getSystemId

public String getSystemId()
Get the System ID of the entity containing the expression (used for diagnostics)
Specified by:
getSystemId in interface StaticContext

getURIForPrefix

public String getURIForPrefix(String prefix)
            throws XPathException
Get the URI for a prefix, using this Element as the context for namespace resolution. The default namespace will not be used when the prefix is empty.
Specified by:
getURIForPrefix in interface StaticContext
Parameters:
prefix - The prefix
Throws:
XPathException - if the prefix is not declared

getXSLStylesheet

public XSLStylesheet getXSLStylesheet()
Get the XSLStylesheet object
Returns:
the XSLStylesheet object representing the outermost element of the stylesheet module

isAllowedBuiltInType

public boolean isAllowedBuiltInType(BuiltInAtomicType type)
Determine whether a built-in type is available in this context. This method caters for differences between host languages as to which set of types are built in.
Specified by:
isAllowedBuiltInType in interface StaticContext
Parameters:
type - the supposedly built-in type. This will always be a type in the XS or XDT namespace.
Returns:
true if this type can be used in this static context

isElementAvailable

public boolean isElementAvailable(String qname)
            throws XPathException
Determine if an extension element is available
Specified by:
isElementAvailable in interface XSLTStaticContext
Throws:
XPathException - if the name is invalid or the prefix is not declared

isImportedSchema

public boolean isImportedSchema(String namespace)
Test whether a schema has been imported for a given namespace
Specified by:
isImportedSchema in interface StaticContext
Parameters:
namespace - the target namespace of the required schema
Returns:
true if a schema for this namespace has been imported

isInBackwardsCompatibleMode

public boolean isInBackwardsCompatibleMode()
Determine whether Backwards Compatible Mode is used
Specified by:
isInBackwardsCompatibleMode in interface StaticContext

issueWarning

public void issueWarning(String s,
                         SourceLocator locator)
Issue a compile-time warning
Specified by:
issueWarning in interface StaticContext

makeEarlyEvaluationContext

public XPathContext makeEarlyEvaluationContext()
Construct a dynamic context for early evaluation of constant subexpressions
Specified by:
makeEarlyEvaluationContext in interface StaticContext