com.exalead.search.query

Class Query

java.lang.Object

com.exalead.search.query.Query

public class Query
extends java.lang.Object

The internal representation of a fully structured query to the Exalead Search service. This contains everything that can be overridden at query time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Query.CacheFlags Query Caching control
static class	Query.DebugInfo Debug / AdditionalQueryInfo
static class	Query.QueryUQLConfig Queries configuration

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allow_skip_nhits
AttrGraphConfig	attrGraphConfig
Query.CacheFlags	cacheFlags
java.util.List<java.lang.String>	checkpoints
Query.DebugInfo	debug
Query.QueryUQLConfig	defaultUQLConfig
SearchTarget	dynamicSearchTarget
java.util.Map<java.lang.String,java.lang.String>	ellqlQueries
boolean	enforceSecurity
boolean	fetchMasks
boolean	handleNegativeSecurityTokens
java.lang.String[]	hitOrder
HitConfig	hits
java.lang.String	indexSchema
java.lang.String	jsonCallback
java.lang.String	lang
LimitsConfig	limits
java.lang.String	logic
java.lang.String	name
java.lang.String	outputFormat
SearchParameters	parameters
ParsingConfig	parsing
PatternsExpansionConfig	patterns
PostFilterConfig	postFilter
java.util.Map<java.lang.String,java.lang.String>	qtVariables
java.lang.String	queryTemplate
RelevanceConfig	ranking
java.util.List<java.lang.String>	refinements
RelatedTermsSynthesisConfig	relatedTerms
com.exalead.mercury.mami.indexing.v10.IndexSchema	schema
java.util.List<java.lang.String>	securityTokens
SpellCheckerConfig	spellCheck
int	start
java.lang.String	target
TimezoneConfig	timezoneConfig
java.util.Map<java.lang.String,Query.QueryUQLConfig>	uqlConfigs
java.util.Map<java.lang.String,java.lang.String>	uqlQueries
java.util.List<VirtualFieldDefinition>	virtualFields

Constructor Summary

Constructors

Constructor and Description
Query()
Query(HitConfig hc, FacetsConfig fc)
Query(Query other)
Query(Query other, boolean includeQueryProcessingFields, boolean includeFullHitsFields, boolean includeSynthesisFields, boolean includeRelevanceFields)
Query(SearchLogic searchLogic, SearchParameters params)

Method Summary

Modifier and Type	Method and Description
void	addExpandError(int errorCode, int severity, java.lang.String genericErrorMsg, java.lang.String additionalErrorMsg, java.lang.String contextErrorMsg) Expand Search Server side errors
void	addFacet(Facet facet) Add a collection of facets to the query.
void	addFacets(java.util.Collection<Facet> facets)
void	clearFacets()
CategoryFacet	getDataModelClassCategoryFacet()
java.util.List<com.exalead.search.internal.answer.ExpandError>	getExpandErrors()
Facet	getFacet(java.lang.String id) Faceting
java.util.List<Facet>	getFacets()
FacetsConfig	getFacetsConfig()
HitConfig	getHitConfig()
java.util.List<Facet>	getInHitFacets()
java.util.Map<java.lang.String,Facet>	getNavigatedFacets()
boolean	isInMultiDim(java.lang.String fId)

Methods inherited from class java.lang.Object

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

Field Detail

parameters

public final SearchParameters parameters

name

public java.lang.String name

outputFormat

public java.lang.String outputFormat

jsonCallback

public java.lang.String jsonCallback

lang

public java.lang.String lang

logic

public java.lang.String logic

target

public java.lang.String target

hitOrder

public java.lang.String[] hitOrder

dynamicSearchTarget

public SearchTarget dynamicSearchTarget

checkpoints

public final java.util.List<java.lang.String> checkpoints

indexSchema

public java.lang.String indexSchema

schema

public com.exalead.mercury.mami.indexing.v10.IndexSchema schema

start

public int start

fetchMasks

public boolean fetchMasks

allow_skip_nhits

public boolean allow_skip_nhits

enforceSecurity

public boolean enforceSecurity

handleNegativeSecurityTokens

public boolean handleNegativeSecurityTokens

securityTokens

public final java.util.List<java.lang.String> securityTokens

refinements

public final java.util.List<java.lang.String> refinements

parsing

public final ParsingConfig parsing

patterns

public final PatternsExpansionConfig patterns

spellCheck

public final SpellCheckerConfig spellCheck

limits

public final LimitsConfig limits

ranking

public final RelevanceConfig ranking

relatedTerms

public final RelatedTermsSynthesisConfig relatedTerms

hits

public final HitConfig hits

postFilter

public final PostFilterConfig postFilter

attrGraphConfig

public final AttrGraphConfig attrGraphConfig

timezoneConfig

public final TimezoneConfig timezoneConfig

virtualFields

public final java.util.List<VirtualFieldDefinition> virtualFields

uqlQueries

public final java.util.Map<java.lang.String,java.lang.String> uqlQueries

ellqlQueries

public final java.util.Map<java.lang.String,java.lang.String> ellqlQueries

qtVariables

public final java.util.Map<java.lang.String,java.lang.String> qtVariables

defaultUQLConfig

public final Query.QueryUQLConfig defaultUQLConfig

uqlConfigs

public final java.util.Map<java.lang.String,Query.QueryUQLConfig> uqlConfigs

queryTemplate

public java.lang.String queryTemplate

debug

public final Query.DebugInfo debug

cacheFlags

public final Query.CacheFlags cacheFlags

Constructor Detail

Query

public Query()

Query

public Query(HitConfig hc,
             FacetsConfig fc)

Query

public Query(SearchLogic searchLogic,
             SearchParameters params)
      throws QueryProcessingException

Throws:

QueryProcessingException

Query

public Query(Query other)

Query

public Query(Query other,
             boolean includeQueryProcessingFields,
             boolean includeFullHitsFields,
             boolean includeSynthesisFields,
             boolean includeRelevanceFields)

Method Detail

getFacetsConfig

public FacetsConfig getFacetsConfig()

getFacet

public Facet getFacet(java.lang.String id)

Faceting

getFacets

public java.util.List<Facet> getFacets()

getHitConfig

public HitConfig getHitConfig()

getNavigatedFacets

public java.util.Map<java.lang.String,Facet> getNavigatedFacets()

getDataModelClassCategoryFacet

@Nullable
public CategoryFacet getDataModelClassCategoryFacet()

getInHitFacets

public java.util.List<Facet> getInHitFacets()

isInMultiDim

public boolean isInMultiDim(java.lang.String fId)

clearFacets

public void clearFacets()

addFacet

public void addFacet(Facet facet)

Add a collection of facets to the query. Facets and facets referencing them must be added in the same batch.

addFacets

public void addFacets(java.util.Collection<Facet> facets)

addExpandError

public void addExpandError(int errorCode,
                           int severity,
                           java.lang.String genericErrorMsg,
                           java.lang.String additionalErrorMsg,
                           java.lang.String contextErrorMsg)

Expand Search Server side errors

getExpandErrors

public java.util.List<com.exalead.search.internal.answer.ExpandError> getExpandErrors()