net.sf.saxon.pattern

Class AncestorQualifiedPattern

java.lang.Object

net.sf.saxon.expr.Expression

net.sf.saxon.expr.PseudoExpression

net.sf.saxon.pattern.Pattern

net.sf.saxon.pattern.AncestorQualifiedPattern

All Implemented Interfaces:

IdentityComparable

public final class AncestorQualifiedPattern
extends Pattern

An AncestorQualifiedPattern represents a path of the form A/B or A//B, where nodes must match the pattern B and also have a parent/ancestor (respectively) that matches A.

Field Summary

Fields inherited from class net.sf.saxon.expr.Expression

EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, UPDATE_METHOD, WATCH_METHOD

Constructor Summary

Constructors

Constructor and Description
AncestorQualifiedPattern(Pattern base, Pattern upper, byte axis)

Method Summary

Methods

Modifier and Type	Method and Description
int	allocateSlots(SlotManager slotManager, int nextFree) Allocate slots to any variables used within the pattern
void	bindCurrent(LocalBinding binding) Replace any calls on current() by a variable reference bound to the supplied binding
Pattern	convertToTypedPattern(String val) Convert the pattern to a typed pattern, in which an element name is treated as schema-element(N)
Pattern	copy() Copy a pattern.
boolean	equals(Object other) Determine whether this pattern is the same as another pattern
void	export(ExpressionPresenter presenter) Diagnostic print of expression structure.
Pattern	getBasePattern() Get the base pattern, the pattern applying to the node itself
int	getDependencies() Get the dependencies of the pattern.
int	getFingerprint() Determine the fingerprint of nodes to which this pattern applies.
ItemType	getItemType() Get a NodeTest that all the nodes matching this pattern must satisfy
Pattern	getUpperPattern() Get the pattern applying to the parent node, if there is one
byte	getUpwardsAxis() Get the upwards axis, that is, the axis by which the upper pattern is reached.
UType	getUType() Get a UType indicating which kinds of items this Pattern can match.
int	hashCode() hashcode supporting equals()
boolean	isMotionless(boolean allowExtensions) Test whether a pattern is motionless, that is, whether it can be evaluated against a node without repositioning the input stream.
Iterator<Expression>	iterateSubExpressions() Iterate over the subexpressions within this pattern
boolean	matches(Item item, XPathContext context) Determine whether the pattern matches a given item.
boolean	matchesBeneathAnchor(NodeInfo node, NodeInfo anchor, XPathContext context) Determine whether this pattern matches a given Node within the subtree rooted at a given anchor node.
Iterable<Operand>	operands() Get the immediate sub-expressions of this expression, with information about the relationship of each expression to its parent expression.
void	promote(PromotionOffer offer, Expression parent) Offer promotion for subexpressions within this pattern.
Pattern	simplify() Simplify the pattern: perform any context-independent optimisations
String	toString() Get the original pattern text
Pattern	typeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextItemType) Type-check the pattern, performing any type-dependent optimizations.

Methods inherited from class net.sf.saxon.pattern.Pattern

effectiveBooleanValue, getDefaultPriority, getHostLanguage, make, optimize, replaceCurrent, selectNodes, setOriginalText, setPriority

Methods inherited from class net.sf.saxon.expr.PseudoExpression

computeCardinality, evaluateAsString, evaluateItem, getImplementationMethod, iterate, iterateEvents, process

Methods inherited from class net.sf.saxon.expr.Expression

