Class: ElasticsearchQuery

Extends

$k.Query

Methods

addAggregation(aggregationIdentifier, type, aggregationDefinition)

Adds an aggregation to the elastic query.

Parameters:

Name	Type	Description
`aggregationIdentifier`	string
`type`	string
`aggregationDefinition`	object

Since: 5.4.0

aggregation(aggregationIdentifier) → {object}

Returns the aggregation with the given name

Parameters:

Name	Type	Description
`aggregationIdentifier`	string

Since: 5.4.0

Returns:

Type:: object

definedParameters() → {Array.<$k.QueryParameter>}

Returns the parameters of the query

Inherited From: $k.Query#definedParameters
See: $k.Query#setParameter

Returns:

Type:: Array.<$k.QueryParameter>

deregister()

Deregisters the element. The id will be undefined afterwards. Equivalent to setId(undefined)

Inherited From: $k.RegistryElement#deregister
See: setId

explainElements(elements, parametersopt) → {Array.<$k.SemanticElement>}

Returns elements involved in the query

Parameters:

Name	Type	Attributes	Description
`elements`	Array.<$k.SemanticElement>		Elements to explain. Elements that do not match the query are ignored.
`parameters`	object	<optional>	The parameters object where the keys match the names of parameters defined in the query

Inherited From: $k.Query#explainElements
See: $k.Query#setParameter

Throws:

When the query could not be solved, e.g. missing parameters
Type $k.exception.QueryError

Returns:

Type:: Array.<$k.SemanticElement>

Returns all facet identifiers contained in the query result

Since: 5.5.0

Returns:

Type:: Array.<string>

facetTerms(facetIdentifier) → {Array.<$k.ElasticsearchTerm>}

Returns the corresponding facet terms with doc count

Parameters:

Name	Type	Description
`facetIdentifier`	string

Since: 5.5.0

Returns:

Type:: Array.<$k.ElasticsearchTerm>

Returns all elements that match the query. The two optional parameters can be given in any order.

Parameters:

Name	Type	Attributes	Description
`elements`	Array.<$k.SemanticElement>
`searchString`	string	<optional>
`parameters`	object	<optional>	The parameters object where the keys match the names of parameters defined in the query

Inherited From: $k.Query#filterElements
See: $k.Query#setParameter

Throws:

When the query could not be solved, e.g. missing parameters
Type $k.exception.QueryError

Returns:

Type:: Array.<$k.SemanticElement>

Example

var hits = $k.Registry.query("experts").filterElements(persons);

findElements(searchStringopt, parametersopt) → {Array.<$k.SemanticElement>}

Search and return all found semantic elements. The two parameters can be given in any order.

Parameters:

Name	Type	Attributes	Description
`searchString`	string	<optional>
`parameters`	object	<optional>	The parameters object where the keys match the names of parameters defined in the query

Inherited From: $k.Query#findElements
See: $k.Query#setParameter

Throws:

When the query could not be solved, e.g. missing parameters
Type $k.exception.QueryError

Returns:

Type:: Array.<$k.SemanticElement>

Examples

var hits = $k.Registry.query("directSearch").findElements("Test");

var hits = $k.Registry.query("compositeSearch").findElements("Test", { context: "portal" });

findHits(searchStringopt, parametersopt) → {Array.<$k.Hit>}

Search and return all found hits. The two arguments can be given in any order.

Parameters:

Name	Type	Attributes	Description
`searchString`	string	<optional>
`parameters`	object	<optional>	The parameters object where the keys match the names of parameters defined in the query

Inherited From: $k.Query#findHits
See: $k.Query#setParameter

Throws:

When the query could not be solved, e.g. missing parameters
Type $k.exception.QueryError

Returns:

Type:: Array.<$k.Hit>

Example

var hits = $k.Registry.query("directSearch").findHits("Test*");

findResultSize(searchStringopt, parametersopt) → {number}

Search and return the number of found semantic elements. The two arguments can be given in any order.

Parameters:

Name	Type	Attributes	Description
`searchString`	string	<optional>
`parameters`	object	<optional>	The parameters object where the keys match the names of parameters defined in the query

