net.sf.saxon.expr

Interface StaticContext

public interface StaticContext

A StaticContext contains the information needed while an expression or pattern is being parsed. The information is also sometimes needed at run-time.

Method Summary
Expression	bindVariable(StructuredQName qName) Bind a variable used in this element to the XSLVariable element in which it is declared
String	getBaseURI() Get the Base URI of the stylesheet element, for resolving any relative URI's used in the expression.
StringCollator	getCollation(String name) Get a named collation.
Configuration	getConfiguration() Get the system configuration
DecimalFormatManager	getDecimalFormatManager() Get a DecimalFormatManager to resolve the names of decimal formats used in calls to the format-number() function.
String	getDefaultCollationName() Get the name of the default collation.
String	getDefaultElementNamespace() Get the default XPath namespace for elements and types
String	getDefaultFunctionNamespace() Get the default function namespace
Executable	getExecutable() Get the executable associated with this static context.
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 namespace resolver to resolve the namespaces declared in this static context.
String	getSystemId() Get the System ID of the container of the expression.
String	getURIForPrefix(String prefix) Get the URI for a namespace prefix.
boolean	isAllowedBuiltInType(BuiltInAtomicType type) Ask whether a built-in type is available in this context.
boolean	isImportedSchema(String namespace) Ask whether a Schema for a given target namespace has been imported.
boolean	isInBackwardsCompatibleMode() Ask whether Backwards Compatible Mode is used
void	issueWarning(String message, SourceLocator locator) Issue a compile-time warning.
XPathContext	makeEarlyEvaluationContext() Construct a dynamic context for early evaluation of constant subexpressions.

Method Detail

bindVariable

public Expression bindVariable(StructuredQName qName)

Bind a variable used in this element to the XSLVariable element in which it is declared

Parameters: qName The name of the variable

Returns: an expression representing the variable reference, This will often be a VariableReference, suitably initialized to refer to the corresponding variable declaration, but in general it can be any expression.

getBaseURI

public String getBaseURI()

Get the Base URI of the stylesheet element, for resolving any relative URI's used in the expression. Used by the document(), doc(), resolve-uri(), and base-uri() functions. May return null if the base URI is not known.

Returns: the static base URI, or null if not known

getCollation

public StringCollator getCollation(String name)

Get a named collation.

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

Returns: the Saxon configuration

getDecimalFormatManager

public DecimalFormatManager getDecimalFormatManager()

Get a DecimalFormatManager to resolve the names of decimal formats used in calls to the format-number() function.

Returns: the decimal format manager for this static context, or null if named decimal formats are not supported in this environment.

getDefaultCollationName

public String getDefaultCollationName()

Get the name of the default collation.

Returns: the name of the default collation; or the name of the codepoint collation if no default collation has been defined

getDefaultElementNamespace

public String getDefaultElementNamespace()

Get the default XPath namespace for elements and types

Returns: the default namespace, or NamespaceConstant.NULL for the non-namespace

getDefaultFunctionNamespace

public String getDefaultFunctionNamespace()

Get the default function namespace

Returns: the default namespace for function names

getExecutable

public Executable getExecutable()

Get the executable associated with this static context. The Executable generally holds details of function libraries and collations. For freestanding XPath expressions, there will generally be a single executable corresponding one-to-one with the static context object, and which can be created as soon as the Configuration is known.

Returns: the Executable

getFunctionLibrary

public FunctionLibrary getFunctionLibrary()

Get the function library containing all the in-scope functions available in this static context

Returns: the function library

getImportedSchemaNamespaces

public Set getImportedSchemaNamespaces()

Get the set of imported schemas

Returns: a Set, the set of URIs representing the target namespaces of imported schemas, using the zero-length string to denote the "null" namespace.

getLineNumber

public int getLineNumber()

Get the line number of the expression within its containing entity Returns -1 if no line number is available

Returns: the line number, or -1 if not available

getLocationMap

public LocationMap getLocationMap()

Get the location map. This is a mapping from short location ids held with each expression or subexpression, to a fully-resolved location in a source stylesheet or query.

Returns: the location map

getNamePool

public NamePool getNamePool()

Get the NamePool used for compiling expressions

Returns: the name pool

getNamespaceResolver

public NamespaceResolver getNamespaceResolver()

Get a namespace resolver to resolve the namespaces declared in this static context.

Returns: a namespace resolver.

getSystemId

public String getSystemId()

Get the System ID of the container of the expression. This is the containing entity (file) and is therefore useful for diagnostics. Use getBaseURI() to get the base URI, which may be different.

Returns: the system ID

getURIForPrefix

public String getURIForPrefix(String prefix)

Get the URI for a namespace prefix. The default namespace is NOT used when the prefix is empty.

Parameters: prefix The namespace prefix.

Returns: the corresponding namespace URI

Throws: XPathException if the prefix is not declared

isAllowedBuiltInType

public boolean isAllowedBuiltInType(BuiltInAtomicType type)

Ask 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.

Parameters: type the supposedly built-in type. This will always be a type in the XS namespace.

Returns: true if this type can be used in this static context

isImportedSchema

public boolean isImportedSchema(String namespace)

Ask whether a Schema for a given target namespace has been imported. Note that the in-scope element declarations, attribute declarations and schema types are the types registered with the (schema-aware) configuration, provided that their namespace URI is registered in the static context as being an imported schema namespace. (A consequence of this is that within a Configuration, there can only be one schema for any given namespace, including the null namespace).

Parameters: namespace the target namespace in question

Returns: true if the given namespace has been imported

isInBackwardsCompatibleMode

public boolean isInBackwardsCompatibleMode()

Ask whether Backwards Compatible Mode is used

Returns: true if running in XPath 1.0 compatibility mode

issueWarning

public void issueWarning(String message, SourceLocator locator)

Issue a compile-time warning.

Parameters: message The warning message. This should not contain any prefix such as "Warning". locator the location of the construct in question. May be null.

makeEarlyEvaluationContext

public XPathContext makeEarlyEvaluationContext()

Construct a dynamic context for early evaluation of constant subexpressions.

Returns: a newly constructed dynamic context