public final class AxisExpression extends Expression
An AxisExpression delivers nodes in axis order (not in document order). To get nodes in document order, in the case of a reverse axis, the expression should be wrapped in a call on reverse().
EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, EVENT_FEED_METHOD, INHERITED_CONTEXT, INSPECTION_CONTEXT, ITEM_FEED_METHOD, ITERATE_METHOD, locationId, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, NAVIGATION_CONTEXT, NODE_VALUE_CONTEXT, PROCESS_METHOD, PUSH_SELECTION, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, W3C_CONSUMING, W3C_FREE_RANGING, W3C_GROUP_CONSUMING, W3C_MOTIONLESS, WATCH_METHOD| Constructor and Description |
|---|
AxisExpression(byte axis,
NodeTest nodeTest)
Constructor for an AxisExpression whose origin is the context item
|
| Modifier and Type | Method and Description |
|---|---|
PathMap.PathMapNodeSet |
addToPathMap(PathMap pathMap,
PathMap.PathMapNodeSet pathMapNodeSet)
Add a representation of this expression to a PathMap.
|
int |
computeCardinality()
Determine the cardinality of the result of this expression
|
int |
computeSpecialProperties()
Get the static properties of this expression (other than its type).
|
Expression |
copy()
Copy an expression.
|
boolean |
equals(Object other)
Is this expression the same as another expression?
|
void |
explain(ExpressionPresenter destination)
Diagnostic print of expression structure.
|
byte |
getAxis()
Get the axis
|
ItemType |
getContextItemType()
Get the static type of the context item for this AxisExpression.
|
ExpressionCompiler |
getExpressionCompiler()
Return the compiler of the Axis expression
|
String |
getExpressionName()
Get a name identifying the kind of expression, in terms meaningful to a user.
|
int |
getIntrinsicDependencies()
Determine the intrinsic dependencies of an expression, that is, those which are not derived
from the dependencies of its subexpressions.
|
ItemType |
getItemType(TypeHierarchy th)
Determine the data type of the items returned by this expression
|
NodeTest |
getNodeTest()
Get the NodeTest.
|
int |
getStreamability(int syntacticContext,
boolean allowExtensions,
List<String> reasons)
Get the "sweep" of this expression as defined in the W3C streamability specifications.
|
int |
hashCode()
get HashCode for comparing two expressions
|
boolean |
isContextPossiblyUndefined()
Ask whether there is a possibility that the context item will be undefined
|
boolean |
isSubtreeExpression()
Determine whether the expression can be evaluated without reference to the part of the context
document outside the subtree rooted at the context node.
|
SequenceIterator |
iterate(Item origin)
Iterate the axis from a given starting node, without regard to context
|
AxisIterator<? extends NodeInfo> |
iterate(XPathContext context)
Evaluate the path-expression in a given context to return a NodeSet
|
Expression |
simplify(ExpressionVisitor visitor)
Simplify an expression
|
Pattern |
toPattern(Configuration config,
boolean is30)
Convert this expression to an equivalent XSLT pattern
|
Pattern |
toStreamingPattern(Configuration config,
List<String> reasonForFailure)
Convert this expression to a streaming pattern (a pattern used internally to match nodes during
push processing of an event stream)
|
String |
toString()
Represent the expression as a string.
|
String |
toString(NamePool pool)
Represent the expression as a string for diagnostics
|
Expression |
typeCheck(ExpressionVisitor visitor,
ExpressionVisitor.ContextItemType contextItemType)
Type-check the expression
|
adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, evaluateItem, evaluatePendingUpdates, explain, getCardinality, getColumnNumber, getColumnNumber, getConstructType, getContainer, getDependencies, getEvaluationMethod, getExecutable, getHostLanguage, getImplementationMethod, getIntegerBounds, getLineNumber, getLineNumber, getLocationId, getLocationProvider, getObjectName, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getStreamingAdjunct, getSystemId, getSystemId, hasVariableBinding, implementsStaticTypeCheck, isUpdatingExpression, isVacuousExpression, iterateEvents, iterateSubExpressionInfo, iterateSubExpressions, markTailFunctionCalls, optimize, process, promote, replaceSubExpression, resetLocalStaticProperties, setContainer, setEvaluationMethod, setFiltered, setFlattened, setLocationId, staticTypeCheck, suppressValidation, typeErrorpublic AxisExpression(byte axis,
NodeTest nodeTest)
public String getExpressionName()
getExpressionName in class Expressionpublic Expression simplify(ExpressionVisitor visitor) throws XPathException
simplify in class Expressionvisitor - an expression visitorXPathException - if an error is discovered during expression
rewritingpublic Expression typeCheck(ExpressionVisitor visitor, ExpressionVisitor.ContextItemType contextItemType) throws XPathException
typeCheck in class Expressionvisitor - an expression visitorcontextItemType - 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_TYPEXPathException - if an error is discovered during this phase
(typically a type error)public ItemType getContextItemType()
public boolean equals(Object other)
public int hashCode()
public Expression copy()
copy in class Expressionpublic int computeSpecialProperties()
computeSpecialProperties in class Expressionpublic final ItemType getItemType(TypeHierarchy th)
getItemType in class Expressionth - the type hierarchy cachepublic int getIntrinsicDependencies()
getIntrinsicDependencies in class Expressionpublic final int computeCardinality()
computeCardinality in class ExpressionStaticProperty.ALLOWS_ZERO_OR_ONE,
StaticProperty.EXACTLY_ONE, StaticProperty.ALLOWS_ONE_OR_MORE,
StaticProperty.ALLOWS_ZERO_OR_MOREpublic boolean isSubtreeExpression()
isSubtreeExpression in class Expressionpublic byte getAxis()
AxisInfo.CHILDpublic NodeTest getNodeTest()
public PathMap.PathMapNodeSet addToPathMap(PathMap pathMap, PathMap.PathMapNodeSet pathMapNodeSet)
addToPathMap in class ExpressionpathMap - the PathMap to which the expression should be addedpathMapNodeSet - public boolean isContextPossiblyUndefined()
public int getStreamability(int syntacticContext,
boolean allowExtensions,
List<String> reasons)
ExpressiongetStreamability in class ExpressionsyntacticContext - one of the values Expression.NAVIGATION_CONTEXT,
Expression.NODE_VALUE_CONTEXT, Expression.INHERITED_CONTEXT, Expression.INSPECTION_CONTEXTallowExtensions - if false, the definition of "guaranteed streamability" in the
W3C specification is used. If true, Saxon extensions are permitted, which make somereasons - the caller may supply a list, in which case the implementation may add to this
list a message explaining why the construct is not streamable, suitable for inclusion in an
error message.Expression.W3C_MOTIONLESS, Expression.W3C_CONSUMING,
Expression.W3C_GROUP_CONSUMING, Expression.W3C_FREE_RANGINGpublic Pattern toPattern(Configuration config, boolean is30) throws XPathException
toPattern in class Expressionconfig - the Saxon configurationis30 - true if this is XSLT 3.0XPathException - if conversion is not possiblepublic Pattern toStreamingPattern(Configuration config, List<String> reasonForFailure)
toStreamingPattern in class Expressionconfig - the Saxon configurationreasonForFailure - a list which will be populated with messages giving reasons why the
expression cannot be convertedpublic AxisIterator<? extends NodeInfo> iterate(XPathContext context) throws XPathException
iterate in class Expressioncontext - the evaluation contextXPathException - if any dynamic error occurs evaluating the
expressionpublic SequenceIterator iterate(Item origin) throws XPathException
origin - the starting nodeXPathExceptionpublic ExpressionCompiler getExpressionCompiler()
getExpressionCompiler in class Expressionpublic void explain(ExpressionPresenter destination)
explain in class Expressiondestination - the expression presenter used to display the structurepublic String toString()
toString in class ExpressionCopyright (c) 2004-2013 Saxonica Limited. All rights reserved.