Since: 5.3.3
Inherited From: $k.Query#findResultSize
See: $k.Query#findElements

Throws:

When the query could not be solved, e.g. missing parameters
Type $k.exception.QueryError

Returns:

Type:: number

fullExplainElements(elements, parametersopt) → {Array.<$k.SemanticElement>}

Returns all elements involved in the query

Parameters:

Name	Type	Attributes	Description
`elements`	Array.<$k.SemanticElement>		Elements to fully explain. Elements that do not match the query are ignored.
`parameters`	object	<optional>	The parameters object where the keys match the names of parameters defined in the query

Inherited From: $k.Query#fullExplainElements
See: $k.Query#setParameter

Throws:

When the query could not be solved, e.g. missing parameters
Type $k.exception.QueryError

Returns:

Type:: Array.<$k.SemanticElement>

id() → {string|undefined}

Returns the registered ID, or undefined if not registered.

Inherited From: $k.RegistryElement#id

Returns:

Type:: string | undefined

name() → {string}

Returns the name

Inherited From: $k.Query#name

Returns:

Type:: string

paginate(startIndex, pageSize)

Sets the pagination of the query

Parameters:

Name	Type	Description
`startIndex`	number	Integer start index
`pageSize`	number	Integer size of the page

Since: 5.4.2

parentFolders() → {Array.<$k.Folder>}

Returns the folders that contain this element

Inherited From: $k.FolderElement#parentFolders

Returns:

Type:: Array.<$k.Folder>

registryType() → {string}

Returns the name of the registry that contains elements of this type

Inherited From: $k.RegistryElement#registryType

Returns:

Type:: string

renderElements(tableConfiguration, keyFilteropt, detailFilteropt) → {Array.<object>}

Search and render found semantic elements using the given table configuration

Parameters:

Name	Type	Attributes	Description
`tableConfiguration`	$k.TableConfiguration
`keyFilter`	object	<optional>	Alternative 1 (preferred): a $k.JSONRenderContext Alternative 2 (compatibility only): A filter. See $k.JSONRenderContext.prototype.setFilters().
`detailFilter`	object	<optional>	Only used if the key filter is not a $k.JSONRenderContext. See $k.JSONRenderContext.prototype.setLevelsOfDetail()

Since: 4.1.0
Inherited From: $k.Query#renderElements
Deprecated: This function is deprecated and might be removed in future releases

Throws:

When the query could not be solved, e.g. missing parameters
Type $k.exception.QueryError

Returns:

The rendered objects

Type:: Array.<object>

renderHits(tableConfiguration, keyFilteropt, detailFilteropt) → {Array.<object>}

Search and render found hits using the given table configuration

Parameters:

Name	Type	Attributes	Description
`tableConfiguration`	$k.TableConfiguration
`keyFilter`	object	<optional>	Alternative 1 (preferred): a $k.JSONRenderContext Alternative 2 (compatibility only): A filter. See $k.JSONRenderContext.prototype.setFilters().
`detailFilter`	object	<optional>	Only used if the key filter is not a $k.JSONRenderContext. See $k.JSONRenderContext.prototype.setLevelsOfDetail()

Since: 4.1.0
Inherited From: $k.Query#renderHits
Deprecated: This function is deprecated and might be removed in future releases

Throws:

When the query could not be solved, e.g. missing parameters
Type $k.exception.QueryError

Returns:

The rendered objects

Type:: Array.<object>

resetResult()

Resets the query result such that the query can be executed again, for example for getting the actual result after fetching the result size.

Since: 5.4.0

searchString() → {string}

Returns the search string

Inherited From: $k.Query#searchString

Returns:

Type:: string

setDomain(domain)

Restrict the query results to objects/types of the domains

Parameters:

Name	Type	Description
`domain`	$k.Domain \| string	The domain or internal name of a type

Since: 4.1.0
Inherited From: $k.Query#setDomain

setDomains(domains)

Restrict the query results to objects/types of the domains

Parameters:

