net.sf.saxon.style

Class UseWhenStaticContext

Implemented Interfaces:
Container, Serializable, SourceLocator, StaticContext, XSLTStaticContext

public class UseWhenStaticContext
extends AbstractStaticContext
implements XSLTStaticContext, Container

This class implements the static context used for evaluating use-when expressions in XSLT 2.0

Field Summary

FunctionLibrary
functionLibrary
NamespaceResolver
namespaceContext
StyleNodeFactory
nodeFactory

Constructor Summary

UseWhenStaticContext(Configuration config, NamespaceResolver namespaceContext)
Create a static context for evaluating use-when expressions

Method Summary

VariableReference
bindVariable(StructuredQName qName)
Bind a variable used in this element to the XSLVariable element in which it is declared
StringCollator
getCollation(String name)
Get a named collation.
String
getDefaultCollationName()
Get the name of the default collation.
String
getDefaultFunctionNamespace()
Get the default function namespace
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
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)
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)
Determine whether a Schema for a given target namespace has been imported.
boolean
isInBackwardsCompatibleMode()
Determine whether Backwards Compatible Mode is used
void
issueWarning(String s, SourceLocator locator)
Issue a compile-time warning

Methods inherited from class net.sf.saxon.sxpath.AbstractStaticContext

addFunctionLibrary, declareCollation, getBaseURI, getCollation, getColumnNumber, getConfiguration, getDefaultCollationName, getDefaultElementNamespace, getDefaultFunctionNamespace, getExecutable, getFunctionLibrary, getHostLanguage, getLineNumber, getLocationMap, getLocationProvider, getNamePool, getPublicId, getSystemId, isAllowedBuiltInType, isInBackwardsCompatibleMode, issueWarning, makeEarlyEvaluationContext, replaceSubExpression, setBackwardsCompatibilityMode, setBaseURI, setConfiguration, setDefaultElementNamespace, setDefaultFunctionLibrary, setDefaultFunctionNamespace, setFunctionLibrary, setLocationMap

Field Details

functionLibrary

public FunctionLibrary functionLibrary

namespaceContext

public NamespaceResolver namespaceContext

nodeFactory

public StyleNodeFactory nodeFactory

Constructor Details

UseWhenStaticContext

public UseWhenStaticContext(Configuration config,
                            NamespaceResolver namespaceContext)
Create a static context for evaluating use-when expressions
Parameters:
config - the Saxon configuration
namespaceContext - the namespace context in which the use-when expression appears

Method Details

bindVariable

public VariableReference bindVariable(StructuredQName qName)
            throws XPathException
Bind a variable used in this element to the XSLVariable element in which it is declared
Specified by:
bindVariable in interface StaticContext
Parameters:
qName - the name of the variable

getCollation

public StringCollator getCollation(String name)
Get a named collation.
Specified by:
getCollation in interface StaticContext
Overrides:
getCollation in interface AbstractStaticContext
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.

getDefaultCollationName

public String getDefaultCollationName()
Get the name of the default collation.
Specified by:
getDefaultCollationName in interface StaticContext
Overrides:
getDefaultCollationName in interface AbstractStaticContext
Returns:
the name of the default collation; or the name of the codepoint collation if no default collation has been defined

getDefaultFunctionNamespace

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

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
Overrides:
getFunctionLibrary in interface AbstractStaticContext

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

getNamespaceResolver

public NamespaceResolver getNamespaceResolver()
Get a namespace resolver to resolve the namespaces declared in this static context.
Specified by:
getNamespaceResolver in interface StaticContext
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.
Specified by:
getSystemId in interface StaticContext
Overrides:
getSystemId in interface AbstractStaticContext

getURIForPrefix

public String getURIForPrefix(String prefix)
            throws XPathException
Get the URI for a namespace prefix. The default namespace is NOT used when the prefix is empty.
Specified by:
getURIForPrefix in interface StaticContext
Parameters:
prefix - The prefix
Throws:
XPathException - if the prefix is not declared

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
Overrides:
isAllowedBuiltInType in interface AbstractStaticContext
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)
Determine 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).
Specified by:
isImportedSchema in interface StaticContext

isInBackwardsCompatibleMode

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

issueWarning

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