org.exolab.adaptx.xpath.expressions

Interface NodeExpression

All Superinterfaces:
MatchExpression, XPathExpression

public interface NodeExpression
extends XPathExpression, MatchExpression

Represents an XPath node expression.

Author:
Keith Visco

Field Summary

static short
ANY_EXPR
The node expression type that selects or matches "any" node.
static short
ATTRIBUTE_EXPR
The node expression type that selects or matches attribute nodes
static short
COMMENT_EXPR
The node expression type that selects or matches comment nodes
static short
ELEMENT_EXPR
The node expression type that selects or matches element nodes
static short
IDENTITY_EXPR
The node expression type that selects or matches the current context node
static short
ID_EXPR
The node expression type that selects or matches any element node with a specific ID
static short
NAMESPACE_EXPR
The node expression type that selects or matches namespace nodes
static short
PARENT_EXPR
The node expression type that selects or matches the parent node of the current context node.
static short
PI_EXPR
The node expression type that selects or matches Processing Instruction nodes
static short
TEXT_EXPR
The node expression type that selects or matches text nodes
static short
WILDCARD_EXPR
The node expression type that selects or matches any element node

Fields inherited from interface org.exolab.adaptx.xpath.XPathExpression

BOOLEAN, ERROR, FILTER_EXPR, LOCATION_PATH, NODE_TEST, NUMBER, PATH_EXPR, PRIMARY, STEP, STRING, UNION_EXPR

Method Summary

String
getName()
Returns the QName matched by this NodeExpression.
short
getNodeExprType()
Returns the type of this Node exprression, the value must be one of the value Node expression types.
boolean
matches(XPathNode node, XPathContext context)
Determines if the given node is matched by this MatchExpr with respect to the given context.

Methods inherited from interface org.exolab.adaptx.xpath.expressions.MatchExpression

matches

Methods inherited from interface org.exolab.adaptx.xpath.XPathExpression

evaluate, getExprType, toString

Field Details

ANY_EXPR

public static final short ANY_EXPR
The node expression type that selects or matches "any" node.

Field Value:
0


ATTRIBUTE_EXPR

public static final short ATTRIBUTE_EXPR
The node expression type that selects or matches attribute nodes

Field Value:
1


COMMENT_EXPR

public static final short COMMENT_EXPR
The node expression type that selects or matches comment nodes

Field Value:
7


ELEMENT_EXPR

public static final short ELEMENT_EXPR
The node expression type that selects or matches element nodes

Field Value:
2


IDENTITY_EXPR

public static final short IDENTITY_EXPR
The node expression type that selects or matches the current context node

Field Value:
4


ID_EXPR

public static final short ID_EXPR
The node expression type that selects or matches any element node with a specific ID

Field Value:
3


NAMESPACE_EXPR

public static final short NAMESPACE_EXPR
The node expression type that selects or matches namespace nodes

Field Value:
10


PARENT_EXPR

public static final short PARENT_EXPR
The node expression type that selects or matches the parent node of the current context node.

Field Value:
5


PI_EXPR

public static final short PI_EXPR
The node expression type that selects or matches Processing Instruction nodes

Field Value:
8


TEXT_EXPR

public static final short TEXT_EXPR
The node expression type that selects or matches text nodes

Field Value:
6


WILDCARD_EXPR

public static final short WILDCARD_EXPR
The node expression type that selects or matches any element node

Field Value:
9

Method Details

getName

public String getName()
Returns the QName matched by this NodeExpression. The value may be null, for example if this is a TEXT_EXPR or a WILDCARD_EXPR.

Returns:
the QName matched by this NodeExpression.


getNodeExprType

public short getNodeExprType()
Returns the type of this Node exprression, the value must be one of the value Node expression types.

Returns:
the type of this Node expression


matches

public boolean matches(XPathNode node,
                       XPathContext context)
            throws XPathException
Determines if the given node is matched by this MatchExpr with respect to the given context.
Specified by:
matches in interface MatchExpression

Parameters:
node - the node to determine a match for
context - the XPathContext

Returns:
true if the given node is matched by this MatchExpr

Throws:
XPathException - when an error occurs during evaluation