org.jaxen.expr
Class PredicateSet

java.lang.Object
  extended by org.jaxen.expr.PredicateSet
All Implemented Interfaces:
Serializable

public class PredicateSet
extends Object
implements Serializable

Represents the collection of predicates that follow the node-test in a location path.

There is no rule that the same predicate may not appear twice in an XPath expression, nor does this class enforce any such rule. This is implemented more as a list than a set. However, adding the swme predicate twice should have no effect on the final result other than slowing it down.

See Also:
Serialized Form

Constructor Summary
PredicateSet()
          Create a new empty predicate set.
 
Method Summary
 void addPredicate(Predicate predicate)
          Add a predicate to the set.
 List applyPredicate(Predicate predicate, List nodes2Filter, ContextSupport support)
           
protected  boolean evaluateAsBoolean(List contextNodeSet, ContextSupport support)
          Returns true if any of the supplied nodes satisfy all the predicates in the set.
protected  List evaluatePredicates(List contextNodeSet, ContextSupport support)
          Returns all of the supplied nodes that satisfy all the predicates in the set.
 List getPredicates()
          Returns the list containing the predicates.
 String getText()
          Returns the XPath string containing each of the predicates.
 void simplify()
          Simplify each of the predicates in the list.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PredicateSet

public PredicateSet()
Create a new empty predicate set.

Method Detail

addPredicate

public void addPredicate(Predicate predicate)
Add a predicate to the set.

Parameters:
predicate - the predicate to be inserted

getPredicates

public List getPredicates()
Returns the list containing the predicates. This list is live, not a copy.

Returns:
a live list of predicates

simplify

public void simplify()
Simplify each of the predicates in the list.


getText

public String getText()
Returns the XPath string containing each of the predicates.

Returns:
the XPath string containing each of the predicates

evaluateAsBoolean

protected boolean evaluateAsBoolean(List contextNodeSet,
                                    ContextSupport support)
                             throws JaxenException

Returns true if any of the supplied nodes satisfy all the predicates in the set. Returns false if none of the supplied nodes matches all the predicates in the set. Returns false if the node-set is empty.

Parameters:
contextNodeSet - the nodes to test against these predicates
support - ????
Returns:
true if any node in the contextNodeSet matches all the predicates
Throws:
JaxenException

evaluatePredicates

protected List evaluatePredicates(List contextNodeSet,
                                  ContextSupport support)
                           throws JaxenException

Returns all of the supplied nodes that satisfy all the predicates in the set.

Parameters:
contextNodeSet - the nodes to test against these predicates
support - ????
Returns:
all the nodes that match each of the predicates
Throws:
JaxenException

applyPredicate

public List applyPredicate(Predicate predicate,
                           List nodes2Filter,
                           ContextSupport support)
                    throws JaxenException
Throws:
JaxenException


Copyright © 2001-2008 Codehaus. All Rights Reserved.