com.endeca.infront.navigation.model
Class SearchFilter

java.lang.Object
  com.endeca.infront.navigation.model.Filter
      com.endeca.infront.navigation.model.SearchFilter

All Implemented Interfaces:

Cloneable

public class SearchFilter
extends Filter

A text search filter.

Constructor Summary

SearchFilter()
Creates a text search filter.

SearchFilter(String key, String terms)
Creates a text search filter.

SearchFilter(String key, String terms, MatchMode mode)
Creates a text search filter.

Method Summary

SearchFilter	clone()
boolean	equals(Object obj)
String	getKey() The Endeca search key.
MatchMode	getMatchMode() The Endeca match mode.
String	getTerms() Text to search for.
int	hashCode()
void	setKey(String key)
void	setMatchMode(MatchMode mode)
void	setTerms(String terms)
String	toString() For debugging.

Methods inherited from class com.endeca.infront.navigation.model.Filter

verifyNotNull

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFilter

public SearchFilter()

Creates a text search filter. The searchKey and terms must also be set.

See Also:

setKey(java.lang.String), setTerms(java.lang.String)

SearchFilter

public SearchFilter(String key,
                    String terms)

Creates a text search filter. This constructor assumes the Endeca match mode MatchMode.ALL.

Parameters:

key - the Endeca searchKey, cannot be null.

terms - the text to search for, cannot be null.

SearchFilter

public SearchFilter(String key,
                    String terms,
                    MatchMode mode)

Creates a text search filter.

Parameters:

key - the Endeca searchKey, cannot be null.

terms - the text to search for, cannot be null.

mode - the Endeca match mode, may be null, which is equivalent to MatchMode.ALL.

Method Detail

getTerms

public String getTerms()

Text to search for.

getKey

public String getKey()

The Endeca search key.

getMatchMode

public MatchMode getMatchMode()

The Endeca match mode.

setKey

public void setKey(String key)

Parameters:

key - the Endeca search key. Cannot be null.

See Also:

getKey()

setTerms

public void setTerms(String terms)

Parameters:

terms - the terms to search for. Cannot be null.

See Also:

getTerms()

setMatchMode

public void setMatchMode(MatchMode mode)

Parameters:

mode - may be null, which is equivalent to MatchMode.ALL.

See Also:

getMatchMode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

For debugging.

Overrides:

toString in class Object

clone

public SearchFilter clone()

Overrides:

clone in class Filter