com.saxonica.ee.trans

Class ModeExperimental

java.lang.Object

net.sf.saxon.expr.instruct.ComponentCode<SimpleMode>

net.sf.saxon.trans.Mode

net.sf.saxon.trans.SimpleMode

com.saxonica.trans.ModePE

com.saxonica.ee.trans.ModeEE

com.saxonica.ee.trans.ModeExperimental

All Implemented Interfaces:

SourceLocator, Location, InstructionInfo, Locator

Direct Known Subclasses:

ModeExperimentalChoice

public class ModeExperimental
extends ModeEE

Description for class

Nested Class Summary

Nested classes/interfaces inherited from class com.saxonica.ee.trans.ModeEE

ModeEE.RuleTypeAction

Nested classes/interfaces inherited from class net.sf.saxon.trans.SimpleMode

SimpleMode.RuleGroupAction

Nested classes/interfaces inherited from class net.sf.saxon.trans.Mode

Mode.RuleAction, Mode.RuleFilter

Field Summary

Fields

Modifier and Type	Field and Description
ComparisonPredicateIndex	comparisonPredicateIndex
HashMap<Expression,HashMap<Expression,List<Rule>>>	elementRuleIndex
IntHashMap<ComparisonPredicateIndex>	namedComparisonPredicateIndex

Fields inherited from class com.saxonica.ee.trans.ModeEE

patternOptimization, rulePreconditions

Fields inherited from class net.sf.saxon.trans.SimpleMode

atomicValueRuleChain, commentRuleChain, documentRuleChain, functionItemRuleChain, genericRuleChain, namedAttributeRuleChains, namedElementRuleChains, namespaceRuleChain, processingInstructionRuleChain, qNamedAttributeRuleChains, qNamedElementRuleChains, textRuleChain, unnamedAttributeRuleChain, unnamedElementRuleChain

Fields inherited from class net.sf.saxon.trans.Mode

DEFAULT_MODE_NAME, hasRules, modeName, mustBeTyped, mustBeUntyped, OMNI_MODE, UNNAMED_MODE_NAME

Fields inherited from class net.sf.saxon.expr.instruct.ComponentCode

body

Constructor Summary

Constructors

Constructor and Description
ModeExperimental(StructuredQName modeName, CompilerInfo compilerInfo)

Method Summary

Methods

Modifier and Type	Method and Description
void	explainTemplateRules(ExpressionPresenter out) Explain all template rules in this mode by showing their expression tree represented in XML.
ComparisonPredicateIndex	getNamedComparisonPredicateIndex(NodeInfo node, XPathContext context)
ComparisonPredicateIndex	getNamedComparisonPredicateIndex(XPathContext c, int kind, String uri, String local)
Rule	getRule(Item item, XPathContext context) Get the rule corresponding to a given item, by finding the best pattern match.
Rule	getRule(Item item, XPathContext context, Mode.RuleFilter filter) Get the rule corresponding to a given item, by finding the best Pattern match.
protected Rule	getRuleFromComparisonPredicateIndex(Item item, XPathContext context, Rule bestRule, ComparisonPredicateIndex index, IndexMatcher ruleSearchState, Mode.RuleFilter filter)
protected Rule	getRuleFromIndex(Item item, XPathContext context, Rule bestRule, HashMap<Expression,HashMap<Expression,List<Rule>>> index, RuleSearchState ruleSearchState, Mode.RuleFilter filter) Get the best rule match from an indexed set of indexed sets of rule lists
HashMap<Expression,HashMap<Expression,List<Rule>>>	indexRules(Rule chain, Rule genericChain) Generate a set of indexes for the unnamed elements/attributes Uses the indexation definitions contained in the patternOptimization object TODO think about whether to record high/low ranks for each rule group
IntHashMap<ComparisonPredicateIndex>	indexRulesComparisonPredicate(IntHashMap<Rule> chains, Rule genericChain) Generate the set of comparison predicate indexation structures for the named element rules.
ComparisonPredicateIndex	indexRulesComparisonPredicate(Rule chain, Rule genericChain, PatternOptimizationEE pattOpt) Generate comparison predicate indexation structures for the given element rules.
protected RuleSearchState	makeRuleSearchState() Generate a search state for processing a given node
void	optimizeRules()

Methods inherited from class com.saxonica.ee.trans.ModeEE

computePreconditions, computeStreamability, deduplicateRules, getNamedNodeChain, getUnnamedNodeChain, invertStreamableTemplates, listRules, makeRule, optimizeRules, optimizeRules, orderRules, orderRules, processRulesTyped, reportAmbiguity, ruleMatches, setType, typeName

Methods inherited from class com.saxonica.trans.ModePE

getBuiltInRuleSetForCode, getCodeForBuiltInRuleSet, prepareStreamability

Methods inherited from class net.sf.saxon.trans.SimpleMode

addRule, addRule, allocateAllBindingSlots, allocateAllPatternSlots, allocatePatternSlots, checkForConflictingProperties, computeRankings, copyRules, exportTemplateRules, forceAllocateAllBindingSlots, getActivePart, getBuiltInRuleSet, getExplicitNamespaces, getMaxPrecedence, getMaxRank, getNamedRuleChain, getPropertyValue, getStackFrameSlotsNeeded, isEmpty, processRuleChain, processRuleChain, processRuleChains, processRules, processRules, searchRuleChain, searchRuleChain, setBuiltInRuleSet, setExplicitProperty, setGroup, setStackFrameSlotsNeeded

Methods inherited from class net.sf.saxon.trans.Mode

