|
Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.1.6) E21908-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface QueryMetaData
QueryMetaData defines the input meta data of a search query. The user can specify the query string, search groups, page size, facet selections, etc, that are associated with a particular query. This object is passed in as a parameter to the runQuery() method of SearchCtrl class.
Method Summary | |
---|---|
void |
addFilter(java.lang.String fieldName,
java.lang.String filterValue,
java.lang.String dataType,
java.lang.String filterOp)
Sets the filters to be used for this advanced search query |
void |
addTag(java.lang.String tag)
Add a tag to the query. |
void |
clearFacetPaths()
Clears all facet paths. |
void |
clearTags()
Clears the tags added to the query. |
QueryMetaData |
copy()
Creates a copy of this query meta data. |
void |
enableFacets(boolean enable)
Sets whether the facet functionality is enabled. |
int |
getCurrentPage()
Returns the page number retrieved for this query |
FacetPath[] |
getFacetPaths()
Returns the facet paths used for this query |
java.util.List<FieldFilter> |
getFilters()
Returns the a list of FieldFilter objects hashed by field name. |
java.lang.String |
getLanguage()
Returns the language for the query. |
int |
getMaxFacetValues()
Gets the maximum number of facet values each facet should return. |
int |
getPageSize()
Returns the page size used for this query |
java.lang.String |
getQueryString()
Returns the query string for this query |
SearchGroup[] |
getSearchGroups()
Returns the search groups used for this query |
java.lang.String |
getSESSearchControls()
Returns SES search controls used for this query |
java.lang.String |
getSOName()
Returns the search object name used to filter the query |
java.util.List<java.lang.String> |
getTags()
Returns a list of tags added to the query. |
boolean |
isFacetsEnabled()
Returns whether facets are enabled or not. |
boolean |
isMLSEnabled()
Returns flag indicating if the query enables MLS, if enabled, the query would only return results of the query lanugage. |
void |
removeAllFilters()
Removes all the filters added for this queryMetaData |
void |
removeFacetValue(java.lang.String rootFacetName)
Removes the leaf facet's selected value |
void |
selectFacetValue(java.lang.String rootFacetName,
java.lang.String value)
Selects a facet value for the leaf facet of a root facet. |
void |
setCurrentPage(int page)
Sets the page number to be retrieved for this query |
void |
setFacetPaths(FacetPath[] paths)
Sets the facet paths to be used for this query |
void |
setLanguage(java.lang.String language)
Sets the language for the query, this value overrides the user's default language setting |
void |
setMaxFacetValues(int maxFacetValues)
Sets the maximum number of facet values each facet should return. |
void |
setMLSEnabled(boolean enableMLS)
Sets the flag to filter the results by query langauge. |
void |
setPageSize(int size)
Sets the page size to be used for this query |
void |
setQueryString(java.lang.String queryStr)
Sets the query string for this query |
void |
setSearchGroups(SearchGroup[] sgs)
Sets the search groups used for this query |
void |
setSESSearchControls(java.lang.String sesSearchControls)
Sets the SES search controls to be used for this query |
void |
setSOName(java.lang.String soName)
Sets the search object that the query will be filtered by |
Method Detail |
---|
void setQueryString(java.lang.String queryStr)
queryStr
- query stringjava.lang.String getQueryString()
void setSearchGroups(SearchGroup[] sgs)
sgs
- array of SearchGroup objectsSearchGroup[] getSearchGroups()
void setSOName(java.lang.String soName)
soName
- - the search object name to filter query by
Set to null to clear.java.lang.String getSOName()
void setPageSize(int size)
size
- the page size.int getPageSize()
void setCurrentPage(int page)
page
- page position for this request.int getCurrentPage()
void addFilter(java.lang.String fieldName, java.lang.String filterValue, java.lang.String dataType, java.lang.String filterOp)
fieldName
- the field namefilterValue
- the filter valuedataType
- the data type of the filterfilterOp
- the filter operator of the filter. The value is engine
dependent.java.util.List<FieldFilter> getFilters()
void removeAllFilters()
void clearFacetPaths()
void selectFacetValue(java.lang.String rootFacetName, java.lang.String value)
rootFacetName
- - the name of the root facet.value
- - the value selected for the current leaf facet.void removeFacetValue(java.lang.String rootFacetName)
rootFacetName
- - the name of the root facet.void setFacetPaths(FacetPath[] paths)
paths
- the array of FacetPath objectsFacetPath[] getFacetPaths()
void setMaxFacetValues(int maxFacetValues)
maxFacetValues
- - max number of values for each facet. -1 for all values (default).int getMaxFacetValues()
void enableFacets(boolean enable)
enable
- - booleanboolean isFacetsEnabled()
void setSESSearchControls(java.lang.String sesSearchControls)
sesSearchControls
- XML constructor for search control. This
API only applicable to SES.java.lang.String getSESSearchControls()
void addTag(java.lang.String tag)
tag
- the tag value to be filtered on.java.util.List<java.lang.String> getTags()
void clearTags()
java.lang.String getLanguage()
void setLanguage(java.lang.String language)
ISO
- 639-1 standard language codeboolean isMLSEnabled()
void setMLSEnabled(boolean enableMLS)
enableMLS
- if true langugage filter will be enabled.QueryMetaData copy()
|
Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.1.6) E21908-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |