com.endeca.portal.data.functions
Class SearchFilter.Builder

java.lang.Object
  com.endeca.portal.data.functions.SearchFilter.Builder

Enclosing class:

SearchFilter

public static class SearchFilter.Builder
extends java.lang.Object

Use this class to build a SearchFilter object. A search interface and search terms are required, all other options are optional. Example usage: To specify a search interface, terms, matchmode: SearchFilter searchFilter = new SearchFilter.Builder("P_Description","aromas"). matchMode("ALL").build(); To specify a search interface, terms, the default matchmode (used when one is not specified), enable snippeting, and set snippeting length to 8: SearchFilter searchFilter = new SearchFilter.Builder("P_Description","aromas"). enableSnippeting(true).snippetLength(8).build();

Constructor Summary

SearchFilter.Builder(java.lang.String searchInterface, java.lang.String terms)

Method Summary

SearchFilter	build()
SearchFilter.Builder	enableSnippeting(java.lang.Boolean enableSnippeting)
SearchFilter.Builder	enableSnippeting(java.lang.String enableSnippeting)
SearchFilter.Builder	matchMode(SearchFilter.MatchMode matchMode)
SearchFilter.Builder	matchMode(java.lang.String matchMode)
SearchFilter.Builder	searchOptions(java.lang.String searchOptions)
SearchFilter.Builder	searchWithin(boolean searchWithin)
SearchFilter.Builder	snippetLength(int snippetLength)
SearchFilter.Builder	snippetLength(java.lang.String snippetLength)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFilter.Builder

public SearchFilter.Builder(java.lang.String searchInterface,
                            java.lang.String terms)

Method Detail

matchMode

public SearchFilter.Builder matchMode(SearchFilter.MatchMode matchMode)

matchMode

public SearchFilter.Builder matchMode(java.lang.String matchMode)

searchOptions

public SearchFilter.Builder searchOptions(java.lang.String searchOptions)

enableSnippeting

public SearchFilter.Builder enableSnippeting(java.lang.Boolean enableSnippeting)

Parameters:

enableSnippeting -

Returns:

a SearchFilter.Builder instance

enableSnippeting

public SearchFilter.Builder enableSnippeting(java.lang.String enableSnippeting)

Parameters:

enableSnippeting -

Returns:

a SearchFilter.Builder instance

snippetLength

public SearchFilter.Builder snippetLength(int snippetLength)

Parameters:

snippetLength - the length of the snippet

Returns:

a SearchFilter.Builder instance

snippetLength

public SearchFilter.Builder snippetLength(java.lang.String snippetLength)

Parameters:

snippetLength - the length of the snippet

Returns:

a SearchFilter.Builder instance

searchWithin

public SearchFilter.Builder searchWithin(boolean searchWithin)

build

public SearchFilter build()