sirius.biz.web

Class ElasticPageHelper<E extends sirius.db.es.ElasticEntity>

java.lang.Object

sirius.biz.web.BasePageHelper<E,sirius.db.es.constraints.ElasticConstraint,sirius.db.es.ElasticQuery<E>,ElasticPageHelper<E>>

sirius.biz.web.ElasticPageHelper<E>

Type Parameters:

E - the generic type of the entities being queried

public class ElasticPageHelper<E extends sirius.db.es.ElasticEntity>
extends BasePageHelper<E,sirius.db.es.constraints.ElasticConstraint,sirius.db.es.ElasticQuery<E>,ElasticPageHelper<E>>

Implements a page helper for elastic queries.

Most notably this supports various aggregations for facets out of the box.

Field Summary

Fields inherited from class sirius.biz.web.BasePageHelper

baseQuery, ctx, DEFAULT_PAGE_SIZE, facets, pageSize, searchFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ElasticPageHelper(sirius.db.es.ElasticQuery<E> query)

Method Summary

Modifier and Type	Method and Description
ElasticPageHelper<E>	addTermAggregation(sirius.db.mixing.Mapping field) Adds a automatic facet for values in the given field.
ElasticPageHelper<E>	addTermAggregation(sirius.db.mixing.Mapping field, int numberOfBuckets) Adds a automatic facet for values in the given field.
ElasticPageHelper<E>	addTermAggregation(String title, sirius.db.mixing.Mapping field, sirius.kernel.cache.ValueComputer<String,String> translator, int numberOfBuckets) Adds a automatic facet for values in the given field.
ElasticPageHelper<E>	addTimeAggregation(sirius.db.mixing.Mapping field, sirius.db.mixing.DateRange... ranges) Adds a time series based aggregation.
ElasticPageHelper<E>	addTimeAggregation(sirius.db.mixing.Mapping field, String title, sirius.db.mixing.DateRange... ranges) Adds a time series based aggregation.
protected void	fillPage(sirius.kernel.commons.Watch w, sirius.web.controller.Page<E> result, List<E> items)
static <E extends sirius.db.es.ElasticEntity> ElasticPageHelper<E>	withQuery(sirius.db.es.ElasticQuery<E> baseQuery) Creates a new instance with the given base query.

Methods inherited from class sirius.biz.web.BasePageHelper

addBooleanFacet, addFacet, addFacet, addFilterFacet, addTimeFacet, applyFacets, asPage, createTimeFacet, enforcePaging, executeQuery, setupPaging, withContext, withPageSize, withSearchFields

Methods inherited from class java.lang.Object

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

Constructor Detail

ElasticPageHelper

protected ElasticPageHelper(sirius.db.es.ElasticQuery<E> query)

Method Detail

withQuery

public static <E extends sirius.db.es.ElasticEntity> ElasticPageHelper<E> withQuery(sirius.db.es.ElasticQuery<E> baseQuery)

Creates a new instance with the given base query.

Type Parameters:

E - the generic entity type being queried

Parameters:

baseQuery - the initial query to execute

Returns:

a new instance operating on the given base query

addTermAggregation

public ElasticPageHelper<E> addTermAggregation(sirius.db.mixing.Mapping field)

Adds a automatic facet for values in the given field.

Parameters:

field - the field to aggregate on

Returns:

the helper itself for fluent method calls

addTermAggregation

public ElasticPageHelper<E> addTermAggregation(sirius.db.mixing.Mapping field,
                                               int numberOfBuckets)

Adds a automatic facet for values in the given field.

Parameters:

field - the field to aggregate on

numberOfBuckets - the maximal number of buckets collect and return

Returns:

the helper itself for fluent method calls

addTimeAggregation

public ElasticPageHelper<E> addTimeAggregation(sirius.db.mixing.Mapping field,
                                               sirius.db.mixing.DateRange... ranges)

Adds a time series based aggregation.

Parameters:

field - the field to filter on

ranges - the ranges which are supported as filter values

Returns:

the helper itself for fluent method calls

addTimeAggregation

public ElasticPageHelper<E> addTimeAggregation(sirius.db.mixing.Mapping field,
                                               String title,
                                               sirius.db.mixing.DateRange... ranges)

Adds a time series based aggregation.

Parameters:

field - the field to filter on

title - the title of the filter shown to the user

ranges - the ranges which are supported as filter values

Returns:

the helper itself for fluent method calls

addTermAggregation

public ElasticPageHelper<E> addTermAggregation(String title,
                                               sirius.db.mixing.Mapping field,
                                               sirius.kernel.cache.ValueComputer<String,String> translator,
                                               int numberOfBuckets)

Adds a automatic facet for values in the given field.

Parameters:

title - the title to use for the facet

field - the field to aggregate on

translator - the translator used to convert field values into filter labels

numberOfBuckets - the maximal number of buckets collect and return

Returns:

the helper itself for fluent method calls

fillPage

protected void fillPage(sirius.kernel.commons.Watch w,
                        sirius.web.controller.Page<E> result,
                        List<E> items)

Overrides:

fillPage in class BasePageHelper<E extends sirius.db.es.ElasticEntity,sirius.db.es.constraints.ElasticConstraint,sirius.db.es.ElasticQuery<E extends sirius.db.es.ElasticEntity>,ElasticPageHelper<E extends sirius.db.es.ElasticEntity>>