SearchParameter (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.searchapi.xmlv10.client.AbstractParameter
- - com.exalead.searchapi.xmlv10.client.SearchParameter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class SearchParameter
extends AbstractParameter
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ADD_CATEGORY_GROUP` Key of the parameter used to add category group.
`static java.lang.String`	`ADD_HIGHLIGHT` Key of the parameter used to add an highlight operation
`static java.lang.String`	`ADD_HIT_META` Key of the parameter used to add hit meta from an index field.
`static java.lang.String`	`ADD_SUMMARY` Key of the parameter used to add a snippet operation
`static java.lang.String`	`ADD_VIRTUAL_FIELD` Key of the parameter used to add a new virtual field definition.
`static java.lang.String`	`CACHE` Key of the parameter used to enable query caching
`static java.lang.String`	`CANCEL_REFINE` Key of the parameter used to remove a refinement.
`static java.lang.String`	`CHECKPOINTS` Key of the parameter used to request checkpoints.
`static java.lang.String`	`COLLAPSING` Key of the parameter used to configure the collapsing of the results.
`static java.lang.String`	`CONTEXT` Key of the parameter used set the search context.
`static java.lang.String`	`DEBUG` Key of the parameter used to enable debug.
`static java.lang.String`	`DP` Key of the parameter used to set the default prefix handler
`static java.lang.String`	`DP_CHUNK` Key of the parameter used to set the default prefix handler for a specific query chunk
`static java.lang.String`	`ELLQL_QUERY` Key of the parameter used to pass an ELLQL query
`static java.lang.String`	`ENFORCE_SECURITY` Should security be actually enforced
`static java.lang.String`	`HF` Key of the parameter used to set the number of results that will be retrieved
`static java.lang.String`	`HIT_INFOS` Key of the parameter used to add hit informations.
`static java.lang.String`	`JSON_CALLBACK` Key of the parameter used to specify a JavaScript callback
`static java.lang.String`	`LANG` Key of the parameter used to set the query language
`static java.lang.String`	`LIMITS` Key of the parameter used to set the limits
`static java.lang.String`	`LOGIC` Key of the parameter used set the logic (default query) that will be used.
`static java.lang.String`	`MM` Key of the parameter used to specify the matching mode
`static java.lang.String`	`NRESULTS` Key of the parameter used to set the number of results that will be retrieved
`static java.lang.String`	`ORIGIN` Deprecated.
`static java.lang.String`	`OUTPUT_FORMAT` Key of the parameter used to specify the output format
`static java.lang.String`	`PAL` Key of the parameter used to enable patterns expansion on all languages
`static java.lang.String`	`PROXIMITY` Key of the parameter used to enable proximity
`static java.lang.String`	`PROXIMITY_DISTANCE` Key of the parameter used to specify the proximity max distance
`static java.lang.String`	`PROXIMITY_MAX` Deprecated.
`static java.lang.String`	`QEC` Key of the parameter used to set the query expasion config
`static java.lang.String`	`QUERY` Key of the parameter used to set the query string ex: "exalead OR author:bourdoncle" See "Query Language Guide" for more details
`static java.lang.String`	`QUERY_TEMPLATE` Key of the parameter used to specify the query template
`static java.lang.String`	`REFINE` Key of the parameter used to add a refinement A refinement is way to precise by your query by adding restriction to a set of categories.
`static java.lang.String`	`RELEVANCE` Key of the parameter used to enable text relevance
`static java.lang.String`	`REMOVE_CATEGORY_GROUP` Key of the parameter used to remove a category group.
`static java.lang.String`	`REMOVE_FACET` Key of the parameter used to remove a facet
`static java.lang.String`	`REMOVE_HIT_META` Key of the parameter used to remove a meta from hits (parameter value retrieved field name)
`static java.lang.String`	`REMOVE_VIRTUAL_FIELD` Key of the parameter used to remove a virtual definition definition using its name.
`static java.lang.String`	`REPORTING` Key of the parameter used to enable reporting.
`static java.lang.String`	`RT` Key of the parameter used to enable RelatedTerms synthesis
`static java.lang.String`	`SCORE_MAP` Deprecated.
`static java.lang.String`	`SECURITY` Key of the parameter used to add a security token Security tokens are pushed by connectors thanks to the meta "security" When security token check is enabled on the search server, the documents must have the provided security tokens to be retrieved.
`static java.lang.String`	`SORT` Key of the parameter used to set the field on which the results will be sorted Note that you can't sort on alphanumerical and category fields
`static java.lang.String`	`SORT_ASCENDING` Deprecated. to sort order for each sort dimensions is defined by the sort string.
`static java.lang.String`	`SORTED` Key of the parameter used to enabled result sorting
`static java.lang.String`	`SPELLCHECK` Key of the parameter used to enable spellcheck
`static java.lang.String`	`START` Key of the parameter used to set the index of the first result to retrieve (starts from 0)
`static java.lang.String`	`STATIC_RANKING_EXPRESSION` Deprecated.
`static java.lang.String`	`STREAMING` Key of the parameter used to enable streaming search mode
`static java.lang.String`	`SYNTHESIS` Key of the parameter used to enable facets
`static java.lang.String`	`SYNTHESIS_HITS` Key of the parameter used to enable hit facets
`static java.lang.String`	`TARGET` Key of the parameter used to set the search target on a 5.0 product
`static java.lang.String`	`TERM_SCORE` Key of the parameter used to specify the term score formula
`static java.lang.String`	`TIMEOUT` Key of the parameter used to set the query timeout (ms).
`static java.lang.String`	`USE_LOGIC_FACETS` Key of the parameter used to enable the use of logic's facets
`static java.lang.String`	`USE_LOGIC_HIT_METAS` Key of the parameter used to enable the use of logic's hit metas
`static java.lang.String`	`USE_LOGIC_VIRTUAL_FIELDS` Key of the parameter used to enable the use of logic's virtual fields
`static java.lang.String`	`ZAP_REFINE` Key of the parameter used to "zap" refinement which consists in removing the refinement and adding the father if possible.

Fields inherited from class com.exalead.searchapi.xmlv10.client.AbstractParameter
name, value

Constructor Summary

Constructors
Constructor and Description

SearchParameter(java.lang.String name, java.lang.String value)

Constructors
Constructor and Description
`SearchParameter(java.lang.String name, java.lang.String value)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

java.lang.Object clone()
- Methods inherited from class com.exalead.searchapi.xmlv10.client.AbstractParameter
  getName, getValue, setValue
- Methods inherited from class java.lang.Object
  equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()`

- Field Detail
  - QUERY
```
public static final java.lang.String QUERY
```
    Key of the parameter used to set the query string ex: "exalead OR author:bourdoncle" See "Query Language Guide" for more details
    
    See Also:
    
    SearchQuery.setQuery(String), Constant Field Values
  - NRESULTS
```
public static final java.lang.String NRESULTS
```
    Key of the parameter used to set the number of results that will be retrieved
    
    See Also:
    
    SearchQuery.setResultsSetLength(int), Constant Field Values
  - START
```
public static final java.lang.String START
```
    Key of the parameter used to set the index of the first result to retrieve (starts from 0)
    
    See Also:
    
    SearchQuery.setResultsSetStart(int), Constant Field Values
  - LANG
```
public static final java.lang.String LANG
```
    Key of the parameter used to set the query language
    
    See Also:
    
    SearchQuery.setLanguage(String), Constant Field Values
  - SORT
```
public static final java.lang.String SORT
```
    Key of the parameter used to set the field on which the results will be sorted Note that you can't sort on alphanumerical and category fields
    
    See Also:
    
    SearchQuery.setSortField(String), Constant Field Values
  - SORT_ASCENDING
```
@Deprecated
public static final java.lang.String SORT_ASCENDING
```
    Deprecated. to sort order for each sort dimensions is defined by the sort string.
    
    See Also:
    
    SearchQuery.setSortField(String), Constant Field Values
  - SECURITY
```
public static final java.lang.String SECURITY
```
    Key of the parameter used to add a security token Security tokens are pushed by connectors thanks to the meta "security" When security token check is enabled on the search server, the documents must have the provided security tokens to be retrieved. Note that the token "EVERYBODY" is automatically added so there is no need to add it in your query.
    
    See Also:
    
    SearchQuery.addSecurityToken(String), Constant Field Values
  - ENFORCE_SECURITY
```
public static final java.lang.String ENFORCE_SECURITY
```
    Should security be actually enforced
    
    See Also:
    
    Constant Field Values
  - REFINE
```
public static final java.lang.String REFINE
```
    Key of the parameter used to add a refinement A refinement is way to precise by your query by adding restriction to a set of categories. A refinement can be a selection (category id prefixed by a "+") or an exclusion (category id prefixed by a "-") of a category.
    
    See Also:
    
    SearchQuery.addRefinement(String, boolean), Constant Field Values
  - CANCEL_REFINE
```
public static final java.lang.String CANCEL_REFINE
```
    Key of the parameter used to remove a refinement. This refinement can be in the context or a refinement that have been added with REFINE parameter or SearchQuery.addRefinement(String, boolean).
    Warning this parameter is not supported on the 4.6 product
    
    See Also:
    
    SearchQuery.cancelRefinement(String), Constant Field Values
  - ZAP_REFINE
```
public static final java.lang.String ZAP_REFINE
```
    Key of the parameter used to "zap" refinement which consists in removing the refinement and adding the father if possible.
    
    See Also:
    
    REFINE, CANCEL_REFINE, Constant Field Values
  - LOGIC
```
public static final java.lang.String LOGIC
```
    Key of the parameter used set the logic (default query) that will be used.
    
    See Also:
    
    SearchQuery.setSearchLogic(String), Constant Field Values
  - TARGET
```
public static final java.lang.String TARGET
```
    Key of the parameter used to set the search target on a 5.0 product
    Warning this parameter is not supported on the 4.6 product
    
    See Also:
    
    Constant Field Values
  - CONTEXT
```
public static final java.lang.String CONTEXT
```
    Key of the parameter used set the search context. This context is available in the Answer (via getContext) and in the SearchAnswer via getInfos().get("context") The search context allows to chain queries easily without having to keep the parameters used in the previous queries.
    
    See Also:
    
    Answer.getContext(), SearchAnswer.getInfos(), SearchQuery.setSearchContext(String), Constant Field Values
  - ADD_CATEGORY_GROUP
```
public static final java.lang.String ADD_CATEGORY_GROUP
```
    Key of the parameter used to add category group. Note that you can override the settings of an existing group. Syntax: groupId@rootPath[@directory:inHits:maxCategories:maxCategoryTreeDepth:maxCategoriesPerLevel:sortFunction], ex: Source@Top/Source:1::3
    Warning this parameter is not supported on the 4.6 product
    
    See Also:
    
    SearchQuery.addCategoryGroup(String, String, String, boolean, Integer, Integer, Integer, String), Constant Field Values
  - REMOVE_CATEGORY_GROUP
```
public static final java.lang.String REMOVE_CATEGORY_GROUP
```
    Key of the parameter used to remove a category group. (the parameter value is category group id)
    
    See Also:
    
    SearchQuery.removeCategoryGroup(String), Constant Field Values
  - ADD_HIT_META
```
public static final java.lang.String ADD_HIT_META
```
    Key of the parameter used to add hit meta from an index field. This is allow to dynamically override the list of RetrivedField defined in the Search Logic used. Not that the Search Logic is not modified and this setting is only applied to the current query. There are two syntaxes depending whether in data is stored using the CSV format in the index field or not. (MultiRetrievedField in the Search Logic Config).
    simple syntax: name[:summary]@indexField[:highlighting:maxLength] (hightlighting values are 1 or 0), ex: mymeta@myindexfield:0:100
    syntax for csv encoded field:@indexField[:highlighting:maxLength], ex: @product_info:0
    Warning this parameter is not supported on the 4.6 product
    
    See Also:
    
    SearchQuery.addMetaFromField(String, String, boolean, Integer), SearchQuery.addMetasFromCSVField(String[], String, String[], boolean, Integer), Constant Field Values
  - REMOVE_HIT_META
```
public static final java.lang.String REMOVE_HIT_META
```
    Key of the parameter used to remove a meta from hits (parameter value retrieved field name)
    Warning this parameter is not supported on the 4.6 product
    
    See Also:
    
    SearchQuery.removeMeta(String), Constant Field Values
  - ADD_VIRTUAL_FIELD
```
public static final java.lang.String ADD_VIRTUAL_FIELD
```
    Key of the parameter used to add a new virtual field definition. Then this virtual field be can retrieved in the hits using SearchParameter#ADD_HIT_META parameter meta, and it can also be used to sort the results using the SearchParameter#SORT parameter. Note that you can override an existing definition.
    Syntax is : name:expression
    Warning this parameter is not supported on the 4.6 product
    
    See Also:
    
    SearchQuery.addVirtualField(String, String), Constant Field Values
  - REMOVE_VIRTUAL_FIELD
```
public static final java.lang.String REMOVE_VIRTUAL_FIELD
```
    Key of the parameter used to remove a virtual definition definition using its name.
    Warning this parameter is not supported on the 4.6 product
    
    See Also:
    
    SearchQuery.removeVirtualField(String), Constant Field Values
  - STATIC_RANKING_EXPRESSION
```
@Deprecated
public static final java.lang.String STATIC_RANKING_EXPRESSION
```
    Deprecated.
    
    Key of the parameter used to set the static ranking expression
    Warning this parameter is not supported on the 4.6 product
    
    See Also:
    
    SearchQuery.setStaticRankingExpression(String), SearchQuery.unSetStaticRankingExpression(), Constant Field Values
  - COLLAPSING
```
public static final java.lang.String COLLAPSING
```
    Key of the parameter used to configure the collapsing of the results. Supported values: "disabled", "lsb_only", "msb_only", "enabled"
    Warning this parameter is not supported on the 4.6 product
    
    See Also:
    
    SearchQuery.setCollapsing(boolean, boolean), Constant Field Values
  - TIMEOUT
```
public static final java.lang.String TIMEOUT
```
    Key of the parameter used to set the query timeout (ms).
    Warning this parameter is not supported on the 4.6 product
    
    See Also:
    
    SearchQuery.setTimeout(Integer), Constant Field Values
  - ORIGIN
```
@Deprecated
public static final java.lang.String ORIGIN
```
    Deprecated.
    
    Key of the parameter used to set the request origin.
    
    See Also:
    
    Constant Field Values
  - CHECKPOINTS
```
public static final java.lang.String CHECKPOINTS
```
    Key of the parameter used to request checkpoints.
    
    See Also:
    
    SearchQuery.setCheckpoints(String[]), Constant Field Values
  - DEBUG
```
public static final java.lang.String DEBUG
```
    Key of the parameter used to enable debug.
    
    See Also:
    
    Constant Field Values
  - REPORTING
```
public static final java.lang.String REPORTING
```
    Key of the parameter used to enable reporting.
    
    See Also:
    
    Constant Field Values
  - HIT_INFOS
```
public static final java.lang.String HIT_INFOS
```
    Key of the parameter used to add hit informations.
    
    See Also:
    
    Constant Field Values
  - ELLQL_QUERY
```
public static final java.lang.String ELLQL_QUERY
```
    Key of the parameter used to pass an ELLQL query
    
    See Also:
    
    Constant Field Values
  - QUERY_TEMPLATE
```
public static final java.lang.String QUERY_TEMPLATE
```
    Key of the parameter used to specify the query template
    
    See Also:
    
    Constant Field Values
  - DP
```
public static final java.lang.String DP
```
    Key of the parameter used to set the default prefix handler
    
    See Also:
    
    Constant Field Values
  - DP_CHUNK
```
public static final java.lang.String DP_CHUNK
```
    Key of the parameter used to set the default prefix handler for a specific query chunk
    
    See Also:
    
    Constant Field Values
  - QEC
```
public static final java.lang.String QEC
```
    Key of the parameter used to set the query expasion config
    
    See Also:
    
    Constant Field Values
  - PAL
```
public static final java.lang.String PAL
```
    Key of the parameter used to enable patterns expansion on all languages
    
    See Also:
    
    Constant Field Values
  - MM
```
public static final java.lang.String MM
```
    Key of the parameter used to specify the matching mode
    
    See Also:
    
    Constant Field Values
  - LIMITS
```
public static final java.lang.String LIMITS
```
    Key of the parameter used to set the limits
    
    See Also:
    
    Constant Field Values
  - HF
```
public static final java.lang.String HF
```
    Key of the parameter used to set the number of results that will be retrieved
    
    See Also:
    
    SearchQuery.setFullHits(int), Constant Field Values
  - USE_LOGIC_HIT_METAS
```
public static final java.lang.String USE_LOGIC_HIT_METAS
```
    Key of the parameter used to enable the use of logic's hit metas
    
    See Also:
    
    Constant Field Values
  - ADD_HIGHLIGHT
```
public static final java.lang.String ADD_HIGHLIGHT
```
    Key of the parameter used to add an highlight operation
    
    See Also:
    
    Constant Field Values
  - ADD_SUMMARY
```
public static final java.lang.String ADD_SUMMARY
```
    Key of the parameter used to add a snippet operation
    
    See Also:
    
    Constant Field Values
  - RT
```
public static final java.lang.String RT
```
    Key of the parameter used to enable RelatedTerms synthesis
    
    See Also:
    
    Constant Field Values
  - SYNTHESIS
```
public static final java.lang.String SYNTHESIS
```
    Key of the parameter used to enable facets
    
    See Also:
    
    Constant Field Values
  - SYNTHESIS_HITS
```
public static final java.lang.String SYNTHESIS_HITS
```
    Key of the parameter used to enable hit facets
    
    See Also:
    
    Constant Field Values
  - USE_LOGIC_FACETS
```
public static final java.lang.String USE_LOGIC_FACETS
```
    Key of the parameter used to enable the use of logic's facets
    
    See Also:
    
    Constant Field Values
  - REMOVE_FACET
```
public static final java.lang.String REMOVE_FACET
```
    Key of the parameter used to remove a facet
    
    See Also:
    
    Constant Field Values
  - SPELLCHECK
```
public static final java.lang.String SPELLCHECK
```
    Key of the parameter used to enable spellcheck
    
    See Also:
    
    Constant Field Values
  - SCORE_MAP
```
@Deprecated
public static final java.lang.String SCORE_MAP
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - TERM_SCORE
```
public static final java.lang.String TERM_SCORE
```
    Key of the parameter used to specify the term score formula
    
    See Also:
    
    Constant Field Values
  - PROXIMITY
```
public static final java.lang.String PROXIMITY
```
    Key of the parameter used to enable proximity
    
    See Also:
    
    Constant Field Values
  - PROXIMITY_MAX
```
@Deprecated
public static final java.lang.String PROXIMITY_MAX
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PROXIMITY_DISTANCE
```
public static final java.lang.String PROXIMITY_DISTANCE
```
    Key of the parameter used to specify the proximity max distance
    
    See Also:
    
    Constant Field Values
  - RELEVANCE
```
public static final java.lang.String RELEVANCE
```
    Key of the parameter used to enable text relevance
    
    See Also:
    
    Constant Field Values
  - STREAMING
```
public static final java.lang.String STREAMING
```
    Key of the parameter used to enable streaming search mode
    
    See Also:
    
    Constant Field Values
  - SORTED
```
public static final java.lang.String SORTED
```
    Key of the parameter used to enabled result sorting
    
    See Also:
    
    Constant Field Values
  - USE_LOGIC_VIRTUAL_FIELDS
```
public static final java.lang.String USE_LOGIC_VIRTUAL_FIELDS
```
    Key of the parameter used to enable the use of logic's virtual fields
    
    See Also:
    
    Constant Field Values
  - OUTPUT_FORMAT
```
public static final java.lang.String OUTPUT_FORMAT
```
    Key of the parameter used to specify the output format
    
    See Also:
    
    Constant Field Values
  - JSON_CALLBACK
```
public static final java.lang.String JSON_CALLBACK
```
    Key of the parameter used to specify a JavaScript callback
    
    See Also:
    
    Constant Field Values
  - CACHE
```
public static final java.lang.String CACHE
```
    Key of the parameter used to enable query caching
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SearchParameter
```
public SearchParameter(java.lang.String name,
                       java.lang.String value)
```
- Method Detail
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    java.lang.CloneNotSupportedException

Class SearchParameter

Field Summary

Fields inherited from class com.exalead.searchapi.xmlv10.client.AbstractParameter

Constructor Summary

Method Summary

Methods inherited from class com.exalead.searchapi.xmlv10.client.AbstractParameter

Methods inherited from class java.lang.Object

Field Detail

QUERY

NRESULTS

START

LANG

SORT

SORT_ASCENDING

SECURITY

ENFORCE_SECURITY

REFINE

CANCEL_REFINE

ZAP_REFINE

LOGIC

TARGET

CONTEXT

ADD_CATEGORY_GROUP

REMOVE_CATEGORY_GROUP

ADD_HIT_META

REMOVE_HIT_META

ADD_VIRTUAL_FIELD

REMOVE_VIRTUAL_FIELD

STATIC_RANKING_EXPRESSION

COLLAPSING

TIMEOUT

ORIGIN

CHECKPOINTS

DEBUG

REPORTING

HIT_INFOS

ELLQL_QUERY

QUERY_TEMPLATE

DP

DP_CHUNK

QEC

PAL

MM

LIMITS

HF

USE_LOGIC_HIT_METAS

ADD_HIGHLIGHT

ADD_SUMMARY

RT

SYNTHESIS

SYNTHESIS_HITS

USE_LOGIC_FACETS

REMOVE_FACET

SPELLCHECK

SCORE_MAP

TERM_SCORE

PROXIMITY

PROXIMITY_MAX

PROXIMITY_DISTANCE

RELEVANCE

STREAMING

SORTED

USE_LOGIC_VIRTUAL_FIELDS

OUTPUT_FORMAT

JSON_CALLBACK

CACHE

Constructor Detail

SearchParameter

Method Detail

clone