|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.endeca.portal.data.functions.QueryFunction
com.endeca.portal.data.functions.QueryFilter
com.endeca.portal.data.functions.SearchFilter
public class SearchFilter
Permits adding a keyword search to a QueryState.
Nested Class Summary | |
---|---|
static class |
SearchFilter.MatchMode
|
Field Summary | |
---|---|
static java.lang.String |
PASSTHROUGH_SEARCH_FILTER
|
static java.lang.String |
PASSTHROUGH_SEARCH_FILTER_INFO
|
Fields inherited from class com.endeca.portal.data.functions.QueryFunction |
---|
CLASS_PROPERTY, operator |
Constructor Summary | |
---|---|
protected |
SearchFilter()
Empty constructor is not public, to nudge users toward one of the more useful constructors. |
|
SearchFilter(org.json.JSONObject jsonObject)
Constructs a search filter from a JSON object |
|
SearchFilter(java.lang.String searchInterface,
java.lang.String terms)
Constructs a search filter with the specified interface and terms, defaulting to match mode "all" and no additional search options. |
|
SearchFilter(java.lang.String searchInterface,
java.lang.String terms,
SearchFilter.MatchMode matchMode)
Constructs a search filter with the specified interface, terms, and match mode and no additional search options. |
|
SearchFilter(java.lang.String searchInterface,
java.lang.String terms,
SearchFilter.MatchMode matchMode,
java.lang.String searchOpts)
Constructs a search filter with the specified interface, terms, match mode and search options. |
|
SearchFilter(java.lang.String searchInterface,
java.lang.String terms,
java.lang.String matchMode)
Constructs a search filter with the specified interface, terms, and match mode (as parsed by parseMatchMode method) and no additional search options. |
|
SearchFilter(java.lang.String searchInterface,
java.lang.String terms,
java.lang.String matchMode,
java.lang.String searchOpts)
Constructs a search filter with the specified interface, terms, match mode (as parsed by parseMatchMode method) and search options. |
Method Summary | |
---|---|
void |
applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
Apply this function to a Request. |
void |
applyToENEQuery(com.endeca.navigation.ENEQuery query)
Apply this function to an ENEQuery. |
java.util.List<java.lang.reflect.Method> |
getGetters()
Return the list of property getters on this function. |
SearchFilter.MatchMode |
getMatchMode()
|
static java.util.List<SearchFilter> |
getSearchFilterPassThroughs(com.endeca.mdex.conversation.Request request)
Gets the SearchFilterInfo passthrough element from the v7 request object, and returns the search filter metadata. |
static java.util.List<SearchFilter> |
getSearchFilterPassThroughs(com.endeca.mdex.conversation.Results results)
Gets the SearchFilterInfo passthrough element from the v7 results object, and returns the search filter metadata. |
java.lang.String |
getSearchInterface()
|
java.lang.String |
getSearchOptions()
|
java.util.List<java.lang.reflect.Method> |
getSetters()
Return the list of property setters on this function. |
java.lang.String |
getTerms()
|
boolean |
isSearchWithin()
|
void |
setMatchMode(SearchFilter.MatchMode matchMode)
|
void |
setMatchMode(java.lang.String matchModeStr)
|
void |
setSearchInterface(java.lang.String searchInterface)
|
void |
setSearchOptions(java.lang.String searchOptions)
|
void |
setSearchWithin(boolean searchWithin)
|
void |
setSearchWithin(java.lang.String searchWithin)
|
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 |
---|
clone, equals, equals, getInstance, getInstance, getName, getOperator, hashCode, init, setName, setOperator, setOperator, toJSON, toXML |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PASSTHROUGH_SEARCH_FILTER_INFO
public static final java.lang.String PASSTHROUGH_SEARCH_FILTER
Constructor Detail |
---|
protected SearchFilter()
public SearchFilter(org.json.JSONObject jsonObject) throws java.lang.IllegalArgumentException, java.lang.IllegalAccessException, org.json.JSONException
jsonObject
- the JSON object representing this search filter
java.lang.IllegalArgumentException
java.lang.IllegalAccessException
org.json.JSONException
public SearchFilter(java.lang.String searchInterface, java.lang.String terms)
searchInterface
- terms
- public SearchFilter(java.lang.String searchInterface, java.lang.String terms, java.lang.String matchMode)
searchInterface
- terms
- matchMode
- public SearchFilter(java.lang.String searchInterface, java.lang.String terms, SearchFilter.MatchMode matchMode)
searchInterface
- terms
- matchMode
- public SearchFilter(java.lang.String searchInterface, java.lang.String terms, java.lang.String matchMode, java.lang.String searchOpts)
searchInterface
- terms
- matchMode
- searchOpts
- public SearchFilter(java.lang.String searchInterface, java.lang.String terms, SearchFilter.MatchMode matchMode, java.lang.String searchOpts)
searchInterface
- terms
- matchMode
- searchOpts
- Method Detail |
---|
public java.lang.String getSearchInterface()
public void setSearchInterface(java.lang.String searchInterface)
public java.lang.String getTerms()
public void setTerms(java.lang.String terms)
public SearchFilter.MatchMode getMatchMode()
public void setMatchMode(SearchFilter.MatchMode matchMode)
public void setMatchMode(java.lang.String matchModeStr)
public java.lang.String getSearchOptions()
public void setSearchOptions(java.lang.String searchOptions)
public boolean isSearchWithin()
public void setSearchWithin(boolean searchWithin)
public void setSearchWithin(java.lang.String searchWithin)
public java.util.List<java.lang.reflect.Method> getSetters()
QueryFunction
private static List setters = Reflection.getSetters(MyFunctionClass.class);
\@Override
public List getSetters() {
return setters;
}
getSetters
in class QueryFunction
public java.util.List<java.lang.reflect.Method> getGetters()
QueryFunction
private static List getters = Reflection.getGetters(MyFunctionClass.class);
\@Override
public List getGetters() {
return getters;
}
getGetters
in class QueryFunction
public void applyToENEQuery(com.endeca.navigation.ENEQuery query)
QueryFunction
applyToENEQuery
in class QueryFunction
public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
QueryFunction
applyToDiscoveryServiceQuery
in class QueryFunction
public java.lang.String toString()
QueryFunction
toString
in class QueryFunction
public static java.util.List<SearchFilter> getSearchFilterPassThroughs(com.endeca.mdex.conversation.Results results)
results
-
public static java.util.List<SearchFilter> getSearchFilterPassThroughs(com.endeca.mdex.conversation.Request request)
results
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |