Package org.apache.xpath.patterns
Class StepPattern
java.lang.Object
org.apache.xpath.Expression
org.apache.xpath.patterns.NodeTest
org.apache.xpath.patterns.StepPattern
- All Implemented Interfaces:
Serializable
,SourceLocator
,SubContextList
,ExpressionNode
,ExpressionOwner
,XPathVisitable
- Direct Known Subclasses:
ContextMatchStepPattern
,FunctionPattern
This class represents a single pattern match step.
- See Also:
-
Field Summary
Fields inherited from class org.apache.xpath.patterns.NodeTest
SCORE_NODETEST, SCORE_NONE, SCORE_NSWILD, SCORE_OTHER, SCORE_QNAME, SHOW_BYFUNCTION, SUPPORTS_PRE_STRIPPING, WILD
-
Constructor Summary
ConstructorsConstructorDescriptionStepPattern
(int whatToShow, int axis, int axisForPredicate) Construct a StepPattern that doesn't test for node names.StepPattern
(int whatToShow, String namespace, String name, int axis, int axisForPredicate) Construct a StepPattern that tests for namespaces and node names. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Static calc of match score.void
Calculate the local name or psuedo name of the node that this pattern will test, for hash table lookup optimization.void
callVisitors
(ExpressionOwner owner, XPathVisitor visitor) This will traverse the heararchy, calling the visitor for each member.boolean
Tell if this expression or it's subexpressions can traverse outside the current subtree.boolean
deepEquals
(Expression expr) Compare this object with another object and see if they are equal, include the sub heararchy.execute
(XPathContext xctxt) Execute this pattern step, including predicates.execute
(XPathContext xctxt, int currentNode) Execute this pattern step, including predicates.execute
(XPathContext xctxt, int currentNode, DTM dtm, int expType) Execute an expression in the XPath runtime context, and return the result of the expression.void
fixupVariables
(Vector vars, int globalsSize) This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.int
getAxis()
Get the axis that this step follows.Get the raw Expression object that this class wraps.int
getLastPos
(XPathContext xctxt) Get the count of the nodes that match the test, which is the proximity position of the last node that can pass this test in the sub context selection.double
getMatchScore
(XPathContext xctxt, int context) Get the match score of the given node.getPredicate
(int i) Get a predicate expression.final int
Get the number of predicates for this match pattern step.Set the list of predicate expressions for this pattern step.int
getProximityPosition
(XPathContext xctxt) Get the proximity position index of the current node based on this node test.Get the reference to nodetest and predicate for parent or ancestor.Get the local name or psuedo name of the node that this pattern will test, for hash table lookup optimization.void
setAxis
(int axis) Set the axis that this step should follow.void
setExpression
(Expression exp) Set the raw expression object for this object.void
setPredicates
(Expression[] predicates) Set the predicates for this match pattern step.void
Set the reference to nodetest and predicate for parent or ancestor.toString()
Get the string represenentation of this step for diagnostic purposes.Methods inherited from class org.apache.xpath.patterns.NodeTest
debugWhatToShow, getDefaultScore, getLocalName, getNamespace, getNodeTypeTest, getStaticScore, getWhatToShow, initNodeTest, initNodeTest, setLocalName, setNamespace, setStaticScore, setWhatToShow
Methods inherited from class org.apache.xpath.Expression
asIterator, asIteratorRaw, asNode, assertion, bool, error, execute, executeCharsToContentHandler, exprAddChild, exprGetChild, exprGetNumChildren, exprGetParent, exprSetParent, getColumnNumber, getExpressionOwner, getLineNumber, getPublicId, getSystemId, isNodesetExpr, isStableNumber, num, warn, xstr
-
Constructor Details
-
StepPattern
Construct a StepPattern that tests for namespaces and node names.- Parameters:
whatToShow
- Bit set defined mainly byNodeFilter
.namespace
- The namespace to be tested.name
- The local name to be tested.axis
- The Axis for this test, one of of Axes.ANCESTORORSELF, etc.axisForPredicate
- No longer used.
-
StepPattern
public StepPattern(int whatToShow, int axis, int axisForPredicate) Construct a StepPattern that doesn't test for node names.- Parameters:
whatToShow
- Bit set defined mainly byNodeFilter
.axis
- The Axis for this test, one of of Axes.ANCESTORORSELF, etc.axisForPredicate
- No longer used.
-
-
Method Details
-
calcTargetString
public void calcTargetString()Calculate the local name or psuedo name of the node that this pattern will test, for hash table lookup optimization.- See Also:
-
getTargetString
Get the local name or psuedo name of the node that this pattern will test, for hash table lookup optimization.- Returns:
- local name or psuedo name of the node.
- See Also:
-
fixupVariables
This function is used to fixup variables from QNames to stack frame indexes at stylesheet build time.- Overrides:
fixupVariables
in classNodeTest
- Parameters:
vars
- List of QNames that correspond to variables. This list should be searched backwards for the first qualified name that corresponds to the variable reference qname. The position of the QName in the vector from the start of the vector will be its position in the stack frame (but variables above the globalsTop value will need to be offset to the current stack frame).globalsSize
- The number of variables in the global variable area.
-
setRelativePathPattern
Set the reference to nodetest and predicate for parent or ancestor.- Parameters:
expr
- The relative pattern expression.
-
getRelativePathPattern
Get the reference to nodetest and predicate for parent or ancestor.- Returns:
- The relative pattern expression.
-
getPredicates
Set the list of predicate expressions for this pattern step.- Returns:
- List of expression objects.
-
canTraverseOutsideSubtree
public boolean canTraverseOutsideSubtree()Tell if this expression or it's subexpressions can traverse outside the current subtree. NOTE: Ancestors tests with predicates are problematic, and will require special treatment.- Overrides:
canTraverseOutsideSubtree
in classExpression
- Returns:
- true if traversal outside the context node's subtree can occur.
-
getPredicate
Get a predicate expression.- Parameters:
i
- The index of the predicate.- Returns:
- A predicate expression.
-
getPredicateCount
public final int getPredicateCount()Get the number of predicates for this match pattern step.- Returns:
- the number of predicates for this match pattern step.
-
setPredicates
Set the predicates for this match pattern step.- Parameters:
predicates
- An array of expressions that define predicates for this step.
-
calcScore
public void calcScore()Static calc of match score. -
execute
Execute this pattern step, including predicates.- Overrides:
execute
in classNodeTest
- Parameters:
xctxt
- XPath runtime context.currentNode
- The current node context.- Returns:
NodeTest.SCORE_NODETEST
,NodeTest.SCORE_NONE
,NodeTest.SCORE_NSWILD
,NodeTest.SCORE_QNAME
, orNodeTest.SCORE_OTHER
.- Throws:
TransformerException
-
execute
Execute this pattern step, including predicates.- Overrides:
execute
in classNodeTest
- Parameters:
xctxt
- XPath runtime context.- Returns:
NodeTest.SCORE_NODETEST
,NodeTest.SCORE_NONE
,NodeTest.SCORE_NSWILD
,NodeTest.SCORE_QNAME
, orNodeTest.SCORE_OTHER
.- Throws:
TransformerException
-
execute
public XObject execute(XPathContext xctxt, int currentNode, DTM dtm, int expType) throws TransformerException Execute an expression in the XPath runtime context, and return the result of the expression.- Overrides:
execute
in classNodeTest
- Parameters:
xctxt
- The XPath runtime context.currentNode
- The currentNode.dtm
- The DTM of the current node.expType
- The expanded type ID of the current node.- Returns:
- The result of the expression in the form of a
XObject
. - Throws:
TransformerException
- if a runtime exception occurs.
-
getProximityPosition
Get the proximity position index of the current node based on this node test.- Specified by:
getProximityPosition
in interfaceSubContextList
- Parameters:
xctxt
- XPath runtime context.- Returns:
- the proximity position index of the current node based on the node test.
-
getLastPos
Get the count of the nodes that match the test, which is the proximity position of the last node that can pass this test in the sub context selection. In XSLT 1-based indexing, this count is the index of the last node.- Specified by:
getLastPos
in interfaceSubContextList
- Parameters:
xctxt
- XPath runtime context.- Returns:
- the count of the nodes that match the test.
-
toString
Get the string represenentation of this step for diagnostic purposes. -
getMatchScore
Get the match score of the given node.- Parameters:
xctxt
- The XPath runtime context.context
- The node to be tested.- Returns:
NodeTest.SCORE_NODETEST
,NodeTest.SCORE_NONE
,NodeTest.SCORE_NSWILD
,NodeTest.SCORE_QNAME
, orNodeTest.SCORE_OTHER
.- Throws:
TransformerException
-
setAxis
public void setAxis(int axis) Set the axis that this step should follow.- Parameters:
axis
- The Axis for this test, one of of Axes.ANCESTORORSELF, etc.
-
getAxis
public int getAxis()Get the axis that this step follows.- Returns:
- The Axis for this test, one of of Axes.ANCESTORORSELF, etc.
-
callVisitors
Description copied from interface:XPathVisitable
This will traverse the heararchy, calling the visitor for each member. If the called visitor method returns false, the subtree should not be called.- Specified by:
callVisitors
in interfaceXPathVisitable
- Overrides:
callVisitors
in classNodeTest
- Parameters:
owner
- The owner of the visitor, where that path may be rewritten if needed.visitor
- The visitor whose appropriate method will be called.- See Also:
-
getExpression
Description copied from interface:ExpressionOwner
Get the raw Expression object that this class wraps.- Specified by:
getExpression
in interfaceExpressionOwner
- Returns:
- the raw Expression object, which should not normally be null.
- See Also:
-
setExpression
Description copied from interface:ExpressionOwner
Set the raw expression object for this object.- Specified by:
setExpression
in interfaceExpressionOwner
- Parameters:
exp
- the raw Expression object, which should not normally be null.- See Also:
-
deepEquals
Description copied from class:Expression
Compare this object with another object and see if they are equal, include the sub heararchy.- Overrides:
deepEquals
in classNodeTest
- Parameters:
expr
- Another expression object.- Returns:
- true if this objects class and the expr object's class are the same, and the data contained within both objects are considered equal.
- See Also:
-