Name	Type	Description
`domains`	Array.<$k.Domain> \| Array.<string>	The domains or internal names of types

Inherited From: $k.Query#setDomains

setFacetFilters(facetFiltersArray)

Set the selected facets and terms for the query

Parameters:

Name Type Description

facetFiltersArray

Array.<object>

Array with selected facets and terms

Properties

Name	Type	Attributes	Default	Description
`facetId`	string			Facet identifier
`termIds`	Array.<string>	<optional>		Term identifiers
`showAllTerms`	boolean	<optional>	false

Since: 5.1.3
Inherited From: $k.Query#setFacetFilters

setFacetTerms(facetId, terms)

Set the facet terms of the query.

Parameters:

Name	Type	Description
`facetId`	string	The ID of the facet
`terms`	Array.<$k.ElasticsearchTerm>	The terms to be activated for filtering.

Since: 5.5.0

Throws:

When the terms are not suitable for the facet
Type $k.exception.TypeError

setId(id, replaceScriptReferencesopt)

Registers the element with the given ID. If the element has already been registered, the current ID will be changed to the new ID. If the given ID is undefined or null, the element will be deregistered.

Parameters:

Name	Type	Attributes	Default	Description
`id`	string \| null			The ID to set
`replaceScriptReferences`	boolean	<optional>	false	True if ID references in scripts should be replaced. Only done when the old and the new ID is not undefined.

Inherited From: $k.RegistryElement#setId

setName(name)

Sets the name of the query

Parameters:

Name	Type	Description
`name`	string	The name

Version: Experimental feature, might be removed at any time
Since: 5.3.2
Inherited From: $k.Query#setName

setParameter(parameterId, value)

Set a parameter of the query.

Parameters:

Name	Type	Description
`parameterId`	string	The ID of the parameter
`value`		The value of the parameter. The type (string etc.) depends on the parameter. Arrays of values can be passed, too. The value undefined or null disables the parameterized condition.

Inherited From: $k.Query#setParameter

Throws:

When the value is not suitable for the parameter
Type $k.exception.TypeError

setParameters(parameters)

Set the parameters of the query from the properties of the object

Parameters:

Name	Type	Description
`parameters`	object	The parameters object where the keys match the names of parameters defined in the query

Inherited From: $k.Query#setParameters
See: $k.Query#setParameter

Throws:

When a value is not a suitable parameter
Type $k.exception.TypeError

setSearchString(searchString)

Set the string to search for

Parameters:

Name	Type	Description
`searchString`	string

Inherited From: $k.Query#setSearchString

$k. ElasticsearchQuery

Extends

Methods

addAggregation(aggregationIdentifier, type, aggregationDefinition)

aggregation(aggregationIdentifier) → {object}

definedParameters() → {Array.<$k.QueryParameter>}

deregister()

explainElements(elements, parametersopt) → {Array.<$k.SemanticElement>}

facets() → {Array.<string>}

facetTerms(facetIdentifier) → {Array.<$k.ElasticsearchTerm>}

filterElements(elements, searchStringopt, parametersopt) → {Array.<$k.SemanticElement>}

findElements(searchStringopt, parametersopt) → {Array.<$k.SemanticElement>}

findHits(searchStringopt, parametersopt) → {Array.<$k.Hit>}

findResultSize(searchStringopt, parametersopt) → {number}

fullExplainElements(elements, parametersopt) → {Array.<$k.SemanticElement>}

id() → {string|undefined}

name() → {string}

paginate(startIndex, pageSize)

parentFolders() → {Array.<$k.Folder>}

registryType() → {string}

renderElements(tableConfiguration, keyFilteropt, detailFilteropt) → {Array.<object>}

renderHits(tableConfiguration, keyFilteropt, detailFilteropt) → {Array.<object>}

resetResult()

searchString() → {string}

setDomain(domain)

setDomains(domains)

setFacetFilters(facetFiltersArray)

Properties

setFacetTerms(facetId, terms)

setId(id, replaceScriptReferencesopt)

setName(name)

setParameter(parameterId, value)

setParameters(parameters)

setSearchString(searchString)