Package lumis.portal.bigdata.query

Interfaces and classes used for performing a query in IBigDataRepository (more specifically in an IBigDataSearcher).

Since:

8.1.0

Version:

$Revision$ $Date$

Interface Summary

Interface	Description
IAggregation	Aggregation to be used in search queries.
IAggregationResult	Aggregation result.
IDateHistogramAggregationResult	Aggregation result created by DateHistogramAggregation.
IDateRangeAggregationResult	Aggregation result created by DateRangeAggregation.
IFieldAwareAggregation	An aggregation that is bound to a given field.
IGeoDistanceAggregationResult	Aggregation result generated by GeoDistanceAggregation.
IHistogramAggregationResult	Aggregation result created by HistogramAggregation.
IMultiBucketAggregation	Aggregation that generates multi bucket aggregation results.
IMultiBucketAggregationResult<T extends java.io.Serializable>	Aggregation result that aggregates the documents within multiple buckets, accordingly to the chosen aggregation type.
IMultiBucketAggregationResult.IBucket<T>	Represents a result bucket.
INestedObjectAggregationResult	A nested object aggregation result.
IReverseNestedAggregationResult	A reversed nested aggregation.
ISearchHit	An item of a ISearchResults object.
ISearchQueryFilter	A filter for a search query.
ISearchQuerySort	A search sort configuration.
ISearchResults	Represents a collection of hits returned by a query execution.
ISingleBucketAggregationResult	Aggregation result that is composed of a single (unnamed) bucket that holds all sub-aggregations.
ISizeAwareAggregation	Bucket aggregation that has a size configuration.
ISubAggregationAwareAggregation	Aggregation that holds sub-aggregations.
ISubAggregationAwareAggregationResult	An aggregation result that contains sub aggregations.
ITermsAggregationResult	Aggregation result generated by TermsAggregation.
IValueAggregationResult	Value aggregation result.

Class Summary

Class	Description
AbstractSubAggregationAwareAggregation	The abstract implementation of a part of aggregation with sub aggregations.
AutoCompleteSuggestionConfig	Auto complete suggestion configuration.
AvgAggregation	Aggregation that returns in a value bucket the average value for a given (numeric) field.
CardinalityAggregation	Aggregation that returns in a value bucket the unique value count for a given field.
DateHistogramAggregation	Date histogram aggregation.
DateHistogramAggregation.Interval	Date histogram interval.
DateRangeAggregation	Date range aggregation.
Distance	Represents a distance with an amount and a distance unit.
DocumentLocaleClause	Clause to filter documents by their locale.
FieldPresenceClause	ISearchQueryFilter that checks whether a given field is present or not, accordingly to the chosen operator. A field is present if a given document has it and it has a non-null value. The default operator is FieldPresenceClause.Operator.PRESENT.
FilterAggregation	Aggregation used to narrow down the current query document space.
GeoDistanceAggregation	Aggregation that aggregates the documents based on a center point and a collection of ranges. This aggregation produces a result of type IGeoDistanceAggregationResult.
GeoDistanceFilter	Filter that filter documents by their distance to a given center point.
GeoDistanceSearchQuerySort	Sort documents by the distance to a given point.
HighlightConfig	A search highlight configuration.
HistogramAggregation	Histogram aggregation.
MaxAggregation	Aggregation that returns in a value bucket the maximum value for a given (numeric) field.
MinAggregation	Aggregation that returns in a value bucket the minimum value for a given (numeric) field.
NestedObjectAggregation	This aggregation should be used mainly when some aggregations must be performed over fields inside a nested object field. In this case, the aggregations should be added as sub-aggregations of a nested object aggregation. For example, suppose we have a person document type with the following fields: name (text) address (nested object) street (keyword) number (keyword) And there are 3 documents in this document type: {"name": "Nara Jones"} {"name": "Albert Russef", "address": [{"street": "Av Rio Branco", "number": "23"}, {"street": "Av Francisco Bicalho"}]} {"name": "Josef Camus", "address": [{"street": "Av Presidente Vargas"}]} If a filter aggregation must be created with a filter to restrict the documents to those with the field address.number, and this filter aggregation has a terms aggregation as sub aggregation, the terms aggregation result will have the buckets Av Rio Branco and Av Francisco Bicalho, because, since there's no nested aggregation, both of them will be considered in filter aggregation.
NestedObjectFilter	Filter used to apply other filter in a single nested object.
NotFilter	A filter that negates the result of another filter.
Range<T extends java.lang.Comparable<T>>	Represents a range of values by having a from and a to value.
ReverseNestedAggregation	Reverse Nested Aggregation.
SearchFieldClause	A search query clause used by a searcher to search content.
SearchFilterGroup	Allows the creation of composite filters by grouping them together and using a logical operator to join them.
SearchQuery	Represents search criteria used to find matching information by a searcher.
SearchQuerySort	Search sort definition.
SumAggregation	Aggregation that returns in a value bucket the sum value for a given (numeric) field.
TermsAggregation	Aggregation that produces an ITermsAggregationResult.
ValueCountAggregation	Aggregation that returns in a value bucket the value count for a given field.

Enum Summary

Enum	Description
DateHistogramAggregation.Interval.Type	Interval type.
DistanceUnit	Distance units.
FieldPresenceClause.Operator	The available operators for this clause.
SearchFieldClause.Operator	Supported operators.
SearchFilterGroup.Operator	Supported grouping operators.
SearchQuerySort.Order	The sort orders.