prajna.data

Class WordFilter

java.lang.Object

prajna.data.DataFilter

prajna.data.WordFilter

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

WordNetFilter

public class WordFilter
extends DataFilter

Filters the DataRecords based upon one or more terms which must appear in the record. If the field is set, then the terms must appear within that field. Otherwise, they must appear in any of the text fields. This filter can be configured to accept records if they match all text values or a single text value, depending on the value of the matchAll flag

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WordFilter(java.lang.String fieldName) Instantiates a new WordFilter with the specified field.
WordFilter(java.lang.String fieldName, java.util.Set<java.lang.String> words) Instantiates a new WordFilter with the specified field and set of match words.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(DataRecord record) Return whether the filter accepts the data record.
void	addTerm(java.lang.String word) Add a word to the set of match words for this filter
void	addTerms(java.util.Set<java.lang.String> words) Add words to the set of match words for this filter
java.util.Set<java.lang.String>	getMatchWords() Return the current set of words to search for
void	setMatchAll(boolean flag) Set the matchAll flag.

Methods inherited from class prajna.data.DataFilter

filterRecords

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WordFilter

public WordFilter(java.lang.String fieldName)

Instantiates a new WordFilter with the specified field. No words are specified, so they must be added using addTerm or addTerms.

Parameters:

fieldName - the field name

WordFilter

public WordFilter(java.lang.String fieldName,
          java.util.Set<java.lang.String> words)

Instantiates a new WordFilter with the specified field and set of match words.

Parameters:

fieldName - the field name

words - the set of words to match

Method Detail

accept

public boolean accept(DataRecord record)

Return whether the filter accepts the data record. The DataRecord is accepted if the text field specified contains the words in the match list. If the text field is null, then all text fields are checked. If the matchAll flag is set, all fields must be present in the record to match; if it is not set, then only one word must be present.

Specified by:

accept in class DataFilter

Parameters:

record - the record

Returns:

true if the record matches this filter, false otherwise

addTerm

public void addTerm(java.lang.String word)

Add a word to the set of match words for this filter

Parameters:

word - the new word to match

addTerms

public void addTerms(java.util.Set<java.lang.String> words)

Add words to the set of match words for this filter

Parameters:

words - the set of additional words to match

getMatchWords

public java.util.Set<java.lang.String> getMatchWords()

Return the current set of words to search for

Returns:

the set of search words

setMatchAll

public void setMatchAll(boolean flag)

Set the matchAll flag. If set to true, all words must be matched. The flag is false by default

Parameters:

flag - true if all words should be matched, false otherwise