java.io.Serializable
public class Executable
extends java.lang.Object
implements java.io.Serializable
Constructor | Description |
---|---|
Executable() |
Modifier and Type | Method | Description |
---|---|---|
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
|
CollationMap |
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
|
java.util.Comparator |
getDefaultCollation() |
Get the default collation
|
java.lang.String |
getDefaultCollationName() |
Get the name of the default collation
|
java.util.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
|
java.util.Comparator |
getNamedCollation(java.lang.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.
|
java.util.Properties |
getOutputProperties(int fingerprint) |
Get a named output format
|
java.util.List |
getQueryLibraryModules(java.lang.String namespace) |
Locate the known XQuery library modules for a given module namespace.
|
java.lang.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(CollationMap 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(java.lang.String name) |
Set the default collation
|
void |
setDefaultOutputProperties(java.util.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,
java.util.Properties properties) |
An a named output format
|
void |
setPatternSlotSpace(int patternLocals) |
Set the space requirements for variables used in template match patterns
|
void |
setReasonUnableToCompile(java.lang.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
|
public void setConfiguration(Configuration config)
public Configuration getConfiguration()
public void setHostLanguage(int language)
public int getHostLanguage()
Configuration.XQUERY
or Configuration.XSLT
or Configuration.JAVA_APPLICATION
public void setRuleManager(RuleManager rm)
rm
- the RuleManager containing details of all the template rulespublic RuleManager getRuleManager()
public IntHashMap getNamedTemplateTable()
public Template getNamedTemplate(int fingerprint)
fingerprint
- The namepool fingerprint of the template namepublic void putNamedTemplate(int fingerprint, Template template)
public FunctionLibrary getFunctionLibrary()
public void setFunctionLibrary(FunctionLibrary functionLibrary)
functionLibrary
- the function libarypublic void setCharacterMapIndex(IntHashMap cmi)
cmi
- a hash table that maps the names of character maps
to the HashMap objects representing the character mapspublic IntHashMap getCharacterMapIndex()
public void setStripperRules(Mode rules)
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.public Mode getStripperRules()
public void setStripsWhitespace(boolean strips)
strips
- true if the stylesheet performs whitespace stripping
of one or more elements.public Stripper newStripper()
public boolean stripsWhitespace()
public void setStripsInputTypeAnnotations(boolean strips)
public boolean stripsInputTypeAnnotations()
public void setKeyManager(KeyManager km)
km
- the KeyManager containing the xsl:key definitionspublic KeyManager getKeyManager()
public void setDefaultOutputProperties(java.util.Properties properties)
properties
- the output properties to be used when the unnamed output format
is selectedpublic java.util.Properties getDefaultOutputProperties()
public void setOutputProperties(int fingerprint, java.util.Properties properties)
fingerprint
- the name of the output formatproperties
- the properties of the output formatpublic java.util.Properties getOutputProperties(int fingerprint)
fingerprint
- the name of the output formatpublic void setDecimalFormatManager(DecimalFormatManager dfm)
dfm
- the DecimalFormatManager containing the named xsl:decimal-format definitionspublic DecimalFormatManager getDecimalFormatManager()
public void setDefaultCollationName(java.lang.String name)
name
- the name of the default collationpublic java.lang.String getDefaultCollationName()
public java.util.Comparator getDefaultCollation()
public void setCollationTable(CollationMap table)
table
- a hash table that maps collation names (URIs) to objects representing the
collation informationpublic CollationMap getCollationTable()
public java.util.Comparator getNamedCollation(java.lang.String name)
name
- identifies the name of the collation required; null indicates that the default
collation is requiredpublic void addQueryLibraryModule(StaticQueryContext module)
public java.util.List getQueryLibraryModules(java.lang.String namespace)
namespace
- the module namespace URIpublic void fixupQueryModules(StaticQueryContext main) throws XPathException
XPathException
public void setPatternSlotSpace(int patternLocals)
patternLocals
- The largest number of local variables used in the match pattern of any template rulepublic SlotManager getGlobalVariableMap()
public IntHashMap getCompiledGlobalVariables()
public void registerGlobalVariable(GlobalVariable variable)
public void initialiseBindery(Bindery bindery)
bindery
- The bindery to be initializedpublic int getLargestPatternStackFrame()
public void setLocationMap(LocationMap map)
public LocationMap getLocationMap()
public void addRequiredParam(int fingerprint)
public void checkAllRequiredParamsArePresent(GlobalParameterSet params) throws XPathException
XPathException
public void setReasonUnableToCompile(java.lang.String reason)
public java.lang.String getReasonUnableToCompile()