com.endeca.portal.data.functions
Class SearchFilter

java.lang.Object
  com.endeca.portal.data.functions.QueryFunction
      com.endeca.portal.data.functions.QueryFilter
          com.endeca.portal.data.functions.SearchFilter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SearchFilter
extends QueryFilter

Permits adding a keyword search to a QueryState.

Author:

Endeca Technologies, Inc.

See Also:

Serialized Form

Nested Class Summary

static class	SearchFilter.Builder Use this class to build a SearchFilter object.
static class	SearchFilter.MatchMode

Field Summary

Fields inherited from class com.endeca.portal.data.functions.QueryFunction

CLASS_PROPERTY

Constructor Summary

protected

SearchFilter() Empty constructor is not public, to nudge users toward one of the more useful constructors.

Method Summary

void	applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query) Apply this function to a Request.
java.lang.Boolean	getEnableSnippeting()
SearchFilter.MatchMode	getMatchMode()
java.lang.String	getSearchInterface()
java.lang.String	getSearchOptions()
int	getSnippetLength()
java.lang.String	getTerms()
boolean	isSearchWithin()
void	setEnableSnippeting(java.lang.Boolean enableSnippeting)
void	setMatchMode(SearchFilter.MatchMode matchMode)
void	setSearchInterface(java.lang.String searchInterface)
void	setSearchOptions(java.lang.String searchOptions)
void	setSearchWithin(boolean searchWithin)
void	setSnippetLength(int snippetLength)
void	setTerms(java.lang.String terms)
java.lang.String	toString() This class' toString is abstract: all concrete subclasses are expected to provide an implementation. toString is used in comparing QueryFunction instances for equality, so if you implement a QueryFunction subclass it is important that your toString implementation be consistent and deterministic.

Methods inherited from class com.endeca.portal.data.functions.QueryFunction

beforeQueryStateAdd, clone, equals, equals, getName, hashCode, initializeFromJSON, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFilter

protected SearchFilter()

Empty constructor is not public, to nudge users toward one of the more useful constructors.

Method Detail

getSearchInterface

public java.lang.String getSearchInterface()

setSearchInterface

public void setSearchInterface(java.lang.String searchInterface)

getTerms

public java.lang.String getTerms()

setTerms

public void setTerms(java.lang.String terms)

getMatchMode

public SearchFilter.MatchMode getMatchMode()

setMatchMode

public void setMatchMode(SearchFilter.MatchMode matchMode)

getSearchOptions

public java.lang.String getSearchOptions()

setSearchOptions

public void setSearchOptions(java.lang.String searchOptions)

isSearchWithin

public boolean isSearchWithin()

setSearchWithin

public void setSearchWithin(boolean searchWithin)

getEnableSnippeting

public java.lang.Boolean getEnableSnippeting()

setEnableSnippeting

public void setEnableSnippeting(java.lang.Boolean enableSnippeting)

getSnippetLength

public int getSnippetLength()

setSnippetLength

public void setSnippetLength(int snippetLength)

applyToDiscoveryServiceQuery

public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)

Description copied from class: QueryFunction

Apply this function to a Request. Must be implemented by subclass.

Specified by:

applyToDiscoveryServiceQuery in class QueryFunction

toString

public java.lang.String toString()

Description copied from class: QueryFunction

This class' toString is abstract: all concrete subclasses are expected to provide an implementation. toString is used in comparing QueryFunction instances for equality, so if you implement a QueryFunction subclass it is important that your toString implementation be consistent and deterministic.

Specified by:

toString in class QueryFunction