prajna.data

Class EnumFieldFilter

java.lang.Object

prajna.data.DataFilter

prajna.data.EnumFieldFilter

All Implemented Interfaces:

java.io.Serializable

public class EnumFieldFilter
extends DataFilter

Example DataFilter which filters the DataRecords based upon the value of an enumerated field. The EnumFieldFilter is initialized to a value for a particular field, and accepts only those DataRecords which include the specified value in that field.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EnumFieldFilter(java.lang.String fieldName, java.lang.String fieldValue) Instantiates a new EnumFieldFilter with the specified field and value.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(DataRecord record) Return whether the filter accepts the data record.
boolean	equals(java.lang.Object obj) Return whether this EnumFieldFilter matches another object
java.lang.String	getFieldName() Get the field name for this field filter
java.lang.String	getValue() Get the field value for this field filter
int	hashCode() Return the hash code for this EnumFieldFilter
java.lang.String	toString() Return a string representation of this filter

Methods inherited from class prajna.data.DataFilter

filterRecords

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumFieldFilter

public EnumFieldFilter(java.lang.String fieldName,
               java.lang.String fieldValue)

Instantiates a new EnumFieldFilter with the specified field and value.

Parameters:

fieldName - the field name

fieldValue - the field value

Method Detail

accept

public boolean accept(DataRecord record)

Return whether the filter accepts the data record. The DataRecord is accepted if it matches the specified value for the specified field. If the field is multi-valued, the record is accepted if one of the values matches the filter value.

Specified by:

accept in class DataFilter

Parameters:

record - the record

Returns:

true if the record matches this filter, false otherwise

equals

public boolean equals(java.lang.Object obj)

Return whether this EnumFieldFilter matches another object

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare

Returns:

true if the other object is an EnumFieldFilter with the same field and value specified, false otherwise.

getFieldName

public java.lang.String getFieldName()

Get the field name for this field filter

Returns:

the field name

getValue

public java.lang.String getValue()

Get the field value for this field filter

Returns:

the field value

hashCode

public int hashCode()

Return the hash code for this EnumFieldFilter

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

toString

public java.lang.String toString()

Return a string representation of this filter

Overrides:

toString in class java.lang.Object

Returns:

a representative string