org.graylog.plugins.views.search.searchtypes.pivot

Interface BucketSpecHandler<SPEC_TYPE extends BucketSpec,AGGREGATION_BUILDER,QUERY_RESULT,AGGREGATION_RESULT,SEARCHTYPE_HANDLER,QUERY_CONTEXT>

Type Parameters:

SPEC_TYPE - the type of bucket spec this handler deals with

AGGREGATION_BUILDER - implementation specific type for building up the aggregation when generating a backend query

QUERY_RESULT - the backend specific type holding the overall result from the backend

AGGREGATION_RESULT - the backend specific type holding the partial result for the generated aggregation

SEARCHTYPE_HANDLER - the backend specific type of the surrounding pivot search type handler

QUERY_CONTEXT - an opaque context object to pass around information between query generation and result handling

public interface BucketSpecHandler<SPEC_TYPE extends BucketSpec,AGGREGATION_BUILDER,QUERY_RESULT,AGGREGATION_RESULT,SEARCHTYPE_HANDLER,QUERY_CONTEXT>

Implementations of this class contribute handlers for buckets concrete implementations of the pivot search type.

Method Summary

Modifier and Type	Method and Description
default Optional<AGGREGATION_BUILDER>	createAggregation(String name, Pivot pivot, PivotSpec pivotSpec, SearchTypeHandler searchTypeHandler, GeneratedQueryContext queryContext, Query query)
Optional<AGGREGATION_BUILDER>	doCreateAggregation(String name, Pivot pivot, SPEC_TYPE bucketSpec, SEARCHTYPE_HANDLER searchTypeHandler, QUERY_CONTEXT queryContext, Query query)
Object	doHandleResult(Pivot pivot, SPEC_TYPE bucketSpec, QUERY_RESULT queryResult, AGGREGATION_RESULT result, SEARCHTYPE_HANDLER searchTypeHandler, QUERY_CONTEXT queryContext)
default Object	handleResult(Pivot pivot, BucketSpec bucketSpec, Object queryResult, Object aggregationResult, SearchTypeHandler searchTypeHandler, GeneratedQueryContext queryContext)

Method Detail

createAggregation

@Nonnull
default Optional<AGGREGATION_BUILDER> createAggregation(String name,
                                                                 Pivot pivot,
                                                                 PivotSpec pivotSpec,
                                                                 SearchTypeHandler searchTypeHandler,
                                                                 GeneratedQueryContext queryContext,
                                                                 Query query)

doCreateAggregation

@Nonnull
Optional<AGGREGATION_BUILDER> doCreateAggregation(String name,
                                                           Pivot pivot,
                                                           SPEC_TYPE bucketSpec,
                                                           SEARCHTYPE_HANDLER searchTypeHandler,
                                                           QUERY_CONTEXT queryContext,
                                                           Query query)

handleResult

default Object handleResult(Pivot pivot,
                            BucketSpec bucketSpec,
                            Object queryResult,
                            Object aggregationResult,
                            SearchTypeHandler searchTypeHandler,
                            GeneratedQueryContext queryContext)

doHandleResult

Object doHandleResult(Pivot pivot,
                      SPEC_TYPE bucketSpec,
                      QUERY_RESULT queryResult,
                      AGGREGATION_RESULT result,
                      SEARCHTYPE_HANDLER searchTypeHandler,
                      QUERY_CONTEXT queryContext)