net.sf.saxon.instruct
public class Executable extends Object implements Serializable
Constructor Summary | |
---|---|
Executable() |
Method Summary | |
---|---|
void | addQueryLibraryModule(StaticQueryContext module)
Add an XQuery library module to the configuration. |
void | addRequiredParam(int fingerprint)
Add a required parameter |
void | checkAllRequiredParamsArePresent(GlobalParameterSet params)
Check that all required parameters have been supplied |
void | fixupQueryModules(StaticQueryContext main)
Fix up global variables and functions in all query modules. |
IntHashMap | getCharacterMapIndex()
Get the index of named character maps
|
HashMap | getCollationTable()
Get the table of collations
|
IntHashMap | getCompiledGlobalVariables()
Get the index of global variables
|
Configuration | getConfiguration()
Get the configuration |
DecimalFormatManager | getDecimalFormatManager()
Get the DecimalFormatManager which handles decimal-format definitions
|
Comparator | getDefaultCollation()
Get the default collation
|
String | getDefaultCollationName()
Get the name of the default collation
|
Properties | getDefaultOutputProperties()
Get the default output properties
|
FunctionLibrary | getFunctionLibrary()
Get the library containing all the in-scope functions in the static context
|
SlotManager | getGlobalVariableMap()
Get the global variable map
|
int | getHostLanguage()
Get the host language
|
KeyManager | getKeyManager()
Get the KeyManager which handles key definitions
|
int | getLargestPatternStackFrame()
Determine the size of the stack frame needed for evaluating match patterns |
LocationMap | getLocationMap()
Get the location map |
Comparator | getNamedCollation(String name)
Find a named collation.
|
Template | getNamedTemplate(int fingerprint)
Get the named template with a given name.
|
IntHashMap | getNamedTemplateTable()
Get the named template table. |
Properties | getOutputProperties(int fingerprint)
Get a named output format
|
List | getQueryLibraryModules(String namespace)
Locate the known XQuery library modules for a given module namespace.
|
String | getReasonUnableToCompile()
Determine whether this executable can be compiled; and if it can't, return the reason why
|
RuleManager | getRuleManager()
Get the RuleManager which handles template rules
|
Mode | getStripperRules()
Get the rules determining which nodes are to be stripped from the tree
|
void | initialiseBindery(Bindery bindery)
Allocate space in bindery for all the variables needed
|
Stripper | newStripper()
Create a Stripper which handles whitespace stripping definitions
|
void | putNamedTemplate(int fingerprint, Template template)
Register the named template with a given name |
void | registerGlobalVariable(GlobalVariable variable)
Register a global variable |
void | setCharacterMapIndex(IntHashMap cmi)
Set the index of named character maps
|
void | setCollationTable(HashMap table)
Set the table of collations
|
void | setConfiguration(Configuration config)
Set the configuration |
void | setDecimalFormatManager(DecimalFormatManager dfm)
Set the DecimalFormatManager which handles decimal-format definitions
|
void | setDefaultCollationName(String name)
Set the default collation
|
void | setDefaultOutputProperties(Properties properties)
Set the default output properties (the properties for the unnamed output format)
|
void | setFunctionLibrary(FunctionLibrary functionLibrary)
Set the library containing all the in-scope functions in the static context
|
void | setHostLanguage(int language)
Set the host language |
void | setKeyManager(KeyManager km)
Set the KeyManager which handles key definitions
|
void | setLocationMap(LocationMap map)
Set the location map |
void | setOutputProperties(int fingerprint, Properties properties)
An a named output format
|
void | setPatternSlotSpace(int patternLocals)
Set the space requirements for variables used in template match patterns
|
void | setReasonUnableToCompile(String reason)
If this Executable can't be compiled, set a message explaining why |
void | setRuleManager(RuleManager rm)
Set the RuleManager that handles template rules
|
void | setStripperRules(Mode rules)
Set the rules determining which nodes are to be stripped from the tree
|
void | setStripsInputTypeAnnotations(boolean strips)
Set whether source documents are to have their type annotations stripped |
void | setStripsWhitespace(boolean strips)
Indicate that the stylesheet does some whitespace stripping
|
boolean | stripsInputTypeAnnotations()
Determine whether source documents are to have their type annotations stripped |
boolean | stripsWhitespace()
Determine whether this stylesheet does any whitespace stripping
|
Returns: the hash table that maps the names of character maps to the HashMap objects representing the character maps
Returns: a hash table that maps collation names (URIs) to objects representing the collation information
Returns: the index of global variables. This is a HashMap in which the key is the integer fingerprint of the variable name, and the value is the GlobalVariable object representing the compiled global variable
Returns: the DecimalFormatManager containing the named xsl:decimal-format definitions
Returns: a Comparator that implements the default collation
Returns: the name of the default collation; this is the code point collation URI if no other default has been set up.
Returns: the properties for the unnamed output format
Returns: the function libary
Returns: the SlotManager defining the allocation of slots to global variables
Returns: a value identifying the host language: XQUERY or XSLT or JAVA_APPLICATION
Returns: the KeyManager containing the xsl:key definitions
Parameters: name identifies the name of the collation required; null indicates that the default collation is required
Returns: the requested collation, or null if the collation is not found
Parameters: fingerprint The namepool fingerprint of the template name
Returns: The template (of highest import precedence) with this name if there is one; null if none is found.
Returns: a hash table containing entries that map the names of named templates (in the form of namePool fingerprints) to the Template objects representing the compiled xsl:template element in the stylesheet.
Parameters: fingerprint the name of the output format
Returns: properties the properties of the output format. Return null if there are no output properties with the given name
Parameters: namespace the module namespace URI
Returns: a list of items each of which is the StaticQueryContext representing a module, or null if the module namespace is unknown
Returns: null if the executable can be compiled, or a message otherwise
Returns: the RuleManager registered with setRuleManager
Returns: a Mode object containing the whitespace stripping rules. A Mode is generally a collection of template rules, but it is reused here to represent a collection of stripping rules.
Parameters: bindery The bindery to be initialized
Returns: the constructed Stripper object
Parameters: cmi a hash table that maps the names of character maps to the HashMap objects representing the character maps
Parameters: table a hash table that maps collation names (URIs) to objects representing the collation information
Parameters: dfm the DecimalFormatManager containing the named xsl:decimal-format definitions
Parameters: name the name of the default collation
Parameters: properties the output properties to be used when the unnamed output format is selected
Parameters: functionLibrary the function libary
Parameters: km the KeyManager containing the xsl:key definitions
Parameters: fingerprint the name of the output format properties the properties of the output format
Parameters: patternLocals The largest number of local variables used in the match pattern of any template rule
Parameters: rm the RuleManager containing details of all the template rules
Parameters: rules a Mode object containing the whitespace stripping rules. A Mode is generally a collection of template rules, but it is reused here to represent a collection of stripping rules.
Parameters: strips true if the stylesheet performs whitespace stripping of one or more elements.
Returns: true if the stylesheet performs whitespace stripping of one or more elements.