Package net.sf.saxon.sxpath
Class AbstractStaticContext
java.lang.Object
net.sf.saxon.sxpath.AbstractStaticContext
- All Implemented Interfaces:
StaticContext
- Direct Known Subclasses:
IndependentContext
,JAXPXPathStaticContext
,UseWhenStaticContext
An abstract and configurable implementation of the StaticContext interface,
which defines the static context of an XPath expression.
This class implements those parts of the functionality of a static context that tend to be common to most implementations: simple-valued properties such as base URI and default element namespace; availability of the standard function library; and support for collations.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected final void
addFunctionLibrary
(FunctionLibrary library) Add a function library to the list of function librariesvoid
declareCollation
(String name, StringCollator comparator, boolean isDefault) Declare a named collationGet the Base URI, for resolving any relative URI's used in the expression.getCollation
(String name) Get a named collation.Get the collation map in useint
Return the character position where the current document event ends.Get the system configurationGet a DecimalFormatManager to resolve the names of decimal formats used in calls to the format-number() function.Get the name of the default collation.Get the default namespace URI for elements and types Return NamespaceConstant.NULL (that is, the zero-length string) for the non-namespaceGet the default function namespace.Get the function library containing all the in-scope functions available in this static context.int
Get the host language (XSLT, XQuery, XPath) used to implement the code in this containerint
Get the line number of the expression within that container.Get the location map.Get the LocationProvider allowing location identifiers to be resolved.Get the NamePool used for compiling expressionsReturn the public identifier.Get the required type of the context item.Get the system ID of the container of the expression.Get the XPath language level supported, as a string.boolean
Determine whether a built-in type is available in this context.boolean
Determine whether Backwards Compatible Mode is usedboolean
Ask whether this static context is schema-awarevoid
issueWarning
(String s, SourceLocator locator) Issue a compile-time warning.Construct a dynamic context for early evaluation of constant subexpressionsvoid
setBackwardsCompatibilityMode
(boolean option) Set XPath 1.0 backwards compatibility mode on or offvoid
setBaseURI
(String baseURI) Set the base URI in the static contextvoid
setCollationMap
(CollationMap collationMap) Set a collation map to override use of the default collation map from the configurationprotected void
setConfiguration
(Configuration config) Set the Configuration.void
Set the DecimalFormatManager used to resolve the names of decimal formats used in calls to the format-number() function.void
Set the default namespace for elements and typesprotected final void
Initialize the default function library for XPath.void
Set the default function namespacevoid
Set the function library to be usedvoid
setLocationMap
(LocationMap locationMap) Set the location map, which is used for translating location identifiers into URIs and line numbersvoid
setSchemaAware
(boolean aware) Say whether this static context is schema-awarevoid
Set the XPath language level supported, as a string.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface net.sf.saxon.expr.StaticContext
bindVariable, getImportedSchemaNamespaces, getNamespaceResolver, getURIForPrefix, isImportedSchema
-
Field Details
-
usingDefaultFunctionLibrary
protected boolean usingDefaultFunctionLibrary
-
-
Constructor Details
-
AbstractStaticContext
public AbstractStaticContext()
-
-
Method Details
-
setConfiguration
Set the Configuration. This is protected so it can be used only by subclasses; the configuration will normally be set at construction time- Parameters:
config
- the configuration
-
getConfiguration
Get the system configuration- Specified by:
getConfiguration
in interfaceStaticContext
- Returns:
- the Saxon configuration
-
setCollationMap
Set a collation map to override use of the default collation map from the configuration- Parameters:
collationMap
- the collation map to be used
-
getCollationMap
Get the collation map in use- Returns:
- the collation map
-
setSchemaAware
public void setSchemaAware(boolean aware) Say whether this static context is schema-aware- Parameters:
aware
- true if this static context is schema-aware
-
isSchemaAware
public boolean isSchemaAware()Ask whether this static context is schema-aware- Specified by:
isSchemaAware
in interfaceStaticContext
- Returns:
- true if this context is schema-aware
-
setDefaultFunctionLibrary
protected final void setDefaultFunctionLibrary()Initialize the default function library for XPath. This can be overridden using setFunctionLibrary(). -
addFunctionLibrary
Add a function library to the list of function libraries- Parameters:
library
- the function library to be added
-
getHostLanguage
public int getHostLanguage()Get the host language (XSLT, XQuery, XPath) used to implement the code in this container- Returns:
- the value
Configuration.XPATH
-
makeEarlyEvaluationContext
Construct a dynamic context for early evaluation of constant subexpressions- Specified by:
makeEarlyEvaluationContext
in interfaceStaticContext
- Returns:
- a newly constructed dynamic context
-
getLocationMap
Description copied from interface:StaticContext
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.- Specified by:
getLocationMap
in interfaceStaticContext
- Returns:
- the location map
-
setLocationMap
Set the location map, which is used for translating location identifiers into URIs and line numbers- Parameters:
locationMap
- the location map to be used
-
setBaseURI
Set the base URI in the static context- Parameters:
baseURI
- the base URI of the expression
-
getBaseURI
Get the Base URI, for resolving any relative URI's used in the expression. Used by the document() function, resolve-uri(), etc.- Specified by:
getBaseURI
in interfaceStaticContext
- Returns:
- "" if no base URI has been set
-
getFunctionLibrary
Get the function library containing all the in-scope functions available in this static context. This method is called by the XPath parser when binding a function call in the XPath expression to an implementation of the function.- Specified by:
getFunctionLibrary
in interfaceStaticContext
- Returns:
- the function library
-
setFunctionLibrary
Set the function library to be used- Parameters:
lib
- the function library
-
declareCollation
Declare a named collation- Parameters:
name
- The name of the collation (technically, a URI)comparator
- The StringCollator used to implement the collating sequenceisDefault
- True if this is to be used as the default collation
-
getCollation
Get a named collation.- Specified by:
getCollation
in interfaceStaticContext
- Parameters:
name
- The name of the required collation. Supply null to get the default collation.- Returns:
- the collation identified by the given name, as set previously using declareCollation. Return null if no collation with this name is found.
-
getDefaultCollationName
Get the name of the default collation.- Specified by:
getDefaultCollationName
in interfaceStaticContext
- Returns:
- the name of the default collation; or the name of the codepoint collation if no default collation has been defined
-
getNamePool
Get the NamePool used for compiling expressions- Specified by:
getNamePool
in interfaceStaticContext
- Returns:
- the name pool
-
issueWarning
Issue a compile-time warning. This method is used during XPath expression compilation to output warning conditions. The default implementation writes the message to the error listener registered with the Configuration.- Specified by:
issueWarning
in interfaceStaticContext
- Parameters:
s
- The warning message. This should not contain any prefix such as "Warning".locator
- the location of the construct in question. May be null.
-
getSystemId
Get the system ID of the container of the expression. Used to construct error messages.- Specified by:
getSystemId
in interfaceStaticContext
- Returns:
- "" always
-
getLineNumber
public int getLineNumber()Get the line number of the expression within that container. Used to construct error messages.- Specified by:
getLineNumber
in interfaceStaticContext
- Returns:
- -1 always
-
getDefaultElementNamespace
Get the default namespace URI for elements and types Return NamespaceConstant.NULL (that is, the zero-length string) for the non-namespace- Specified by:
getDefaultElementNamespace
in interfaceStaticContext
- Returns:
- the default namespace for elements and type
-
setDefaultElementNamespace
Set the default namespace for elements and types- Parameters:
uri
- the namespace to be used for unprefixed element and type names. The value "" (or NamespaceConstant.NULL) represents the non-namespace
-
setDefaultFunctionNamespace
Set the default function namespace- Parameters:
uri
- the namespace to be used for unprefixed function names. The value "" (or NamespaceConstant.NULL) represents the non-namespace
-
getDefaultFunctionNamespace
Get the default function namespace. The value "" (or NamespaceConstant.NULL) represents the non-namespace- Specified by:
getDefaultFunctionNamespace
in interfaceStaticContext
- Returns:
- the default namesapce for functions
-
setXPathLanguageLevel
Set the XPath language level supported, as a string. The current levels supported are 2.0, and 3.0. The default is 2.0. If running XQuery 1.0, the value is "2.0"; if running XQuery 3.0, it is 3.0.- Parameters:
level
- the XPath language level- Since:
- 9.3
-
getXPathLanguageLevel
Get the XPath language level supported, as a string. The current levels supported are "2.0", and "3.0". The default is "2.0". If running XQuery 1.0, the value is "2.0"; if running XQuery 3.0, it is "3.0".- Specified by:
getXPathLanguageLevel
in interfaceStaticContext
- Returns:
- the XPath language level
- Since:
- 9.3
-
setBackwardsCompatibilityMode
public void setBackwardsCompatibilityMode(boolean option) Set XPath 1.0 backwards compatibility mode on or off- Parameters:
option
- true if XPath 1.0 compatibility mode is to be set to true; otherwise false
-
isInBackwardsCompatibleMode
public boolean isInBackwardsCompatibleMode()Determine whether Backwards Compatible Mode is used- Specified by:
isInBackwardsCompatibleMode
in interfaceStaticContext
- Returns:
- true if XPath 1.0 compatibility mode is to be set to true; otherwise false
-
isAllowedBuiltInType
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 interfaceStaticContext
- 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
-
setDecimalFormatManager
Set the DecimalFormatManager used to resolve the names of decimal formats used in calls to the format-number() function.- Parameters:
manager
- the decimal format manager for this static context, or null if no named decimal formats are available in this environment.
-
getRequiredContextItemType
Get the required type of the context item. If no type has been explicitly declared for the context item, an instance of AnyItemType (representing the type item()) is returned.- Specified by:
getRequiredContextItemType
in interfaceStaticContext
- Returns:
- the required type of the context item
- Since:
- 9.3
-
getDecimalFormatManager
Get a DecimalFormatManager to resolve the names of decimal formats used in calls to the format-number() function.- Specified by:
getDecimalFormatManager
in interfaceStaticContext
- Returns:
- the decimal format manager for this static context; a newly created empty DecimalFormatManager if none has been supplied
- Since:
- 9.2
-
getLocationProvider
Get the LocationProvider allowing location identifiers to be resolved.- Returns:
- the LocationProvider that translates location identifiers into URIs and line numbers
-
getPublicId
Return the public identifier.The return value is the public identifier of the document entity or of the external parsed entity in which the markup that triggered the event appears.
- Returns:
- null (always).
- See Also:
-
getColumnNumber
public int getColumnNumber()Return the character position where the current document event ends.- Returns:
- -1 (no column number is available).
- See Also:
-