net.sf.saxon.pattern

Class LocationPathPattern

public final class LocationPathPattern extends Pattern

A LocationPathPattern represents a path, for example of the form A/B/C... The components are represented as a linked list, each component pointing to its predecessor
Field Summary
PatternancestorPattern
protected ExpressionequivalentExpr
protected Expression[]filters
protected booleanfirstElementPattern
protected booleanlastElementPattern
NodeTestnodeTest
protected intnumberOfFilters
PatternparentPattern
protected booleanspecialFilter
Constructor Summary
LocationPathPattern()
Create a LocationPathPattern
Method Summary
voidaddFilter(Expression filter)
Add a filter to the pattern (while under construction)
intallocateSlots(StaticContext env, SlotManager slotManager, int nextFree)
Allocate slots to any variables used within the pattern
Patternanalyze(ExpressionVisitor visitor, ItemType contextItemType)
Type-check the pattern, performing any type-dependent optimizations.
booleanequals(Object other)
Determine whether this pattern is the same as another pattern
PatterngetAncestorPattern()
Get the pattern applying to an ancestor node, if there is one
intgetDependencies()
Get the dependencies of the pattern.
Expression[]getFilters()
Get the filters assocated with the last step in the pattern
intgetFingerprint()
Determine the fingerprint of nodes to which this pattern applies.
intgetNodeKind()
Determine the types of nodes to which this pattern applies.
NodeTestgetNodeTest()
Get a NodeTest that all the nodes matching this pattern must satisfy
PatterngetParentPattern()
Get the pattern applying to the parent node, if there is one
inthashCode()
Hashcode supporting equals()
protected booleaninternalMatches(NodeInfo node, XPathContext context)
Test whether the pattern matches, but without changing the current() node
IteratoriterateSubExpressions()
Iterate over the subexpressions within this pattern
booleanmatches(NodeInfo node, XPathContext context)
Determine whether the pattern matches a given node.
voidpromote(PromotionOffer offer, Expression parent)
Offer promotion for subexpressions within this pattern.
booleanreplaceSubExpression(Expression original, Expression replacement)
Replace one subexpression by a replacement subexpression
voidresolveCurrent(LetExpression let, PromotionOffer offer, boolean topLevel)
If the pattern contains any calls on current(), this method is called to modify such calls to become variable references to a variable declared in a specially-allocated local variable
voidsetExecutable(Executable executable)
Set the executable containing this pattern
voidsetLineNumber(int lineNumber)
voidsetSystemId(String systemId)
Patternsimplify(ExpressionVisitor visitor)
Simplify the pattern: perform any context-independent optimisations

Field Detail

ancestorPattern

public Pattern ancestorPattern

equivalentExpr

protected Expression equivalentExpr

filters

protected Expression[] filters

firstElementPattern

protected boolean firstElementPattern

lastElementPattern

protected boolean lastElementPattern

nodeTest

public NodeTest nodeTest

numberOfFilters

protected int numberOfFilters

parentPattern

public Pattern parentPattern

specialFilter

protected boolean specialFilter

Constructor Detail

LocationPathPattern

public LocationPathPattern()
Create a LocationPathPattern

Method Detail

addFilter

public void addFilter(Expression filter)
Add a filter to the pattern (while under construction)

Parameters: filter The predicate (a boolean expression or numeric expression) to be added

allocateSlots

public int allocateSlots(StaticContext env, SlotManager slotManager, int nextFree)
Allocate slots to any variables used within the pattern

Parameters: env the static context in the XSLT stylesheet slotManager nextFree the next slot that is free to be allocated @return the next slot that is free to be allocated

analyze

public Pattern analyze(ExpressionVisitor visitor, ItemType contextItemType)
Type-check the pattern, performing any type-dependent optimizations.

Parameters: visitor an expression visitor contextItemType the type of the context item at the point where the pattern appears

Returns: the optimised Pattern

equals

public boolean equals(Object other)
Determine whether this pattern is the same as another pattern

Parameters: other the other object

getAncestorPattern

public Pattern getAncestorPattern()
Get the pattern applying to an ancestor node, if there is one

Returns: the ancestor pattern, for example if the pattern is a/b[1]//c then the ancestor pattern is a/b[1]

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.

getFilters

public Expression[] getFilters()
Get the filters assocated with the last step in the pattern

Returns: an array of expression holding the filter predicates in order

getFingerprint

public int getFingerprint()
Determine the fingerprint of nodes to which this pattern applies. Used for optimisation.

Returns: the fingerprint of nodes matched by this pattern.

getNodeKind

public int getNodeKind()
Determine the types of nodes to which this pattern applies. Used for optimisation. For patterns that match nodes of several types, return Node.NODE

Returns: the type of node matched by this pattern. e.g. Node.ELEMENT or Node.TEXT

getNodeTest

public NodeTest getNodeTest()
Get a NodeTest that all the nodes matching this pattern must satisfy

getParentPattern

public Pattern getParentPattern()
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]

hashCode

public int hashCode()
Hashcode supporting equals()

internalMatches

protected boolean internalMatches(NodeInfo node, XPathContext context)
Test whether the pattern matches, but without changing the current() node

iterateSubExpressions

public Iterator iterateSubExpressions()
Iterate over the subexpressions within this pattern

matches

public boolean matches(NodeInfo node, XPathContext context)
Determine whether the pattern matches a given node.

Parameters: node the node to be tested

Returns: true if the pattern matches, else false

promote

public void promote(PromotionOffer offer, Expression parent)
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.

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

Throws: net.sf.saxon.trans.XPathException if any error is detected

replaceSubExpression

public boolean replaceSubExpression(Expression original, Expression replacement)
Replace one subexpression by a replacement subexpression

Parameters: original the original subexpression replacement the replacement subexpression

Returns: true if the original subexpression is found

resolveCurrent

public void resolveCurrent(LetExpression let, PromotionOffer offer, boolean topLevel)
If the pattern contains any calls on current(), this method is called to modify such calls to become variable references to a variable declared in a specially-allocated local variable

Parameters: let the expression that assigns the local variable. This returns a dummy result, and is executed just before evaluating the pattern, to get the value of the context item into the variable. offer A PromotionOffer used to process the expressions and change the call on current() into a variable reference topLevel

Throws: XPathException

setExecutable

public void setExecutable(Executable executable)
Set the executable containing this pattern

Parameters: executable the executable

setLineNumber

public void setLineNumber(int lineNumber)

setSystemId

public void setSystemId(String systemId)

simplify

public Pattern simplify(ExpressionVisitor visitor)
Simplify the pattern: perform any context-independent optimisations

Parameters: visitor an expression visitor