com.saxonica.ee.pattern

Class PatternWithPredicateADJ

java.lang.Object

com.saxonica.ee.pattern.Adjunct

com.saxonica.ee.pattern.PatternADJ

com.saxonica.ee.pattern.PatternWithPredicateADJ

public class PatternWithPredicateADJ
extends PatternADJ

Field Summary

Fields inherited from class com.saxonica.ee.pattern.PatternADJ

pattern

Constructor Summary

Constructors

Constructor and Description
PatternWithPredicateADJ(Pattern p)

Method Summary

Methods

Modifier and Type	Method and Description
Pattern	applyAxis(byte axis) Convert a pattern to apply to nodes along a given axis.
Pattern	evaluateAgainstBoolean(Expression t, PatternOptimizationEE patternOptimizationEE) Evaluate this pattern against an expression designated as 'true' in the execution context.
Set<IndexDefn.Indexation>	index(List<IndexDefn> idfl) find any indexable terms for the attached pattern or expression
Pattern	optimizeForName(int i) Optimize a pattern with respect to a named node (element or attribute).
Pattern	optimizeForType(int i) Optimize a pattern with respect to a typed node.
Pattern	optimizePattern() Generic optimization of a pattern
Adjunct	processRewrites(PatternOptimizationEE patternOptimization) process any rewrites for the attached expression or pattern
Pattern	unify(PatternADJ source, RewriteContext rc)
Set<RewriteContext>	unifyingBindings(PatternADJ source, RewriteContext rc) Unify this expression against another expression
Adjunct	updated()

Methods inherited from class com.saxonica.ee.pattern.PatternADJ

copyLocationInfo, export, getPatternPreconditions, getPreconditions, getRetainedStaticContext, optimizePattern

Methods inherited from class com.saxonica.ee.pattern.Adjunct

getExpressionAdjunct, getNodeTestAdjunct, getPatternAdjunct

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternWithPredicateADJ

public PatternWithPredicateADJ(Pattern p)

Method Detail

optimizeForName

public Pattern optimizeForName(int i)

Description copied from class: PatternADJ

Optimize a pattern with respect to a named node (element or attribute). This is usually carried out on the base pattern, to determine if it will match the named node to be matched.

Overrides:

optimizeForName in class PatternADJ

Parameters:

i - the fingerprint of the name of the node to be matched.

Returns:

null if it isn't for this named node, otherwise the pattern itself.

optimizeForType

public Pattern optimizeForType(int i)

Description copied from class: PatternADJ

Optimize a pattern with respect to a typed node. This is usually carried out on the base pattern, to determine if it will match the typed node to be matched.

Overrides:

optimizeForType in class PatternADJ

Parameters:

i - the type of the node to be matched.

Returns:

null if it isn't for this type of node, otherwise the pattern itself.

optimizePattern

public Pattern optimizePattern()

Description copied from class: PatternADJ

Generic optimization of a pattern

Overrides:

optimizePattern in class PatternADJ

Returns:

the optimization of the pattern

applyAxis

public Pattern applyAxis(byte axis)

Description copied from class: PatternADJ

Convert a pattern to apply to nodes along a given axis. If appropriate this normally returns a BooleanExpressionPattern containing a suitable FilterExpression

Overrides:

applyAxis in class PatternADJ

Parameters:

axis - The axis to mode this pattern to

Returns:

a pattern which matches the original pattern alonng a given axis.

evaluateAgainstBoolean

public Pattern evaluateAgainstBoolean(Expression t,
                             PatternOptimizationEE patternOptimizationEE)

Description copied from class: PatternADJ

Evaluate this pattern against an expression designated as 'true' in the execution context.

Overrides:

evaluateAgainstBoolean in class PatternADJ

Parameters:

t - the expression assumed to be true.

Returns:

a possibly modified pattern.

processRewrites

public Adjunct processRewrites(PatternOptimizationEE patternOptimization)

Description copied from class: Adjunct

process any rewrites for the attached expression or pattern

Overrides:

processRewrites in class Adjunct

Parameters:

patternOptimization - definitions of pattern optimization controls

updated

public Adjunct updated()

unify

public Pattern unify(PatternADJ source,
            RewriteContext rc)

Overrides:

unify in class PatternADJ

unifyingBindings

public Set<RewriteContext> unifyingBindings(PatternADJ source,
                                   RewriteContext rc)

Description copied from class: PatternADJ

Unify this expression against another expression

Overrides:

unifyingBindings in class PatternADJ

Parameters:

source - the expression to be unified against

rc - the evaluation context to use (which may be side-effected)

Returns:

a set of rewrite context bindings if it can unify, otherwise null

index

public Set<IndexDefn.Indexation> index(List<IndexDefn> idfl)

Description copied from class: Adjunct

find any indexable terms for the attached pattern or expression

Overrides:

index in class Adjunct

Parameters:

idfl - definitions of indexation directives

Returns: