|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.pattern.Pattern net.sf.saxon.pattern.NodeSetPattern
public class NodeSetPattern
A NodeSetPattern is a pattern based on an expression that is evaluated to return a set of nodes; a node matches the pattern if it is a member of this node-set.
In XSLT 2.0 there are two forms of NodeSetPattern allowed, represented by calls on the id() and key() functions. In XSLT 3.0, additional forms are allowed, for example a variable reference, and a call to the doc() function. This class provides the general capability to use any expression at the head of a pattern. This is used also to support streaming, where streaming XPath expressions are mapped to patterns.
Field Summary | |
---|---|
protected Expression |
expression
|
protected ItemType |
itemType
|
Constructor Summary | |
---|---|
NodeSetPattern(Expression exp,
Configuration config)
Create a node-set pattern. |
Method Summary | |
---|---|
int |
allocateSlots(StaticContext env,
SlotManager slotManager,
int nextFree)
Allocate slots to any variables used within the pattern |
Pattern |
analyze(ExpressionVisitor visitor,
ExpressionVisitor.ContextItemType contextItemType)
Type-check the pattern. |
boolean |
equals(Object other)
Determine whether this pattern is the same as another pattern |
int |
getDependencies()
Get the dependencies of the pattern. |
ItemType |
getItemType()
Get a NodeTest that all the nodes matching this pattern must satisfy |
int |
getNodeKind()
Determine the type of nodes to which this pattern applies. |
int |
hashCode()
Hashcode supporting equals() |
Iterator |
iterateSubExpressions()
Iterate over the subexpressions within this pattern |
boolean |
matches(Item item,
XPathContext context)
Determine whether this Pattern matches the given Node |
void |
promote(PromotionOffer offer,
Expression parent)
Offer promotion for subexpressions within this pattern. |
boolean |
replaceSubExpression(Expression original,
Expression replacement)
Replace a subexpression by a replacement subexpression |
Methods inherited from class net.sf.saxon.pattern.Pattern |
---|
getColumnNumber, getContainerGranularity, getDefaultPriority, getExecutable, getFingerprint, getHostLanguage, getLineNumber, getLocationProvider, getPublicId, getSystemId, internalMatches, make, matchesBeneathAnchor, resolveCurrent, selectNodes, setExecutable, setLineNumber, setOriginalText, setSystemId, simplify, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected Expression expression
protected ItemType itemType
Constructor Detail |
---|
public NodeSetPattern(Expression exp, Configuration config)
exp
- an expression that can be evaluated to return a node-set; a node matches the pattern
if it is present in this node-set. The expression must not depend on the focus, though it can depend on
other aspects of the dynamic context such as local or global variables.Method Detail |
---|
public Pattern analyze(ExpressionVisitor visitor, ExpressionVisitor.ContextItemType contextItemType) throws XPathException
analyze
in class Pattern
visitor
- the expression visitorcontextItemType
- the type of the context item at the point where the pattern
is defined. Set to null if it is known that the context item is undefined.
XPathException
public int getDependencies()
getDependencies
in class Pattern
public Iterator iterateSubExpressions()
iterateSubExpressions
in class Pattern
public void promote(PromotionOffer offer, Expression parent) throws XPathException
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.
promote
in class Pattern
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 expressionparent
-
XPathException
- if any error is detectedpublic boolean replaceSubExpression(Expression original, Expression replacement)
replaceSubExpression
in class Pattern
original
- the expression to be replacedreplacement
- the new expression to be inserted in its place
public int allocateSlots(StaticContext env, SlotManager slotManager, int nextFree)
allocateSlots
in class Pattern
env
- the static context in the XSLT stylesheetslotManager
- the slot manager representing the stack frame for local variablesnextFree
- the next slot that is free to be allocated @return the next slot that is free to be allocated
public boolean matches(Item item, XPathContext context) throws XPathException
matches
in class Pattern
item
- The NodeInfo representing the Element or other node to be tested against the Patterncontext
- The dynamic context. Only relevant if the pattern
uses variables, or contains calls on functions such as document() or key().
XPathException
public int getNodeKind()
getNodeKind
in class Pattern
public ItemType getItemType()
getItemType
in class Pattern
public boolean equals(Object other)
equals
in class Object
other
- the other objectpublic int hashCode()
hashCode
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |