com.saxonica.ee.pattern

Class AncestorQualifiedPatternADJ

java.lang.Object

com.saxonica.ee.pattern.Adjunct

com.saxonica.ee.pattern.PatternADJ

com.saxonica.ee.pattern.AncestorQualifiedPatternADJ

public class AncestorQualifiedPatternADJ
extends PatternADJ

Field Summary

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

pattern

Constructor Summary

Constructors

Constructor and Description
AncestorQualifiedPatternADJ(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<Expression>	getPreconditions(PatternOptimizationEE patternOptimization) Get the preconditions for a pattern
Set<IndexDefn.Indexation>	index(List<IndexDefn> idfl) find any indexable terms for the attached pattern or expression
Pattern	optimizeForName(int fingerprint) Optimize a pattern with respect to a named node (element or attribute).
Pattern	optimizeForType(int type) 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
Adjunct	updated()

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

copyLocationInfo, export, getPatternPreconditions, getRetainedStaticContext, optimizePattern, unify, unifyingBindings

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

AncestorQualifiedPatternADJ

public AncestorQualifiedPatternADJ(Pattern p)

Method Detail

optimizeForName

public Pattern optimizeForName(int fingerprint)

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:

fingerprint - 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 type)

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:

type - 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.

getPreconditions

public Set<Expression> getPreconditions(PatternOptimizationEE patternOptimization)

Description copied from class: PatternADJ

Get the preconditions for a pattern

Note that as a Pattern is a subclass of Expression, we need different named functions for each type.

Overrides:

getPreconditions in class PatternADJ

Parameters:

patternOptimization - controls for the optimization

Returns:

a set of precondition expressions for this 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()

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: