SearchQuery (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.searchapi.xmlv10.client.AbstractQuery<SearchQuery,SearchParameter>
- - com.exalead.searchapi.xmlv10.client.SearchQuery

All Implemented Interfaces:

java.lang.Cloneable
```
public class SearchQuery
extends AbstractQuery<SearchQuery,SearchParameter>
implements java.lang.Cloneable
```
SearchQuery holds the different search settings that are used to configure your search.
The SearchQuery can be configured using the various setters, or by setting the parameters yourself.
Each query contains several parameters, specified as name/value pairs. Several parameters can have the same name.
To execute a search, use a SearchClient that can be obtained through the SearchClientFactory

See Also:

SearchClient

Field Summary

Fields
Modifier and Type Field and Description

protected SearchAPIVersion version
- Fields inherited from class com.exalead.searchapi.xmlv10.client.AbstractQuery
  p

Fields
Modifier and Type	Field and Description
`protected SearchAPIVersion`	`version`

Constructor Summary

Constructors
Constructor and Description

SearchQuery()

SearchQuery(java.lang.String query)

Constructors
Constructor and Description
`SearchQuery()`
`SearchQuery(java.lang.String query)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCategoryGroup(java.lang.String name, java.lang.String root, java.lang.String directory, boolean inHits, java.lang.Integer maxCategories, java.lang.Integer maxCategoryTreeDepth, java.lang.Integer maxCategoriesPerLevel, java.lang.String sortFunction)` Deprecated. Use CloudViewV6R2012XFacetingQueryBuilder
`protected SearchQuery`	`addMetaFromField(java.lang.String metaName, java.lang.String indexField, boolean highlighting, boolean summary, java.lang.Integer maxLength)` Deprecated. Use CloudViewV6R2012XHitsQueryBuilder
`SearchQuery`	`addMetaFromField(java.lang.String metaName, java.lang.String indexField, boolean highlighting, java.lang.Integer maxLength)` Deprecated. Use CloudViewV6R2012XHitsQueryBuilder
`void`	`addMetasFromCSVField(java.lang.String[] metaNames, java.lang.String indexField, java.lang.String[] originalNames, boolean highlighting, java.lang.Integer maxLength)` Deprecated. Use CloudViewV6R2012XHitsQueryBuilder
`SearchQuery`	`addParameter(java.lang.String name, java.lang.String value)` Adds a search parameter which is composed by a name and a value.
`SearchQuery`	`addRefinement(java.lang.String refId, boolean excluded)` Adds a refinement
`SearchQuery`	`addSecurityToken(java.lang.String token)` Adds a security token
`SearchQuery`	`addSummaryMetaFromField(java.lang.String metaName, java.lang.String indexField, boolean highlighting, java.lang.Integer maxLength)` Deprecated. Use CloudViewV6R2012XHitsQueryBuilder
`void`	`addVirtualField(java.lang.String name, java.lang.String expression)` Add a virtual expression which can be used for relevance, faceting, or hits
`SearchQuery`	`cancelRefinement(java.lang.String refId)` Removes a refinement from the list of refinements.
`java.lang.Object`	`clone()`
`java.lang.String[]`	`getCheckpoints()` Gets the list of requested checkpoints
`int`	`getClientTimeoutMS()`
`java.lang.String`	`getCollapsing()` Deprecated. Use CloudViewV6R2012XRelevanceQueryBuilder
`java.lang.Integer`	`getFullHits()` Returns the number of results that will be retrieved
`java.lang.String`	`getLanguage()` Returns the query language
`SearchParameter[]`	`getParameters()` Return the list of all parameters
`java.lang.String`	`getQuery()` Returns the query string
`java.lang.String[]`	`getRefinements()` Returns the current refinements
`int`	`getResultsSetLength()` Deprecated.
`int`	`getResultsSetStart()`
`java.lang.String`	`getSearchContext()` Returns the search context (if it has been set)
`java.lang.String`	`getSearchLogic()` Returns the logic (default query) that will be used
`java.lang.String[]`	`getSecurityTokens()` Returns the current security tokens
`java.lang.String`	`getSortField()` Deprecated. Use CloudViewV6R2012XRelevanceQueryBuilder
`java.lang.String`	`getTarget()` Returns the target
`SearchAPIVersion`	`getTargetVersion()`
`java.lang.Integer`	`getTimeout()` Deprecated. Use CloudView52LimitsQueryBuilder
`boolean`	`isSortAscending()` Deprecated. Use CloudViewV6R2012XRelevanceQueryBuilder
`SearchQuery`	`removeCategoryGroup(java.lang.String name)` Deprecated. Use CloudViewV6R2012XFacetingQueryBuilder
`SearchQuery`	`removeMeta(java.lang.String metaName)` Deprecated.
`SearchQuery`	`removeParameter(java.lang.String name)` Removes the parameter(s) with the given name If several parameters have the same name they will all be removed
`SearchQuery`	`removeSecurityToken(java.lang.String token)` Removes a security token from the list of security tokens
`void`	`removeVirtualField(java.lang.String name)` Note that only the virtual field definition will be removed, if the field is retrieved as the meta, the meta must be also be removed.
`void`	`setAscendingSort(boolean isAscending)` Deprecated. Use CloudViewV6R2012XRelevanceQueryBuilder
`SearchQuery`	`setCheckpoints(java.lang.String checkpoints)` Sets the checkpoints to retrieve
`SearchQuery`	`setCheckpoints(java.lang.String[] checkpoints)` Sets the checkpoints to retrieve
`void`	`setClientTimeoutMS(int clientTimeoutMS)`
`SearchQuery`	`setCollapsing(boolean lsb, boolean msb)` Deprecated. Use CloudViewV6R2012XRelevanceQueryBuilder
`SearchQuery`	`setEnforceSecurity(boolean enforce)`
`SearchQuery`	`setFullHits(int length)` Sets the number of results that will be retrieved
`SearchQuery`	`setLanguage(java.lang.String lang)` Sets the query language
`SearchQuery`	`setParameter(java.lang.String name, java.lang.String value)` Set a search parameter on your query.
`SearchQuery`	`setQuery(java.lang.String query)` Sets the query string Example: "exalead OR author:bourdoncle" (see Query Language Guide for more details)
`SearchQuery`	`setResultsSetLength(int length)` Sets the number of results that will be retrieved
`SearchQuery`	`setResultsSetLength(long length)` Sets the number of results that will be retrieved
`SearchQuery`	`setResultsSetStart(int startIndex)` Set the index of the first result to retrieve
`SearchQuery`	`setResultsSetStart(long startIndex)` Set the index of the first result to retrieve
`SearchQuery`	`setSearchContext(java.lang.String context)` Sets the search context.
`SearchQuery`	`setSearchLogic(java.lang.String name)` Sets the logic (default query) that will be used
`SearchQuery`	`setSortField(java.lang.String fieldName)` Deprecated. Use CloudView60RelevanceQueryBuilder
`SearchQuery`	`setSortField(java.lang.String fieldName, boolean isSecondary)` Deprecated. Use CloudViewV6R2012XRelevanceQueryBuilder
`void`	`setStaticRankingExpression(java.lang.String expression)` Deprecated. Use CloudView60RelevanceQueryBuilder
`SearchQuery`	`setTarget(java.lang.String target)` Sets the search target
`void`	`setTargetVersion(SearchAPIVersion version)`
`SearchQuery`	`setTimeout(java.lang.Integer millis)` Deprecated. Use CloudView52LimitsQueryBuilder
`void`	`unSetStaticRankingExpression()` Deprecated. Use CloudView60RelevanceQueryBuilder

Methods inherited from class com.exalead.searchapi.xmlv10.client.AbstractQuery
addParameter, buildRequest, getParameter, getParameters, getParametersList, getParametersList, getParameterValue, getParameterValues, removeParameter, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - version
```
protected SearchAPIVersion version
```
- Constructor Detail
  - SearchQuery
```
public SearchQuery()
```
  - SearchQuery
```
public SearchQuery(java.lang.String query)
```
- Method Detail
  - setTargetVersion
```
public void setTargetVersion(SearchAPIVersion version)
```
  - getTargetVersion
```
public SearchAPIVersion getTargetVersion()
```
  - getClientTimeoutMS
```
public int getClientTimeoutMS()
```
  - setClientTimeoutMS
```
public void setClientTimeoutMS(int clientTimeoutMS)
```
  - setQuery
```
public SearchQuery setQuery(java.lang.String query)
```
    Sets the query string Example: "exalead OR author:bourdoncle" (see Query Language Guide for more details)
  - getQuery
```
public java.lang.String getQuery()
```
    Returns the query string
  - setLanguage
```
public SearchQuery setLanguage(java.lang.String lang)
```
    Sets the query language
    
    Parameters:
    
    lang - a langId (ex: "en", "fr")
  - getLanguage
```
public java.lang.String getLanguage()
```
    Returns the query language
  - setTarget
```
public SearchQuery setTarget(java.lang.String target)
```
    Sets the search target
    
    Parameters:
    
    target - The Target
  - getTarget
```
public java.lang.String getTarget()
```
    Returns the target
  - setResultsSetStart
```
public SearchQuery setResultsSetStart(int startIndex)
```
    Set the index of the first result to retrieve
    
    Parameters:
    
    startIndex - index of the first result (starts from 0)
  - setResultsSetStart
```
public SearchQuery setResultsSetStart(long startIndex)
```
    Set the index of the first result to retrieve
    
    Parameters:
    
    startIndex - index of the first result (starts from 0)
  - getResultsSetStart
```
public int getResultsSetStart()
```
    Returns:
    
    the index of the first result to retrieve, 0 if not set
  - setResultsSetLength
```
public SearchQuery setResultsSetLength(int length)
```
    Sets the number of results that will be retrieved
    
    See Also:
    
    setFullHits}
  - setResultsSetLength
```
public SearchQuery setResultsSetLength(long length)
```
    Sets the number of results that will be retrieved
    
    See Also:
    
    setFullHits}
  - getResultsSetLength
```
@Deprecated
public int getResultsSetLength()
```
    Deprecated.
    
    Returns the number of results that will be retrieved
    
    See Also:
    
    getFullHits}
  - setFullHits
```
public SearchQuery setFullHits(int length)
```
    Sets the number of results that will be retrieved
  - getFullHits
```
public java.lang.Integer getFullHits()
```
    Returns the number of results that will be retrieved
  - setSearchLogic
```
public SearchQuery setSearchLogic(java.lang.String name)
```
    Sets the logic (default query) that will be used
    
    Parameters:
    
    name - a logic name (5.0) or query name (4.6)
  - getSearchLogic
```
public java.lang.String getSearchLogic()
```
    Returns the logic (default query) that will be used
  - setSearchContext
```
public SearchQuery setSearchContext(java.lang.String context)
```
    Sets the search context.
    This context is available in the Answer (via getContext) and in the SearchAnswer via SearchAnswer.getInfos(), (the key is "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(), setSearchContext(String)
  - getSearchContext
```
public java.lang.String getSearchContext()
```
    Returns the search context (if it has been set)
  - getRefinements
```
public java.lang.String[] getRefinements()
```
    Returns the current refinements
    Excluded refinements are prefixed with "-" others are prefixed with "+"
  - setCheckpoints
```
public SearchQuery setCheckpoints(java.lang.String checkpoints)
```
    Sets the checkpoints to retrieve
    
    Parameters:
    
    checkpoints - String of comma separated checkpoints
  - setCheckpoints
```
public SearchQuery setCheckpoints(java.lang.String[] checkpoints)
```
    Sets the checkpoints to retrieve
  - getCheckpoints
```
public java.lang.String[] getCheckpoints()
```
    Gets the list of requested checkpoints
  - addParameter
```
public SearchQuery addParameter(java.lang.String name,
                                java.lang.String value)
```
    Adds a search parameter which is composed by a name and a value. Using search parameters instead of the different setters on the SearchQuery may be convenient when the query is built from HTTP parameters Standard parameter names are static fields of the class SearchParameter
    
    Overrides:
    
    addParameter in class AbstractQuery<SearchQuery,SearchParameter>
    
    Parameters:
    
    name - the name of the search parameter. null is not acceptable.
    
    value - the value of the search parameter. null is not acceptable.
  - removeParameter
```
public SearchQuery removeParameter(java.lang.String name)
```
    Removes the parameter(s) with the given name If several parameters have the same name they will all be removed
    
    Overrides:
    
    removeParameter in class AbstractQuery<SearchQuery,SearchParameter>
  - setParameter
```
public SearchQuery setParameter(java.lang.String name,
                                java.lang.String value)
```
    Set a search parameter on your query. If other parameters with the same name exist, they are removed and replaced.
    
    Overrides:
    
    setParameter in class AbstractQuery<SearchQuery,SearchParameter>
    
    Parameters:
    
    name - : search parameter name
    
    Returns:
    
    this for easy "chaining" of set calls
    
    See Also:
    
    addParameter
  - addRefinement
```
public SearchQuery addRefinement(java.lang.String refId,
                                 boolean excluded)
```
    Adds a refinement
    A refinement is way to precise your query by adding restriction to a set of categories related terms. A refinement can be a selection or an exclusion of a category (or related term).
    
    Parameters:
    
    refId - the id of a category or related term Category.getId(), RelatedTerm.getId()
  - cancelRefinement
```
public SearchQuery cancelRefinement(java.lang.String refId)
```
    Removes a refinement from the list of refinements.
    
    Parameters:
    
    refId - the id of the refinement.
  - getSecurityTokens
```
public java.lang.String[] getSecurityTokens()
```
    Returns the current security tokens
  - addSecurityToken
```
public SearchQuery addSecurityToken(java.lang.String token)
```
    Adds 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.
  - setEnforceSecurity
```
public SearchQuery setEnforceSecurity(boolean enforce)
```
  - removeSecurityToken
```
public SearchQuery removeSecurityToken(java.lang.String token)
```
    Removes a security token from the list of security tokens
  - getParameters
```
public SearchParameter[] getParameters()
```
    Return the list of all parameters
    
    Specified by:
    
    getParameters in class AbstractQuery<SearchQuery,SearchParameter>
  - setSortField
```
@Deprecated
public SearchQuery setSortField(java.lang.String fieldName)
```
    Deprecated. Use CloudView60RelevanceQueryBuilder
    
    Sets the field on which the results will be sorted on. Note that you can't sort on alphanumerical and category fields
    
    Parameters:
    
    fieldName - the name of a field (that can be used for sorting)
  - setSortField
```
@Deprecated
public SearchQuery setSortField(java.lang.String fieldName,
                                            boolean isSecondary)
```
    Deprecated. Use CloudViewV6R2012XRelevanceQueryBuilder
    
    Sets the field on which the results will be sorted on. Note that you can't sort on alphanumerical and category fields
    Warning this method is not supported on the 4.6 product
    
    Parameters:
    
    fieldName - the name of a field (that can be used for sorting)
    
    isSecondary - wether the sort is secondary or not. When the sort is secondary it is only applied to the results with the same score.
  - getSortField
```
@Deprecated
public java.lang.String getSortField()
```
    Deprecated. Use CloudViewV6R2012XRelevanceQueryBuilder
    
    Returns the field on which the results will be sorted
    Note that when using setSortField(String, boolean) the syntax of the returned string is the following one: "sortedFiled::" or "sortedFiled::sec" if the sort is secondary
  - setAscendingSort
```
@Deprecated
public void setAscendingSort(boolean isAscending)
```
    Deprecated. Use CloudViewV6R2012XRelevanceQueryBuilder
    
    Sets whether the sort is ascending or not.
  - isSortAscending
```
@Deprecated
public boolean isSortAscending()
```
    Deprecated. Use CloudViewV6R2012XRelevanceQueryBuilder
    
    Returns whether the sort is ascending or not.
  - addMetaFromField
```
@Deprecated
public SearchQuery addMetaFromField(java.lang.String metaName,
                                                java.lang.String indexField,
                                                boolean highlighting,
                                                java.lang.Integer maxLength)
```
    Deprecated. Use CloudViewV6R2012XHitsQueryBuilder
    
    Retrieve a meta from the specified index field. (does not modify the search logic)
    
    Parameters:
    
    metaName - (mandatory)
    
    indexField - (mandatory)
    
    highlighting - sets the meta should be highlighted or not
    
    maxLength - sets the maximum length of the meta, optional, if missing default value will be used
  - addSummaryMetaFromField
```
@Deprecated
public SearchQuery addSummaryMetaFromField(java.lang.String metaName,
                                                       java.lang.String indexField,
                                                       boolean highlighting,
                                                       java.lang.Integer maxLength)
```
    Deprecated. Use CloudViewV6R2012XHitsQueryBuilder
    
    Retrieve a summarized meta from the specified index field. (does not modify the search logic)
    Warning, this feature is not supported by CloudView 4.6
    
    Parameters:
    
    metaName - (mandatory)
    
    indexField - (mandatory)
    
    highlighting - sets the meta should be highlighted or not
    
    maxLength - sets the maximum length of the meta, optional, if missing default value will be used
  - addMetaFromField
```
@Deprecated
protected SearchQuery addMetaFromField(java.lang.String metaName,
                                                   java.lang.String indexField,
                                                   boolean highlighting,
                                                   boolean summary,
                                                   java.lang.Integer maxLength)
```
    Deprecated. Use CloudViewV6R2012XHitsQueryBuilder
  - addMetasFromCSVField
```
@Deprecated
public void addMetasFromCSVField(java.lang.String[] metaNames,
                                             java.lang.String indexField,
                                             java.lang.String[] originalNames,
                                             boolean highlighting,
                                             java.lang.Integer maxLength)
```
    Deprecated. Use CloudViewV6R2012XHitsQueryBuilder
    
    Retrieve a list of meta from the specified index field which content is CSV encoded. (does not modify the search logic)
    Warning, this feature is not supported by CloudView 4.6
    
    Parameters:
    
    metaNames - a list of meta name (mandatory)
    
    indexField - (mandatory) index field name from which the metas should be retrieved
    
    originalNames - list of original names, if null metaNames list will be used
    
    highlighting - sets the meta should be highlighted or not
    
    maxLength - sets the maximum length of the meta, optional, if missing default value will be used
  - removeMeta
```
@Deprecated
public SearchQuery removeMeta(java.lang.String metaName)
```
    Deprecated.
    
    Remove a hit meta that can be defined in the search logic (the search logic is not modified) or within this SearchQuery
    
    Parameters:
    
    metaName - name of the meta to remove
  - addCategoryGroup
```
@Deprecated
public void addCategoryGroup(java.lang.String name,
                                         java.lang.String root,
                                         java.lang.String directory,
                                         boolean inHits,
                                         java.lang.Integer maxCategories,
                                         java.lang.Integer maxCategoryTreeDepth,
                                         java.lang.Integer maxCategoriesPerLevel,
                                         java.lang.String sortFunction)
```
    Deprecated. Use CloudViewV6R2012XFacetingQueryBuilder
    
    Adds a new category group in the search results. Does not modify the search logic, this setting is only used for the current query.
    Warning, this feature is not supported by CloudView 4.6
    
    Parameters:
    
    name - category group name
    
    root - root path of the category group, ex: "Top/Source"
    
    directory - name of category field (optional)
    
    inHits - configures whether the categories should be retrieved or not
    
    maxCategories - maximum number of categories in the group (optional)
    
    maxCategoryTreeDepth - maximum (optional)
    
    maxCategoriesPerLevel - (optional)
    
    sortFunction - supported values are: "count", "relevancy", "alphanum", "num", "date" (optional)
  - removeCategoryGroup
```
@Deprecated
public SearchQuery removeCategoryGroup(java.lang.String name)
```
    Deprecated. Use CloudViewV6R2012XFacetingQueryBuilder
    
    Removes a Category Group that may have been defined in the search logic or with addCategoryGroup(String, String, String, boolean, Integer, Integer, Integer, String)
    Warning, this feature is not supported by CloudView 4.6
    
    Parameters:
    
    name - the name of the category group the remove for this query
  - addVirtualField
```
public void addVirtualField(java.lang.String name,
                            java.lang.String expression)
```
    Add a virtual expression which can be used for relevance, faceting, or hits
    Warning, this feature is not supported by CloudView 4.6
    
    Parameters:
    
    name - virtual field name
    
    expression - expression
  - removeVirtualField
```
public void removeVirtualField(java.lang.String name)
```
    Note that only the virtual field definition will be removed, if the field is retrieved as the meta, the meta must be also be removed.
    
    Parameters:
    
    name - of the virtual field definition to remove
  - setStaticRankingExpression
```
@Deprecated
public void setStaticRankingExpression(java.lang.String expression)
```
    Deprecated. Use CloudView60RelevanceQueryBuilder
    
    Sets the static ranking expression to use for this query
    Warning, this feature is not supported by CloudView 4.6
    
    Parameters:
    
    expression - static ranking expression
  - unSetStaticRankingExpression
```
@Deprecated
public void unSetStaticRankingExpression()
```
    Deprecated. Use CloudView60RelevanceQueryBuilder
    
    Remove the static ranking expression for the current query
  - setTimeout
```
@Deprecated
public SearchQuery setTimeout(java.lang.Integer millis)
```
    Deprecated. Use CloudView52LimitsQueryBuilder
    
    Sets the query timeout
    
    Parameters:
    
    millis - query timeout in milliseconds
  - getTimeout
```
@Deprecated
public java.lang.Integer getTimeout()
```
    Deprecated. Use CloudView52LimitsQueryBuilder
    
    Returns the query timeout
    Warning, this feature is not supported by CloudView 4.6
    
    Returns:
    
    the query timeout (milliseconds) if available
  - setCollapsing
```
@Deprecated
public SearchQuery setCollapsing(boolean lsb,
                                             boolean msb)
```
    Deprecated. Use CloudViewV6R2012XRelevanceQueryBuilder
    
    Allows to configure the collapsing
    Warning, this feature is not supported by CloudView 4.6
    
    Parameters:
    
    lsb - use the first 32 bits of the field
    
    msb - use the bits from 33 to 64 of the field
  - getCollapsing
```
@Deprecated
public java.lang.String getCollapsing()
```
    Deprecated. Use CloudViewV6R2012XRelevanceQueryBuilder
    
    Warning, this feature is not supported by CloudView 4.6
    
    Returns:
    
    collapsing state : "disabled", "lsb_only", "msb_only", "enabled"
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    java.lang.CloneNotSupportedException

Class SearchQuery

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

version

Constructor Detail

SearchQuery

SearchQuery

Method Detail

setTargetVersion

getTargetVersion

getClientTimeoutMS

setClientTimeoutMS

setQuery

getQuery

setLanguage

getLanguage

setTarget

getTarget

setResultsSetStart

setResultsSetStart

getResultsSetStart

setResultsSetLength

setResultsSetLength

getResultsSetLength

setFullHits

getFullHits

setSearchLogic

getSearchLogic

setSearchContext

getSearchContext

getRefinements

setCheckpoints

setCheckpoints

getCheckpoints

addParameter

removeParameter

setParameter

addRefinement

cancelRefinement

getSecurityTokens

addSecurityToken

setEnforceSecurity

removeSecurityToken

getParameters

setSortField

setSortField

getSortField

setAscendingSort

isSortAscending

addMetaFromField

addSummaryMetaFromField

addMetaFromField

addMetasFromCSVField

removeMeta

addCategoryGroup

removeCategoryGroup

addVirtualField

removeVirtualField

setStaticRankingExpression

unSetStaticRankingExpression

setTimeout

getTimeout

setCollapsing

getCollapsing

clone