Package net.sf.saxon.trans
Class Mode
java.lang.Object
net.sf.saxon.trans.Mode
- All Implemented Interfaces:
Serializable
A Mode is a collection of rules; the selection of a rule to apply to a given element
is determined by a Pattern.
- Author:
- Michael H. Kay
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StructuredQName
static final int
static final int
static final int
static final StructuredQName
-
Constructor Summary
ConstructorsConstructorDescriptionMode
(int usage, StructuredQName modeName) Default constructor - creates a Mode containing no rulesMode
(Mode omniMode, StructuredQName modeName) Construct a new Mode, copying the contents of an existing Mode -
Method Summary
Modifier and TypeMethodDescriptionvoid
addRule
(Pattern pattern, RuleTarget action, StylesheetModule module, double priority, boolean explicitMode) Add a rule to the Mode.void
allocatePatternSlots
(int slots) Specify how many slots for local variables are required by a particular patternapplyTemplates
(ParameterSet parameters, ParameterSet tunnelParameters, XPathContextMajor context, int locationId) Process selected nodes using the handlers registered for this mode.void
Compute a rank for each rule, as a combination of the precedence and priority, to allow rapid comparison.void
explainTemplateRules
(ExpressionPresenter presenter) Explain all template rules in this mode by showing their expression tree represented in XML.Get the built-in template rules to be used with this Mode in the case where there is no explicit template ruleGet the name of the mode (for diagnostics only)getNextMatchRule
(Item item, Rule currentRule, XPathContext context) Get the rule corresponding to a given Node, by finding the next-best Pattern match after the specified object.int
Get the policy for handling recoverable errors.getRule
(Item item, int min, int max, XPathContext context) Get the rule corresponding to a given Node, by finding the best Pattern match, subject to a minimum and maximum precedence.getRule
(Item item, XPathContext context) Get the rule corresponding to a given Node, by finding the best Pattern match.getRule
(Item item, XPathContext context, net.sf.saxon.trans.Mode.RuleFilter filter) Get the rule corresponding to a given item, by finding the best Pattern match.void
For a streamable mode, invert all the templates to generate streamable codeboolean
Determine if this is the default modeboolean
isEmpty()
Ask whether there are any template rules in this mode (a mode could exist merely because it is referenced in apply-templates)boolean
Ask whether this mode is streamablevoid
processRules
(net.sf.saxon.trans.Mode.RuleAction action) Walk over all the rules, applying a specified action to each one.void
setBuiltInRuleSet
(BuiltInRuleSet defaultRules) Set the built-in template rules to be used with this Mode in the case where there is no explicit template rulevoid
setRecoveryPolicy
(int policy) Set the policy for handling recoverable errrors.void
setStreamable
(boolean streamable) Say that this mode is (or is not) streamable
-
Field Details
-
UNNAMED_MODE
public static final int UNNAMED_MODE- See Also:
-
NAMED_MODE
public static final int NAMED_MODE- See Also:
-
STRIPPER_MODE
public static final int STRIPPER_MODE- See Also:
-
ALL_MODES
-
UNNAMED_MODE_NAME
-
-
Constructor Details
-
Mode
Default constructor - creates a Mode containing no rules- Parameters:
usage
- one ofUNNAMED_MODE
,NAMED_MODE
,STRIPPER_MODE
modeName
- the name of the mode
-
Mode
Construct a new Mode, copying the contents of an existing Mode- Parameters:
omniMode
- the existing mode. May be null, in which case it is not copiedmodeName
- the name of the new mode to be created
-
-
Method Details
-
setBuiltInRuleSet
Set the built-in template rules to be used with this Mode in the case where there is no explicit template rule- Parameters:
defaultRules
- the built-in rule set
-
getBuiltInRuleSet
Get the built-in template rules to be used with this Mode in the case where there is no explicit template rule- Returns:
- the built-in rule set, defaulting to the TextOnlyCopyRuleSet if no other rule set has been supplied
-
isDefaultMode
public boolean isDefaultMode()Determine if this is the default mode- Returns:
- true if this is the default (unnamed) mode
-
getModeName
Get the name of the mode (for diagnostics only)- Returns:
- the mode name. Null for the default (unnamed) mode
-
isEmpty
public boolean isEmpty()Ask whether there are any template rules in this mode (a mode could exist merely because it is referenced in apply-templates)- Returns:
- true if no template rules exist in this mode
-
setRecoveryPolicy
public void setRecoveryPolicy(int policy) Set the policy for handling recoverable errrors. Note that for some errors the decision can be made at run-time, but for the "ambiguous template match" error, the decision is (since 9.2) fixed at compile time.- Parameters:
policy
- the recovery policy to be used. The options areConfiguration.RECOVER_SILENTLY
,Configuration.RECOVER_WITH_WARNINGS
, orConfiguration.DO_NOT_RECOVER
.
-
getRecoveryPolicy
public int getRecoveryPolicy()Get the policy for handling recoverable errors. Note that for some errors the decision can be made at run-time, but for the "ambiguous template match" error, the decision is (since 9.2) fixed at compile time.- Returns:
- the current policy.
-
setStreamable
public void setStreamable(boolean streamable) Say that this mode is (or is not) streamable- Parameters:
streamable
- true if this mode is a streamable mode
-
isStreamable
public boolean isStreamable()Ask whether this mode is streamable- Returns:
- true if this mode is streamable
-
addRule
public void addRule(Pattern pattern, RuleTarget action, StylesheetModule module, double priority, boolean explicitMode) Add a rule to the Mode.- Parameters:
pattern
- a Patternaction
- the Object to return from getRule() when the supplied node matches this Patternmodule
- the stylesheet module containing the rulepriority
- the priority of the ruleexplicitMode
- true if adding a template rule for a specific (default or named) mode; false if adding a rule because it applies to all modes
-
allocatePatternSlots
public void allocatePatternSlots(int slots) Specify how many slots for local variables are required by a particular pattern- Parameters:
slots
- the number of slots needed
-
getRule
Get the rule corresponding to a given Node, by finding the best Pattern match.- Parameters:
item
- the item to be matchedcontext
- the XPath dynamic evaluation context- Returns:
- the best matching rule, if any (otherwise null).
- Throws:
XPathException
- if an error occurs matching a pattern
-
getRule
public Rule getRule(Item item, XPathContext context, net.sf.saxon.trans.Mode.RuleFilter filter) throws XPathException Get the rule corresponding to a given item, by finding the best Pattern match.- Parameters:
item
- the item to be matchedcontext
- the XPath dynamic evaluation contextfilter
- a filter to select which rules should be considered- Returns:
- the best matching rule, if any (otherwise null).
- Throws:
XPathException
- if an error occurs
-
getRule
Get the rule corresponding to a given Node, by finding the best Pattern match, subject to a minimum and maximum precedence. (This supports xsl:apply-imports)- Parameters:
item
- the item to be matchedmin
- the minimum import precedencemax
- the maximum import precedencecontext
- the XPath dynamic evaluation context- Returns:
- the Rule registered for that node, if any (otherwise null).
- Throws:
XPathException
- if an error occurs evaluating match patterns
-
getNextMatchRule
public Rule getNextMatchRule(Item item, Rule currentRule, XPathContext context) throws XPathException Get the rule corresponding to a given Node, by finding the next-best Pattern match after the specified object.- Parameters:
item
- the NodeInfo referring to the node to be matchedcurrentRule
- the current rule; we are looking for the next match after the current rulecontext
- the XPath dynamic evaluation context- Returns:
- the object (e.g. a NodeHandler) registered for that element, if any (otherwise null).
- Throws:
XPathException
- if an error occurs matching a pattern
-
processRules
Walk over all the rules, applying a specified action to each one.- Parameters:
action
- an action that is to be applied to all the rules in this Mode- Throws:
XPathException
- if an error occurs processing any of the rules
-
invertStreamableTemplates
For a streamable mode, invert all the templates to generate streamable code- Parameters:
opt
- the optimizer (always a Saxon-EE optimizer)- Throws:
XPathException
- if there is a non-streamable template in the mode
-
explainTemplateRules
Explain all template rules in this mode by showing their expression tree represented in XML.- Parameters:
presenter
- used to display the expression tree
-
computeRankings
Compute a rank for each rule, as a combination of the precedence and priority, to allow rapid comparison.- Throws:
XPathException
- if an error occurs processing the rules
-
applyTemplates
public TailCall applyTemplates(ParameterSet parameters, ParameterSet tunnelParameters, XPathContextMajor context, int locationId) throws XPathException Process selected nodes using the handlers registered for this mode.- Parameters:
parameters
- A ParameterSet containing the parameters to the handler/template being invoked. Specify null if there are no parameters.tunnelParameters
- A ParameterSet containing the parameters to the handler/template being invoked. Specify null if there are no parameters.context
- A newly-created context object (this must be freshly created by the caller, as it will be modified by this method). The nodes to be processed are those selected by the currentIterator in this context object. There is also a precondition that this mode must be the current mode in this context object.locationId
- location of this apply-templates instruction in the stylesheet- Returns:
- a TailCall returned by the last template to be invoked, or null, indicating that there are no outstanding tail calls.
- Throws:
XPathException
- if any dynamic error occurs
-