edu.uci.ics.jung.graph.predicates
Class UserDatumEdgePredicate

java.lang.Object
  extended by edu.uci.ics.jung.graph.predicates.GPredicate
      extended by edu.uci.ics.jung.graph.predicates.EdgePredicate
          extended by edu.uci.ics.jung.graph.predicates.UserDatumEdgePredicate
All Implemented Interfaces:
Predicate

public class UserDatumEdgePredicate
extends EdgePredicate

A predicate that checks to see whether an edge's user data repository contains the constructor-specified (key,datum) pair. This predicate may be used as a constraint.


Field Summary
static String message
           
 
Fields inherited from class edu.uci.ics.jung.graph.predicates.GPredicate
isInitializationPredicate
 
Constructor Summary
UserDatumEdgePredicate(Object key, Object datum)
           
 
Method Summary
 boolean equals(Object o)
          Tests equality based on underlying objects
 boolean evaluateEdge(ArchetypeEdge e)
          Returns true if the datum stored by e with key value key (in the user data repository) is datum.
 Object getDatum()
          Returns the user datum which partially defines this predicate.
 Object getKey()
          Returns the user data key which partially defines this predicate.
 int hashCode()
           
 String toString()
           
 
Methods inherited from class edu.uci.ics.jung.graph.predicates.EdgePredicate
evaluate
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

message

public static final String message
See Also:
Constant Field Values
Constructor Detail

UserDatumEdgePredicate

public UserDatumEdgePredicate(Object key,
                              Object datum)
Method Detail

evaluateEdge

public boolean evaluateEdge(ArchetypeEdge e)
Returns true if the datum stored by e with key value key (in the user data repository) is datum.

Specified by:
evaluateEdge in class EdgePredicate
See Also:
UserData

toString

public String toString()
Overrides:
toString in class Object

equals

public boolean equals(Object o)
Tests equality based on underlying objects

Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

getKey

public Object getKey()
Returns the user data key which partially defines this predicate.


getDatum

public Object getDatum()
Returns the user datum which partially defines this predicate.