prajna.data.query

Class RangeFilter

java.lang.Object

prajna.data.DataFilter

prajna.data.query.DocFilter

prajna.data.query.RangeFilter

All Implemented Interfaces:

java.io.Serializable

public class RangeFilter
extends DocFilter

Filter which matches against a range of fielded values. For DataRecords, the values of the field must fall within the range for this filter. For DocData objects, this filter breaks the body, title, or keywords into individual words and compares them to the range.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RangeFilter(java.lang.String fieldName, java.lang.Comparable<?> lowerValue, java.lang.Comparable<?> upperValue) Create the MatchFilter with the specified fieldName and fieldValue

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(DataRecord rec) Return whether the DataRecord is accepted by this filter.
boolean	equals(java.lang.Object obj) Return true if this filter matches another object.
java.lang.String	getField() Get the field name for this filter
java.lang.Comparable<?>	getLowerValue() Return the lower value for this filter
java.lang.Comparable<?>	getUpperValue() Return the upper value for this filter
int	hashCode() Return the hash code for this MatchFilter
boolean	matchDoc(DocData doc) Return whether the represented document is accepted by this filter.
void	setStrictFlag(boolean flag) Set the Strict flag.
java.lang.String	toString() Return a string representation of this filter.

Methods inherited from class prajna.data.query.DocFilter

accept, filterDocuments, getTag, setTag

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

RangeFilter

public RangeFilter(java.lang.String fieldName,
           java.lang.Comparable<?> lowerValue,
           java.lang.Comparable<?> upperValue)

Create the MatchFilter with the specified fieldName and fieldValue

Parameters:

fieldName - the name of the field

lowerValue - the lower extent of the range

upperValue - the upper extent of the range

Method Detail

accept

public boolean accept(DataRecord rec)

Return whether the DataRecord is accepted by this filter. This method matches if the string representation of the field includes a value which matches the value for this filter.

Specified by:

accept in class DataFilter

Parameters:

rec - the data record to match.

Returns:

true if the record matches the filter, false otherwise

equals

public boolean equals(java.lang.Object obj)

Return true if this filter matches another object. This method returns true only if the other object is also a MatchFilter with the same field and value.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to test

Returns:

true if the object is the same as this one, false otherwise

getField

public java.lang.String getField()

Get the field name for this filter

Returns:

the field name

getLowerValue

public java.lang.Comparable<?> getLowerValue()

Return the lower value for this filter

Returns:

the lower value

getUpperValue

public java.lang.Comparable<?> getUpperValue()

Return the upper value for this filter

Returns:

the upper value

hashCode

public int hashCode()

Return the hash code for this MatchFilter

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

matchDoc

public boolean matchDoc(DocData doc)

Return whether the represented document is accepted by this filter.

Specified by:

matchDoc in class DocFilter

Parameters:

doc - the document record to match.

Returns:

true if the document matches the filter, false otherwise

setStrictFlag

public void setStrictFlag(boolean flag)

Set the Strict flag. For multi-valued fields, the strict flag indicates that all of the values must be within the range. If the Strict flag is false (the default), this RangeFilter matches if any of the values are within the range.

Parameters:

flag - whether to require all values to be within the range

toString

public java.lang.String toString()

Return a string representation of this filter.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this filter