Package net.sf.saxon.pattern
Class KeyPattern
java.lang.Object
net.sf.saxon.pattern.Pattern
net.sf.saxon.pattern.KeyPattern
- All Implemented Interfaces:
Serializable
,SourceLocator
,Container
A KeyPattern is a pattern of the form key(keyname, keyvalue)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionanalyze
(StaticContext env, ItemType contextItemType) Type-check the pattern.int
Get the dependencies of the pattern.Get a NodeTest that all the nodes matching this pattern must satisfyIterate over the subexpressions within this patternboolean
matches
(NodeInfo e, XPathContext context) Determine whether this Pattern matches the given Node.void
promote
(PromotionOffer offer) Offer promotion for subexpressions within this pattern.Methods inherited from class net.sf.saxon.pattern.Pattern
getColumnNumber, getDefaultPriority, getExecutable, getFingerprint, getHostLanguage, getLineNumber, getLocationProvider, getNodeKind, getPublicId, getSystemId, internalMatches, make, replaceSubExpression, setExecutable, setLineNumber, setOriginalText, setSystemId, simplify, toString
-
Constructor Details
-
KeyPattern
Constructor- Parameters:
namecode
- the name of the keykey
- the value of the key: either a StringValue or a VariableReference
-
-
Method Details
-
analyze
Type-check the pattern. This is needed for patterns that contain variable references or function calls.- Overrides:
analyze
in classPattern
- Returns:
- the optimised Pattern
- Throws:
XPathException
-
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 classPattern
-
iterateSubExpressions
Iterate over the subexpressions within this pattern- Overrides:
iterateSubExpressions
in classPattern
-
promote
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 classPattern
- 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- Throws:
XPathException
- if any error is detected
-
matches
Determine whether this Pattern matches the given Node.- Specified by:
matches
in classPattern
- Parameters:
e
- 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().- Returns:
- true if the node matches the Pattern, false otherwise
- Throws:
XPathException
-
getNodeTest
Get a NodeTest that all the nodes matching this pattern must satisfy- Specified by:
getNodeTest
in classPattern
-