applyTemplates, explain, export, getComponentKind, getConstructType, getModeName, getModeTitle, getNextMatchRule, getObjectName, getRecoveryPolicy, getRule, getSymbolicName, isDeclaredStreamable, isUnnamedMode, makeNewContext, makeNewContextIfNeeded, setRecoveryPolicy, setStreamable

Methods inherited from class net.sf.saxon.expr.instruct.ComponentCode

allocateBindingSlotsRecursive, getBody, getColumnNumber, getDeclaredVisibility, getDeclaringComponent, getLineNumber, getLocation, getPackageData, getProperties, getProperty, getPublicId, getRetainedStaticContext, getStackFrameMap, getSystemId, makeDeclaringComponent, saveLocation, setBody, setDeclaredVisibility, setDeclaringComponent, setLineNumber, setPackageData, setRetainedStaticContext, setStackFrameMap, setSystemId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

comparisonPredicateIndex

public ComparisonPredicateIndex comparisonPredicateIndex

namedComparisonPredicateIndex

public IntHashMap<ComparisonPredicateIndex> namedComparisonPredicateIndex

elementRuleIndex

public HashMap<Expression,HashMap<Expression,List<Rule>>> elementRuleIndex

Constructor Detail

ModeExperimental

public ModeExperimental(StructuredQName modeName,
                CompilerInfo compilerInfo)

Method Detail

makeRuleSearchState

protected RuleSearchState makeRuleSearchState()

Description copied from class: SimpleMode

Generate a search state for processing a given node

Overrides:

makeRuleSearchState in class ModeEE

Returns:

a new object capable of holding the state of a search for a rule

optimizeRules

public void optimizeRules()

Overrides:

optimizeRules in class ModeEE

indexRulesComparisonPredicate

public IntHashMap<ComparisonPredicateIndex> indexRulesComparisonPredicate(IntHashMap<Rule> chains,
                                                                 Rule genericChain)

Generate the set of comparison predicate indexation structures for the named element rules. TODO - test absence of entry if there are no CP indexable rules for this element name.

Parameters:

chains - the named element rule chains

genericChain - the generic rule chain

Returns:

a set of indexes, keyed by the element name

indexRulesComparisonPredicate

public ComparisonPredicateIndex indexRulesComparisonPredicate(Rule chain,
                                                     Rule genericChain,
                                                     PatternOptimizationEE pattOpt)

Generate comparison predicate indexation structures for the given element rules.

Parameters:

chain - the rule chain

genericChain - the generic rule chain

Returns:

a set of indexes

indexRules

public HashMap<Expression,HashMap<Expression,List<Rule>>> indexRules(Rule chain,
                                                            Rule genericChain)

Generate a set of indexes for the unnamed elements/attributes Uses the indexation definitions contained in the patternOptimization object TODO think about whether to record high/low ranks for each rule group

Parameters:

chain - the rules to be indexed

genericChain - the generic rule set to add on to this set

Returns:

getRule

public Rule getRule(Item item,
           XPathContext context)
             throws XPathException

Description copied from class: SimpleMode

Get the rule corresponding to a given item, by finding the best pattern match.

Overrides:

getRule in class SimpleMode

Parameters:

item - the item to be matched

context - 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,
           Mode.RuleFilter filter)
             throws XPathException

Description copied from class: SimpleMode

Get the rule corresponding to a given item, by finding the best Pattern match.

Overrides:

getRule in class SimpleMode

Parameters:

item - the item to be matched

context - the XPath dynamic evaluation context

filter - a filter to select which rules should be considered

Returns:

the best matching rule, if any (otherwise null).

Throws:

XPathException - if an error occurs

getRuleFromComparisonPredicateIndex

protected Rule getRuleFromComparisonPredicateIndex(Item item,
                                       XPathContext context,
                                       Rule bestRule,
                                       ComparisonPredicateIndex index,
                                       IndexMatcher ruleSearchState,
                                       Mode.RuleFilter filter)
                                            throws XPathException

Throws:

XPathException

getNamedComparisonPredicateIndex

public ComparisonPredicateIndex getNamedComparisonPredicateIndex(NodeInfo node,
                                                        XPathContext context)

getNamedComparisonPredicateIndex

public ComparisonPredicateIndex getNamedComparisonPredicateIndex(XPathContext c,
                                                        int kind,
                                                        String uri,
                                                        String local)

getRuleFromIndex

protected Rule getRuleFromIndex(Item item,
                    XPathContext context,
                    Rule bestRule,
                    HashMap<Expression,HashMap<Expression,List<Rule>>> index,
                    RuleSearchState ruleSearchState,
                    Mode.RuleFilter filter)
                         throws XPathException

Get the best rule match from an indexed set of indexed sets of rule lists

The key expression for each outer set member is evaluated on the context (match) item to produce a sequence of literals, which are each then used to key into the rulelists. Each rule list, which is sorted in rank/sequence order, is then examined to find a (unique) match with highest unique rank.

Parameters:

item - the item to be examined (should be a node?)

context - XPath dynamic context

bestRule - the best rule found so far, usually non-null if named match beforehand or next-match

index - the index of the rule lists

ruleSearchState - the current rule search state

filter - a filter for acceptable rules - can be null, admitting all

Returns:

the best match found subject to the filter

Throws:

XPathException - if there is ambiguity that needs to throw an error

explainTemplateRules

public void explainTemplateRules(ExpressionPresenter out)

Description copied from class: SimpleMode

Explain all template rules in this mode by showing their expression tree represented in XML. Note that this produces more information than the simpler exportTemplateRules() method: this method is intended for the human reader wanting diagnostic explanations, whereas exportTemplateRules() is designed to produce a package that can be re-imported.

Overrides:

explainTemplateRules in class ModeEE

Parameters:

out - used to display the expression tree