org.progeeks.graph
Class MetaObjectRegexPredicate

java.lang.Object
  org.progeeks.graph.MetaObjectRegexPredicate

All Implemented Interfaces:

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

Direct Known Subclasses:

MetaObjectSubstringPredicate

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

A predicate that will perform a regex match on a MetaClass field value. metaClass and metaClassName are mutually exclusive. If a field is not provided, all fields will be searched. Alternatively, a wildcard (*) could be provided. To narrow the scope, the name of the object's field should be supplied.

Version:

$Revision: 1.8 $

Author:

Dave Garvis

See Also:

Serialized Form

Field Summary

static java.lang.String

WILDCARD Wildcard, searches all fields.

Constructor Summary

MetaObjectRegexPredicate()

MetaObjectRegexPredicate(MetaClass metaClass, java.lang.String field, java.lang.String expression)
Constructor to create a MetaObjectRegexPredicate from a MetaClass, field and expression.

MetaObjectRegexPredicate(java.lang.String metaClassName, java.lang.String field, java.lang.String expression)
Constructor to create a MetaObjectRegexPredicate from a meta class name, field and expression.

Method Summary

boolean	equals(java.lang.Object obj)
boolean	evaluate(java.lang.Object obj) Returns true if the specified node is a meta-object and it's field value is matched with the search expression provided.
java.lang.String	getExpression() Gets the regex string used in the search.
java.lang.String	getField() Returns the field name for which we are checking.
java.lang.String	getFieldExpression() Returns the field expression used for matching meta-object field names.
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.
int	hashCode()
void	setExpression(java.lang.String expression) Sets the regex to use in the search.
void	setField(java.lang.String field) Sets the field name for this predicate.
void	setFieldExpression(java.lang.String fieldExpression) Sets the field expression used for matching meta-object field names.
void	setMetaClass(MetaClass metaClass) Sets the meta-class to be searched later.
void	setMetaClassName(java.lang.String metaClassName) Sets the metaClassName for this predicate.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

WILDCARD

public static final java.lang.String WILDCARD

Wildcard, searches all fields.

See Also:

Constant Field Values

Constructor Detail

MetaObjectRegexPredicate

public MetaObjectRegexPredicate()

MetaObjectRegexPredicate

public MetaObjectRegexPredicate(java.lang.String metaClassName,
                                java.lang.String field,
                                java.lang.String expression)

Constructor to create a MetaObjectRegexPredicate from a meta class name, field and expression.

MetaObjectRegexPredicate

public MetaObjectRegexPredicate(MetaClass metaClass,
                                java.lang.String field,
                                java.lang.String expression)

Constructor to create a MetaObjectRegexPredicate from a MetaClass, field and expression.

Method Detail

setExpression

public void setExpression(java.lang.String expression)

Sets the regex to use in the search.

getExpression

public java.lang.String getExpression()

Gets the regex string used in the search.

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.

getField

public java.lang.String getField()

Returns the field name for which we are checking.

setField

public void setField(java.lang.String field)

Sets the field name for this predicate.

setFieldExpression

public void setFieldExpression(java.lang.String fieldExpression)

Sets the field expression used for matching meta-object field names.

getFieldExpression

public java.lang.String getFieldExpression()

Returns the field expression used for matching meta-object field names.

evaluate

public boolean evaluate(java.lang.Object obj)

Returns true if the specified node is a meta-object and it's field value is matched with the search expression provided. 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.
• expression: Any null or empty expressions will return false
• field: In order to search for an expression, a field should be provided in order to match against it's contents. If field has not been provided, matching will performed against all fields.
  '*' may be used to perform the evaluation against all fields. If any field matches, evaluation is considered to be true.
  

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