prajna.data.query

Class SearchTerm

java.lang.Object

prajna.data.DataFilter

prajna.data.query.DocFilter

prajna.data.query.SearchTerm

All Implemented Interfaces:

java.io.Serializable

public class SearchTerm
extends DocFilter

Search Term filter. This filter searches textual components of a document or record for a particular term.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchTerm(java.lang.String term) Create a new SearchTerm filter.

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)
java.lang.String	getTerm()
int	hashCode() Return the hash code for this SearchTerm
boolean	matchDoc(DocData doc) Return whether the represented document is accepted by this filter.
java.lang.String	toString() Return a string representation of this search.

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

SearchTerm

public SearchTerm(java.lang.String term)

Create a new SearchTerm filter.

Parameters:

term - the term to search for

Method Detail

accept

public boolean accept(DataRecord rec)

Return whether the DataRecord is accepted by 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)

Overrides:

equals in class java.lang.Object

getTerm

public java.lang.String getTerm()

hashCode

public int hashCode()

Return the hash code for this SearchTerm

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

toString

public java.lang.String toString()

Return a string representation of this search. This simply returns the search term string

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this search