org.progeeks.graph
Class MetaObjectPredicate

java.lang.Object
  org.progeeks.graph.MetaObjectPredicate

All Implemented Interfaces:

java.io.Serializable, org.apache.commons.collections.Predicate

public class MetaObjectPredicate
extends java.lang.Object
implements org.apache.commons.collections.Predicate, java.io.Serializable

Predicate that evaluates based on metaClass or metaClassName properties if specified, otherwise defaults to a field/value evaluation. All members are optional therefore, if nothing is set evaluate will always return true.

Version:

$Revision: 1.10 $

Author:

Dave Garvis

See Also:

Serialized Form

Constructor Summary

MetaObjectPredicate()

MetaObjectPredicate(MetaClass metaClass)
Constructor to create a MateObjectPredicate from a MetaClass.

MetaObjectPredicate(MetaClass metaClass, java.lang.String field, java.lang.Object value)
Constructor to create a MateObjectPredicate from a MetaClass, field and value.

MetaObjectPredicate(java.lang.String metaClassName)
Constructor to cerate a MetaObjectPredicate from just a meta class name.

MetaObjectPredicate(java.lang.String metaClassName, java.lang.String field, java.lang.Object value)
Constructor to create a MateObjectPredicate from a meta class name, field and value.

Method Summary

boolean	equals(java.lang.Object obj)
boolean	evaluate(java.lang.Object obj) Returns true if the specified node is a meta-object with the correct field value.
java.lang.String	getFieldName() Returns the field name for which we are checking.
MetaClass	getMetaClass() Returns the meta-class for which we are searching.
java.lang.String	getMetaClassName() Returns the meta-class name for which we are searching.
java.lang.Object	getValue() Returns the value for which we are looking.
int	hashCode()
void	setFieldName(java.lang.String field) Sets the field name for this predicate.
void	setMetaClass(MetaClass metaClass) Sets the meta-class to be searched later.
void	setMetaClassName(java.lang.String metaClassName) Sets the metaClassName for this predicate.
void	setValue(java.lang.Object value) Sets the value assocaited with the field of this predicate.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetaObjectPredicate

public MetaObjectPredicate()

MetaObjectPredicate

public MetaObjectPredicate(MetaClass metaClass)

Constructor to create a MateObjectPredicate from a MetaClass.

MetaObjectPredicate

public MetaObjectPredicate(java.lang.String metaClassName)

Constructor to cerate a MetaObjectPredicate from just a meta class name.

MetaObjectPredicate

public MetaObjectPredicate(java.lang.String metaClassName,
                           java.lang.String field,
                           java.lang.Object value)

Constructor to create a MateObjectPredicate from a meta class name, field and value.

MetaObjectPredicate

public MetaObjectPredicate(MetaClass metaClass,
                           java.lang.String field,
                           java.lang.Object value)

Constructor to create a MateObjectPredicate from a MetaClass, field and value.

Method Detail

getMetaClass

public MetaClass getMetaClass()

Returns the meta-class for which we are searching.

setMetaClass

public void setMetaClass(MetaClass metaClass)

Sets the meta-class to be searched later.

getMetaClassName

public java.lang.String getMetaClassName()

Returns the meta-class name for which we are searching.

setMetaClassName

public void setMetaClassName(java.lang.String metaClassName)

Sets the metaClassName for this predicate.

getFieldName

public java.lang.String getFieldName()

Returns the field name for which we are checking.

setFieldName

public void setFieldName(java.lang.String field)

Sets the field name for this predicate.

getValue

public java.lang.Object getValue()

Returns the value for which we are looking.

setValue

public void setValue(java.lang.Object value)

Sets the value assocaited with the field of this predicate.

evaluate

public boolean evaluate(java.lang.Object obj)

Returns true if the specified node is a meta-object with the correct field value.
Evaluation happens as follows:

• metaClass: If this is set, the object will be evaluated on the basis that it is an instance of the metaClass type.
• metaClassName: If this is set, the object will be evaluated on the basis that it is an instance of the meta class as looked up through the object's class registry.
Note: metaClass and metaClassName are mutually exclusive.
• field: If this is set, and provided the object to be evaluated has this property, the data contained in value will be used as a final determinent of the evaluation. null is considered valid data in the value member.

Specified by:

evaluate in interface org.apache.commons.collections.Predicate

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object