ca.odell.glazedlists.filter

Class SearchTerm<E>

java.lang.Object

ca.odell.glazedlists.filter.SearchTerm<E>

All Implemented Interfaces:

java.io.Serializable

public final class SearchTerm<E>
extends java.lang.Object
implements java.io.Serializable

A SearchTerm object stores metadata around a single piece of text to be located. Search engines like Google capture more information than the simple search text to be located. This object tracks three other pieces of metadata in addition to the text to be located:

• isNegated() returns true if the search term should NOT appear within the target text
• isRequired() returns true if the search term MUST be used and cannot be discarded for any reason. (sometimes search engines discard frivolous search terms like "and", "of", and "the".
• getField() controls the TextFilterator that produces the values to be searched when locating this SearchTerm. Specifically, a null Field indicates the TextFilterator of the TextMatcher will be used to produce values to be searched. A non-null Field will be used to obtain the TextFilterator that produces the values to be searched.

Author:

James Lemieux

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchTerm(java.lang.String text) Construct a new SearchTerm with the given text that is neither negated nor required.
SearchTerm(java.lang.String text, boolean negated, boolean required, SearchEngineTextMatcherEditor.Field<E> field) Construct a new SearchTerm with the given text that is negated and required according to the given booleans.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
SearchEngineTextMatcherEditor.Field<E>	getField() Returns the object that provides a custom TextFilterator to use when locating this SearchTerm within an object.
java.lang.String	getText() Returns the text to be located within a target text.
int	hashCode()
boolean	isNegated() Returns true if the text must NOT be located within a target text; false if the text MUST be located within a target text.
boolean	isRequired() Returns true if this SearchTerm must be included within a search and cannot be discarded for any reason.
SearchTerm<E>	newSearchTerm(java.lang.String text) Return a new SearchTerm with identical information save for the given text.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchTerm

public SearchTerm(java.lang.String text)

Construct a new SearchTerm with the given text that is neither negated nor required.

SearchTerm

public SearchTerm(java.lang.String text,
                  boolean negated,
                  boolean required,
                  SearchEngineTextMatcherEditor.Field<E> field)

Construct a new SearchTerm with the given text that is negated and required according to the given booleans.

Method Detail

getText

public java.lang.String getText()

Returns the text to be located within a target text.

isNegated

public boolean isNegated()

Returns true if the text must NOT be located within a target text; false if the text MUST be located within a target text.

isRequired

public boolean isRequired()

Returns true if this SearchTerm must be included within a search and cannot be discarded for any reason. For example, even if it contains typically frivolous search text such as "the", "and" or "of".

getField

public SearchEngineTextMatcherEditor.Field<E> getField()

Returns the object that provides a custom TextFilterator to use when locating this SearchTerm within an object. When this method returns null it indicates that the TextFilterator of the TextMatcher should be used to extract values from a target object.

newSearchTerm

public SearchTerm<E> newSearchTerm(java.lang.String text)

Return a new SearchTerm with identical information save for the given text.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object