|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.expr.instruct.Executable
public class Executable
A compiled stylesheet or a query in executable form. Note that the original stylesheet tree is not retained.
Constructor Summary | |
---|---|
Executable(Configuration config)
Create a new Executable (a collection of stylesheet modules and/or query modules) |
Method Summary | |
---|---|
void |
addQueryLibraryModule(QueryModule module)
Add an XQuery library module to the configuration. |
void |
addQueryLocationHintProcessed(String uri)
Add a name to the list of query module location hints that have been processed during the construction of this executable |
void |
addRequiredParam(StructuredQName qName)
Add a required parameter. |
void |
checkAllRequiredParamsArePresent(GlobalParameterSet params)
Check that all required parameters have been supplied. |
boolean |
createsSecondaryResult()
Ask whether this executable represents a stylesheet that uses xsl:result-document to create secondary output documents |
void |
explainGlobalVariables(ExpressionPresenter presenter)
Explain (that is, output an expression tree) the global variables |
void |
fixupQueryModules(QueryModule main,
boolean checkForCycles)
Fix up global variables and functions in all query modules. |
CharacterMapIndex |
getCharacterMapIndex()
Get the index of named character maps |
CollationMap |
getCollationTable()
Get the table of collations |
HashMap<StructuredQName,GlobalVariable> |
getCompiledGlobalVariables()
Get the index of global variables |
Configuration |
getConfiguration()
Get the configuration |
Properties |
getDefaultOutputProperties()
Get the default output properties |
FunctionLibraryList |
getFunctionLibrary()
Get the library containing all the in-scope functions in the static context |
GlobalVariable |
getGlobalVariable(StructuredQName name)
Get the global variable with a given name |
SlotManager |
getGlobalVariableMap()
Get the global variable map |
int |
getHostLanguage()
Get the host language |
StructuredQName |
getInitialContextItemVariableName()
Get the the name of the variable that will implicitly contain the value of the initial context item. |
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 |
StringCollator |
getNamedCollation(String name)
Find a named collation. |
Properties |
getOutputProperties(StructuredQName qName)
Get a named output format |
Iterator |
getQueryLibraryModules()
Get an iterator over all the query library modules (does not include the main module) |
List<QueryModule> |
getQueryLibraryModules(String namespace)
Locate the known XQuery library modules for a given module namespace. |
QueryModule |
getQueryModuleWithSystemId(String systemId,
QueryModule topModule)
Get the query library module with a given systemID |
SpaceStrippingRule |
getStripperRules()
Get the rules determining which nodes are to be stripped from the tree |
void |
initializeBindery(Bindery bindery)
Allocate space in bindery for all the variables needed |
boolean |
isAllowXPath30()
Ask whether XPath 3.0 functionality is enabled |
boolean |
isQueryLocationHintProcessed(String uri)
Ask whether a query module location hint has already been processed |
boolean |
isSchemaAware()
Ask whether this executable is schema-aware, that is, whether the query or transformation imports a schema. |
void |
registerGlobalVariable(GlobalVariable variable)
Register a global variable |
void |
setCharacterMapIndex(CharacterMapIndex cmi)
Set the index of named character maps |
void |
setCollationMap(CollationMap table)
Set the table of collations |
void |
setConfiguration(Configuration config)
Set the configuration |
void |
setCreatesSecondaryResult(boolean flag)
Set whether this executable represents a stylesheet that uses xsl:result-document to create secondary output documents |
void |
setDefaultOutputProperties(Properties properties)
Set the default output properties (the properties for the unnamed output format) |
void |
setFunctionLibrary(FunctionLibraryList functionLibrary)
Set the library containing all the in-scope functions in the static context |
void |
setHostLanguage(int language,
boolean allowXPath30)
Set the host language |
void |
setInitialContextItemVariableName(StructuredQName name)
Set the name of the variable that will implicitly contain the value of the initial context item. |
void |
setKeyManager(KeyManager km)
Set the KeyManager which handles key definitions |
void |
setLocationMap(LocationMap map)
Set the location map |
void |
setOutputProperties(StructuredQName qName,
Properties properties)
Add a named output format |
void |
setPatternSlotSpace(int patternLocals)
Set the space requirements for variables used in template match patterns |
void |
setSchemaAware(boolean aware)
Set whether this executable is schema-aware. |
void |
setStripperRules(SpaceStrippingRule 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()
Ask whether source documents are to have their type annotations stripped |
boolean |
stripsWhitespace()
Determine whether this stylesheet does any whitespace stripping |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Executable(Configuration config)
config
- the Saxon ConfigurationMethod Detail |
---|
public void setConfiguration(Configuration config)
config
- the Configurationpublic Configuration getConfiguration()
public void setHostLanguage(int language, boolean allowXPath30)
language
- the host language, as a constant such as Configuration.XSLT
or
Configuration.XQUERY
allowXPath30
- true if functionality defined in XPath 3.0 (for example, new casting options) is enabledpublic int getHostLanguage()
Configuration.XQUERY
or Configuration.XSLT
or Configuration.JAVA_APPLICATION
public boolean isAllowXPath30()
public FunctionLibraryList getFunctionLibrary()
public void setFunctionLibrary(FunctionLibraryList functionLibrary)
functionLibrary
- the function libarypublic void setCharacterMapIndex(CharacterMapIndex cmi)
cmi
- a hash table that maps the names of character maps
to the HashMap objects representing the character mapspublic CharacterMapIndex getCharacterMapIndex()
public void setStripperRules(SpaceStrippingRule 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 SpaceStrippingRule getStripperRules()
public void setStripsWhitespace(boolean strips)
strips
- true if the stylesheet performs whitespace stripping
of one or more elements.public boolean stripsWhitespace()
public void setStripsInputTypeAnnotations(boolean strips)
strips
- true if type annotations are to be strippedpublic boolean stripsInputTypeAnnotations()
public void setKeyManager(KeyManager km)
km
- the KeyManager containing the xsl:key definitionspublic KeyManager getKeyManager()
public void setDefaultOutputProperties(Properties properties)
properties
- the output properties to be used when the unnamed output format
is selectedpublic Properties getDefaultOutputProperties()
public void setOutputProperties(StructuredQName qName, Properties properties)
qName
- the structured QName of the output formatproperties
- the properties of the output formatpublic Properties getOutputProperties(StructuredQName qName)
qName
- the name of the output format
public void setCollationMap(CollationMap table)
table
- a hash table that maps collation names (URIs) to objects representing the
collation informationpublic CollationMap getCollationTable()
public StringCollator getNamedCollation(String name)
name
- identifies the name of the collation required; null indicates that the default
collation is required
public void addQueryLibraryModule(QueryModule module)
module
- the library module to be added to this executablepublic List<QueryModule> getQueryLibraryModules(String namespace)
namespace
- the module namespace URI
public QueryModule getQueryModuleWithSystemId(String systemId, QueryModule topModule)
systemId
- the SystemId of the required moduletopModule
- the top-level query module (usually a main module, except when
importing library modules into XSLT)
public Iterator getQueryLibraryModules()
QueryModule
public void addQueryLocationHintProcessed(String uri)
uri
- the name to be added (the location URI as it appears in the
"import module" declaration, expanded to an absolute URI by resolving against
the base URI, but before passing to the Module Resolver)public boolean isQueryLocationHintProcessed(String uri)
uri
- the query location hint (the location URI as it appears in the
"import module" declaration, expanded to an absolute URI by resolving against
the base URI, but before passing to the Module Resolver)
public void fixupQueryModules(QueryModule main, boolean checkForCycles) throws XPathException
main
- the main query modulecheckForCycles
- if a check for cyclicity among modules is to be performed. This is a check for
cycles at the level of a module (error XQST0093)
XPathException
- if an error occurspublic void setPatternSlotSpace(int patternLocals)
patternLocals
- The largest number of local variables used in the match pattern of any template rulepublic GlobalVariable getGlobalVariable(StructuredQName name)
name
- the name of the required variable
public SlotManager getGlobalVariableMap()
public HashMap<StructuredQName,GlobalVariable> getCompiledGlobalVariables()
StructuredQName
of the variable name, and the value is the GlobalVariable object representing the compiled
global variable. If there are no global variables, the method may return null.public void explainGlobalVariables(ExpressionPresenter presenter)
presenter
- the destination for the explanation of the global variablespublic void registerGlobalVariable(GlobalVariable variable)
variable
- the global variable to be registeredpublic void initializeBindery(Bindery bindery)
bindery
- The bindery to be initializedpublic int getLargestPatternStackFrame()
public void setLocationMap(LocationMap map)
map
- the location map, which is used to identify the module URI and line number of locations of errorspublic LocationMap getLocationMap()
public void addRequiredParam(StructuredQName qName)
qName
- the name of the required parameterpublic void checkAllRequiredParamsArePresent(GlobalParameterSet params) throws XPathException
params
- the set of parameters that have been supplied
XPathException
- if there is a required parameter for which no value has been suppliedpublic void setCreatesSecondaryResult(boolean flag)
flag
- true if the executable uses xsl:result-documentpublic boolean createsSecondaryResult()
public void setInitialContextItemVariableName(StructuredQName name)
name
- the name of the global variable that mirrors the initial context item;
or null if there is no such variablepublic StructuredQName getInitialContextItemVariableName()
public void setSchemaAware(boolean aware)
aware
- true if the executable is schema-aware
IllegalArgumentException
- if schema-aware processing is requested in a Configuration
that is not schema-awarepublic boolean isSchemaAware()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |