public class NodeSetPattern extends Pattern
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.
Modifier and Type | Field and Description |
---|---|
protected ItemType |
itemType |
protected Operand |
selectionOp |
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 |
---|
NodeSetPattern(Expression exp)
Create a node-set pattern.
|
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.
|
ItemType |
getItemType()
Get a NodeTest that all the nodes matching this pattern must satisfy
|
Expression |
getSelectionExpression()
Get the underlying expression
|
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 this Pattern matches the given 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.
|
SequenceIterator |
selectNodes(TreeInfo doc,
XPathContext context)
Select nodes in a document using this PatternFinder.
|
void |
setItemType(ItemType type)
Set the item type, that is, the type of nodes/items which the pattern will match
|
java.lang.String |
toString()
Get a string representation of the pattern.
|
Pattern |
typeCheck(ExpressionVisitor visitor,
ContextItemStaticInfo contextItemType)
Type-check the pattern.
|
bindCurrent, convertToTypedPattern, effectiveBooleanValue, getDefaultPriority, getFingerprint, getHostLanguage, handleDynamicError, isLiftable, isRecoverable, make, matchesBeneathAnchor, matchesCurrentGroup, optimize, patternContainsVariable, replaceCurrent, setOriginalText, setPriority, setRecoverable, simplify, 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 NodeSetPattern(Expression exp)
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.public 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 getSelectionExpression()
public Pattern typeCheck(ExpressionVisitor visitor, ContextItemStaticInfo contextItemType) throws XPathException
typeCheck
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
- if an error is discovered during this phase
(typically a type error)public void setItemType(ItemType type)
type
- the item type that the pattern will matchpublic int getDependencies()
getDependencies
in class Pattern
public boolean isMotionless()
isMotionless
in class Pattern
public int allocateSlots(SlotManager slotManager, int nextFree)
allocateSlots
in class Pattern
slotManager
- 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 allocatedpublic SequenceIterator selectNodes(TreeInfo doc, XPathContext context) throws XPathException
selectNodes
in class Pattern
doc
- the document node at the root of a treecontext
- the dynamic evaluation contextXPathException
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.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 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 java.lang.String toString()
public Pattern copy(RebindingMap rebindings)
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.