addToPathMap, adoptChildExpression, checkedOperands, checkForUpdatingSubexpressions, checkPermittedContents, clearStreamabilityData, computeDependencies, computeSpecialProperties, computeStaticProperties, doPromotion, dynamicError, evaluatePendingUpdates, explain, getCardinality, getConfiguration, getConstructType, getCost, getEvaluationMethod, getExpressionCompiler, getExpressionName, getIntegerBounds, getIntrinsicDependencies, getLocation, getNetCost, getObjectName, getPackageData, getParentExpression, getPosture, getPostureAndSweepIfKnown, getProperties, getProperty, getRetainedStaticContext, getSlotsUsed, getSpecialProperties, getStaticBaseURI, getStaticBaseURIString, getStreamability, getStreamingAdjunct, getSweep, getSystemId, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isCallOn, isCallOnSystemFunction, isIdentical, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, makeStreamingAdjunct, markTailFunctionCalls, operandList, operandSparseList, optimizeChildren, optimizeForType, promote, promoteChildren, resetLocalStaticProperties, restoreParentPointers, setEvaluationMethod, setFiltered, setFlattened, setLocation, setParentExpression, setPostureAndSweep, setRetainedStaticContext, setRetainedStaticContextLocally, setStaticProperty, simplifyChildren, staticTypeCheck, suppressValidation, toPattern, toShortString, toStreamingPattern, typeCheckChildren, typeError, unordered

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AncestorQualifiedPattern

public AncestorQualifiedPattern(Pattern base,
                        Pattern upper,
                        byte axis)

Method Detail

operands

public Iterable<Operand> operands()

Get the immediate sub-expressions of this expression, with information about the relationship of each expression to its parent expression. Default implementation works off the results of iterateSubExpressions()

If the expression is a Callable, then it is required that the order of the operands returned by this function is the same as the order of arguments supplied to the corresponding call() method.

Overrides:

operands in class Expression

Returns:

an iterator containing the sub-expressions of this expression

bindCurrent

public void bindCurrent(LocalBinding binding)

Replace any calls on current() by a variable reference bound to the supplied binding

Overrides:

bindCurrent in class Pattern

getBasePattern

public Pattern getBasePattern()

Get the base pattern, the pattern applying to the node itself

Returns:

the base pattern

getUpperPattern

public Pattern getUpperPattern()

Get the pattern applying to the parent node, if there is one

Returns:

the parent pattern, for example if the pattern is a/b[1]/c then the parent pattern is a/b[1]

getUpwardsAxis

public byte getUpwardsAxis()

Get the upwards axis, that is, the axis by which the upper pattern is reached. Typically Axis.PARENT or Axis.ANCESTOR

Returns:

the relevant axis

isMotionless

public boolean isMotionless(boolean allowExtensions)

Test whether a pattern is motionless, that is, whether it can be evaluated against a node without repositioning the input stream. This is a necessary condition for patterns used as the match pattern of a streamed template rule.

Overrides:

isMotionless in class Pattern

Parameters:

allowExtensions - if false, the result is determined strictly according to the W3C guaranteed streamability rules. If true, Saxon extensions are permitted: that is, constructs may be recognized as motionless by Saxon even if they are not recognized as motionless by the W3C rules.

Returns:

true if the pattern is motionless, that is, if it can be evaluated against a streamed node without changing the position in the streamed input file

simplify

public Pattern simplify()
                 throws XPathException

Simplify the pattern: perform any context-independent optimisations

Overrides:

simplify in class Pattern

Returns:

the simplified expression (or the original if unchanged, or if modified in-situ)

Throws:

XPathException - if an error is discovered during expression rewriting

typeCheck

public Pattern typeCheck(ExpressionVisitor visitor,
                ContextItemStaticInfo contextItemType)
                  throws XPathException

Type-check the pattern, performing any type-dependent optimizations.

Overrides:

typeCheck in class Pattern

Parameters:

visitor - an expression visitor

contextItemType - the type of the context item at the point where the pattern appears

Returns:

the optimised Pattern

Throws:

XPathException - if an error is discovered during this phase (typically a type error)

getDependencies

public int getDependencies()

Get the dependencies of the pattern. The only possible dependency for a pattern is on local variables. This is analyzed in those patterns where local variables may appear.

Overrides:

getDependencies in class Pattern

Returns:

the dependencies, as a bit-significant mask

iterateSubExpressions

public Iterator<Expression> iterateSubExpressions()

Iterate over the subexpressions within this pattern

Overrides:

iterateSubExpressions in class Pattern

Returns:

an iterator over the subexpressions. Default implementation returns an empty sequence

allocateSlots

public int allocateSlots(SlotManager slotManager,
                int nextFree)

