java.lang.Object
- lumis.doui.control.Control
- - lumis.doui.control.DataControl
  - - lumis.doui.control.DataBoundControl
    - - lumis.doui.control.inputtext.InputTextControl
      - lumis.doui.control.inputtext.InputHiddenControl
        
        lumis.doui.search.SearchAggregationControl

All Implemented Interfaces:

java.util.Observer, VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer
```
@StableMinor(version="17.0",
             sinceVersion="9.0")
public class SearchAggregationControl
extends InputHiddenControl
```
Control responsible for manage user's aggregations. It is expected to be attached to a SearchSource.
The request parameter for this control is expected to have the following JSON format:

The currentUserQuery string is the current user search query (stored in the first time user typed a search query). The aggregated object is a map of aggregated values (that will be used to filter the big data query).
Sets source parameter values of aggregated values (filtered values) and aggregations (the aggregations that will be performed in Big data API).

XML data available for XSLT rendering:

Since:

9.0.0

Version:

$Revision: 26586 $ $Date: 2024-08-26 21:06:04 -0300 (Mon, 26 Aug 2024) $

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.util.Map<DocumentTypeField,java.util.Set<java.lang.Object>>`	`aggregatedValues`
`protected java.util.Map<java.lang.String,java.lang.String>`	`aggregationIdsByFieldFullId`
`protected java.lang.String`	`currentUserQuery`

Fields inherited from class lumis.doui.control.DataControl
FORCE_CASE_LOWER, FORCE_CASE_NONE, FORCE_CASE_UPPER, forceCase, requestParameterName, UNKNOWN_DATA_TYPE, value, valuePreviouslySet

Constructor Summary

Constructors
Constructor Description

SearchAggregationControl()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.lang.String`	`getAggregatedValuesXML(DocumentTypeField field, java.util.Set<java.lang.Object> aggregatedValues)`	Returns a XML string containing the aggregated values (user's applied filters). The expected XML string format is as follows: Parameters: `field` - the field that received the given filters. `aggregatedValues` - the user's applied filters values. Returns: the XML string. Throws: `PortalException` Since: 9.0.0 getAggregationResultXML protected java.lang.String getAggregationResultXML(DocumentTypeField field, IAggregationResult result) throws PortalException Returns a XML string of the given aggregation results for the given field. The expected XML string format is as follows: Parameters: `field` - the aggregation results' field. `result` - the aggregation result. Returns: a XML string Throws: `PortalException` Since: 9.0.0 getFieldsToBeAggregated protected java.util.Collection<DocumentTypeField> getFieldsToBeAggregated() throws PortalException Returns a collection of fields that will be aggregated in search. Returns: a collection of fields that will be aggregated in search. Throws: `PortalException` Since: 9.0.0 getAggregations protected java.util.List<IAggregation> getAggregations() throws PortalException Returns the aggregations that will be performed in search. Returns: the aggregations that will be performed in search. Throws: `PortalException` Since: 9.0.0 getAggregationId protected java.lang.String getAggregationId(DocumentTypeField field) Returns the aggregation identifier to be used in aggregation of the given field. Parameters: `field` - the field. Returns: the aggregation identifier to be used in aggregation of the given field. Since: 9.0.0 Skip navigation links Overview Package Class Use Tree Deprecated Index Help All Classes Summary: Nested \| Field \| Constr \| Method Detail: Field \| Constr \| Method LumisXP 17.0.0.240830 - Copyright © 2006–2024 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.

Class SearchAggregationControl

Field Summary

Fields inherited from class lumis.doui.control.DataControl

Fields inherited from class lumis.doui.control.Control

Constructor Summary

Method Summary

getAggregationResultXML

getFieldsToBeAggregated

getAggregations

getAggregationId