public class GeneralPositionalPattern extends Pattern
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 and Description |
---|
GeneralPositionalPattern(NodeTest base,
Expression positionExpr)
Create a GeneralPositionalPattern
|
Modifier and Type | Method and Description |
---|---|
int |
allocateSlots(SlotManager slotManager,
int nextFree)
Allocate slots to any variables used within the pattern
|
int |
computeHashCode()
hashcode supporting equals()
|
Pattern |
copy(RebindingMap rebindings)
Copy a pattern.
|
boolean |
equals(java.lang.Object other)
Determine whether this pattern is the same as another pattern
|
void |
export(ExpressionPresenter presenter)
Diagnostic print of expression structure.
|
int |
getDependencies()
Get the dependencies of the pattern.
|
int |
getFingerprint()
Determine the fingerprint of nodes to which this pattern applies.
|
ItemType |
getItemType()
Get an ItemType that all the nodes matching this pattern must satisfy
|
NodeTest |
getNodeTest()
Get the base pattern
|
Expression |
getPositionExpr()
Get the filter assocated with the pattern
|
UType |
getUType()
Get a UType indicating which kinds of items this Pattern can match.
|
boolean |
isMotionless()
Test whether a pattern is motionless, that is, whether it can be evaluated against a node
without repositioning the input stream.
|
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.
|
java.lang.Iterable<Operand> |
operands()
Get the immediate sub-expressions of this expression, with information about the relationship
of each expression to its parent expression.
|
Pattern |
optimize(ExpressionVisitor visitor,
ContextItemStaticInfo contextInfo)
Perform optimisation of an expression and its subexpressions.
|
Pattern |
simplify()
Simplify the pattern: perform any context-independent optimisations
|
java.lang.String |
toString()
Get a string representation of the pattern.
|
Pattern |
typeCheck(ExpressionVisitor visitor,
ContextItemStaticInfo contextItemType)
Type-check the pattern, performing any type-dependent optimizations.
|
bindCurrent, convertToTypedPattern, effectiveBooleanValue, getDefaultPriority, getHostLanguage, handleDynamicError, isLiftable, isRecoverable, make, matchesCurrentGroup, patternContainsVariable, replaceCurrent, selectNodes, setOriginalText, setPriority, setRecoverable, toShortString
computeCardinality, evaluateAsString, evaluateItem, getImplementationMethod, iterate, process
addToPathMap, adoptChildExpression, allowExtractingCommonSubexpressions, checkedOperands, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeSpecialProperties, computeStaticProperties, dynamicError, evaluatePendingUpdates, explain, getCardinality, getConfiguration, getConstructType, getCost, getEvaluationMethod, getExpressionName, getExtraProperty, getIntegerBounds, getInterpretedExpression, getIntrinsicDependencies, getLocalRetainedStaticContext, getLocation, getNetCost, getObjectName, getPackageData, getParentExpression, getProperties, getProperty, getRetainedStaticContext, getScopingExpression, getSlotsUsed, getSpecialProperties, getStaticBaseURI, getStaticBaseURIString, getStaticType, getStaticUType, getStreamerName, hasCompatibleStaticContext, hashCode, hasVariableBinding, identityHashCode, implementsStaticTypeCheck, isCallOn, isCallOnSystemFunction, isIdentical, isInstruction, isMultiThreaded, isSameExpression, isStaticPropertiesKnown, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, markTailFunctionCalls, operandList, operandSparseList, optimizeChildren, resetLocalStaticProperties, restoreParentPointers, setEvaluationMethod, setExtraProperty, setFiltered, setFlattened, setLocation, setParentExpression, setRetainedStaticContext, setRetainedStaticContextLocally, setRetainedStaticContextThoroughly, setStaticProperty, simplifyChildren, staticTypeCheck, suppressValidation, toPattern, typeCheckChildren, typeError, unordered, verifyParentPointers, verifyParentPointers
public GeneralPositionalPattern(NodeTest base, Expression positionExpr)
base
- the base expression (to be matched independently of position)positionExpr
- the positional filter which matches only if the position of the node is correctpublic java.lang.Iterable<Operand> operands()
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.
operands
in class Expression
public Expression getPositionExpr()
public NodeTest getNodeTest()
public Pattern simplify() throws XPathException
simplify
in class Pattern
XPathException
- if an error is discovered during expression
rewritingpublic Pattern typeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextItemType) throws XPathException
typeCheck
in class Pattern
visitor
- an expression visitorcontextItemType
- the type of the context item at the point where the pattern appearsXPathException
- if an error is discovered during this phase
(typically a type error)public Pattern optimize(ExpressionVisitor visitor, ContextItemStaticInfo contextInfo) throws XPathException
This method is called after all references to functions and variables have been resolved to the declaration of the function or variable, and after all type checking has been done.
optimize
in class Pattern
visitor
- an expression visitorcontextInfo
- the static type of "." at the point where this expression is invoked.
The parameter is set to null if it is known statically that the context item will be undefined.
If the type of the context item is not known statically, the argument is set to
Type.ITEM_TYPE
XPathException
- if an error is discovered during this phase
(typically a type error)public int getDependencies()
getDependencies
in class Pattern
public int allocateSlots(SlotManager slotManager, int nextFree)
allocateSlots
in class Pattern
slotManager
- manages allocation of slots in a stack framenextFree
- the next slot that is free to be allocated @return the next slot that is free to be allocatedpublic boolean matches(Item item, XPathContext context) throws XPathException
matches
in class Pattern
item
- the item to be testedcontext
- The dynamic context.XPathException
- if an error occurs while matching the pattern (the caller will usually
treat this the same as a false result)public boolean matchesBeneathAnchor(NodeInfo node, NodeInfo anchor, XPathContext context) throws XPathException
matchesBeneathAnchor
in class Pattern
node
- The NodeInfo representing the Element or other node to be tested against the Patternanchor
- The anchor node, which must match any AnchorPattern subpatterncontext
- The dynamic context. Only relevant if the pattern
uses variables, or contains calls on functions such as document() or key().XPathException
- if an error occurs while matching the pattern (the caller will usually
treat this the same as a false result)public UType getUType()
public int getFingerprint()
getFingerprint
in class Pattern
public ItemType getItemType()
getItemType
in class Pattern
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
other
- the other objectpublic int computeHashCode()
computeHashCode
in class Expression
public boolean isMotionless()
isMotionless
in class Pattern
public Pattern copy(RebindingMap rebindings)
public java.lang.String toString()
public void export(ExpressionPresenter presenter) throws XPathException
Expression
export
in interface ExportAgent
export
in class Pattern
presenter
- the expression presenter used to display the structureXPathException
- if the export fails, for example if an expression is found that won't work
in the target environment.Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.