Allocate slots to any variables used within the pattern

Overrides:

allocateSlots in class Pattern

Parameters:

slotManager - keeps track of slots

nextFree - the next slot that is free to be allocated @return the next slot that is free to be allocated

Returns:

the next slot that is free to be allocated

promote

public void promote(PromotionOffer offer,
           Expression parent)
             throws XPathException

Offer promotion for subexpressions within this pattern. The offer will be accepted if the subexpression is not dependent on the factors (e.g. the context item) identified in the PromotionOffer. By default the offer is not accepted - this is appropriate in the case of simple expressions such as constant values and variable references where promotion would give no performance advantage. This method is always called at compile time.

Unlike the corresponding method on Expression, this method does not return anything: it can make internal changes to the pattern, but cannot return a different pattern. Only certain kinds of promotion are applicable within a pattern: specifically, promotions affecting local variable references within the pattern.

Overrides:

promote in class Pattern

Parameters:

offer - details of the offer, for example the offer to move expressions that don't depend on the context to an outer level in the containing expression

parent - he parent expression

Throws:

XPathException - if any error is detected

matches

public boolean matches(Item item,
              XPathContext context)
                throws XPathException

Determine whether the pattern matches a given item.

Specified by:

matches in class Pattern

Parameters:

item - the item to be tested

context - The dynamic context.

Returns:

true if the pattern matches, else false

Throws:

XPathException - if an error occurs while matching the pattern (the caller will usually treat this the same as a false result)

matchesBeneathAnchor

public boolean matchesBeneathAnchor(NodeInfo node,
                           NodeInfo anchor,
                           XPathContext context)
                             throws XPathException

Determine whether this pattern matches a given Node within the subtree rooted at a given anchor node. This method is used when the pattern is used for streaming.

Overrides:

matchesBeneathAnchor in class Pattern

Parameters:

node - The NodeInfo representing the Element or other node to be tested against the Pattern

anchor - The anchor node, which must match any AnchorPattern subpattern

context - The dynamic context. Only relevant if the pattern uses variables, or contains calls on functions such as document() or key().

Returns:

true if the node matches the Pattern, false otherwise

Throws:

XPathException - if an error occurs while matching the pattern (the caller will usually treat this the same as a false result)

getUType

public UType getUType()

Get a UType indicating which kinds of items this Pattern can match.

Specified by:

getUType in class Pattern

Returns:

a UType indicating all the primitive types of item that the pattern can match.

getFingerprint

public int getFingerprint()

Determine the fingerprint of nodes to which this pattern applies. Used for optimisation.

Overrides:

getFingerprint in class Pattern

Returns:

the fingerprint of nodes matched by this pattern.

getItemType

public ItemType getItemType()

Get a NodeTest that all the nodes matching this pattern must satisfy

Specified by:

getItemType in class Pattern

Returns:

an ItemType, as specific as possible, which all the matching items satisfy

convertToTypedPattern

public Pattern convertToTypedPattern(String val)
                              throws XPathException

Convert the pattern to a typed pattern, in which an element name is treated as schema-element(N)

Overrides:

convertToTypedPattern in class Pattern

Parameters:

val - either "strict" or "lax" depending on the value of xsl:mode/@typed

Returns:

either the original pattern unchanged, or a new pattern as the result of the conversion

Throws:

XPathException - if the pattern cannot be converted

toString

public String toString()

Get the original pattern text

Overrides:

toString in class Pattern

Returns:

a representation of the expression as a string

equals

public boolean equals(Object other)

Determine whether this pattern is the same as another pattern

Overrides:

equals in class Object

Parameters:

other - the other object

hashCode

public int hashCode()

hashcode supporting equals()

Overrides:

hashCode in class Object

export

public void export(ExpressionPresenter presenter)

Description copied from class: Expression

Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.

Specified by:

export in class Pattern

Parameters:

presenter - the expression presenter used to display the structure

copy

public Pattern copy()

Copy a pattern. This makes a deep copy.

Specified by:

copy in class Pattern

Returns:

the copy of the original pattern