Package org.jaxen.expr

Class DefaultFilterExpr

java.lang.Object

org.jaxen.expr.DefaultFilterExpr

All Implemented Interfaces:

java.io.Serializable, Expr, FilterExpr, Predicated

public class DefaultFilterExpr
extends java.lang.Object
implements FilterExpr, Predicated

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultFilterExpr(Expr expr, PredicateSet predicateSet)
DefaultFilterExpr(PredicateSet predicateSet)

Method Summary

Modifier and Type	Method	Description
void	addPredicate(Predicate predicate)	Add an additional predicate to this object.
boolean	asBoolean(Context context)	Returns true if the current filter matches at least one of the context nodes
static java.util.Iterator	convertToIterator(java.lang.Object obj)
static java.util.List	convertToList(java.lang.Object obj)
java.lang.Object	evaluate(Context context)	Evaluate the expression in the given context, and return the result.
Expr	getExpr()
java.util.List	getPredicates()	Returns a possibly empty list of predicates.
PredicateSet	getPredicateSet()	Returns a possibly empty set of predicates.
java.lang.String	getText()	Returns a String containing the XPath expression.
Expr	simplify()	Simplifies the XPath expression.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultFilterExpr

public DefaultFilterExpr(PredicateSet predicateSet)

DefaultFilterExpr

public DefaultFilterExpr(Expr expr,
                         PredicateSet predicateSet)

Method Detail

addPredicate

public void addPredicate(Predicate predicate)

Description copied from interface: Predicated

Add an additional predicate to this object.

Specified by:

addPredicate in interface Predicated

Parameters:

predicate - the predicate to add

getPredicates

public java.util.List getPredicates()

Description copied from interface: Predicated

Returns a possibly empty list of predicates.

Specified by:

getPredicates in interface Predicated

Returns:

the list of predicates

getPredicateSet

public PredicateSet getPredicateSet()

Description copied from interface: Predicated

Returns a possibly empty set of predicates.

Specified by:

getPredicateSet in interface Predicated

Returns:

the set of predicates

getExpr

public Expr getExpr()

Specified by:

getExpr in interface FilterExpr

Returns:

the underlying filter expression

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getText

public java.lang.String getText()

Description copied from interface: Expr

Returns a String containing the XPath expression.

Specified by:

getText in interface Expr

Returns:

the text form of this XPath expression

simplify

public Expr simplify()

Description copied from interface: Expr

Simplifies the XPath expression. For example, the expression //para[1 = 1] could be simplified to //para. In practice, this is usually a noop. Jaxen does not currently perform any simplification.

Specified by:

simplify in interface Expr

Returns:

the simplified expression

asBoolean

public boolean asBoolean(Context context)
                  throws JaxenException

Returns true if the current filter matches at least one of the context nodes

Specified by:

asBoolean in interface FilterExpr

Returns:

true if a node matches; false if no node matches

Throws:

JaxenException

evaluate

public java.lang.Object evaluate(Context context)
                          throws JaxenException

Description copied from interface: Expr

Evaluate the expression in the given context, and return the result. The result will be a java.lang.Double for expressions that return a number, a java.lang.String for expressions that return a string, a java.lang.Boolean for expressions that return a boolean, and a java.util.List for expressions that return a node-set. In the latter case, the elements of the list are the actual objects from the source document model. Copies are not made.

Specified by:

evaluate in interface Expr

Parameters:

context - the context in which the expression is evaluated

Returns:

an object representing the result of the evaluation

Throws:

JaxenException

convertToIterator

public static java.util.Iterator convertToIterator(java.lang.Object obj)

convertToList

public static java.util.List convertToList(java.lang.Object obj)