org.locationtech.geowave.core.geotime.store.query.api

Interface VectorAggregationQueryBuilder<P extends Persistable,R>

Type Parameters:

P - the type for input parameters

R - the result type

All Superinterfaces:

AggregationQueryBuilder<P,R,org.opengis.feature.simple.SimpleFeature,VectorAggregationQueryBuilder<P,R>>, BaseQueryBuilder<R,AggregationQuery<P,R,org.opengis.feature.simple.SimpleFeature>,VectorAggregationQueryBuilder<P,R>>, BaseVectorQueryBuilder<R,AggregationQuery<P,R,org.opengis.feature.simple.SimpleFeature>,VectorAggregationQueryBuilder<P,R>>

All Known Implementing Classes:

VectorAggregationQueryBuilderImpl

public interface VectorAggregationQueryBuilder<P extends Persistable,R>
extends AggregationQueryBuilder<P,R,org.opengis.feature.simple.SimpleFeature,VectorAggregationQueryBuilder<P,R>>, BaseVectorQueryBuilder<R,AggregationQuery<P,R,org.opengis.feature.simple.SimpleFeature>,VectorAggregationQueryBuilder<P,R>>

An aggregation query builder particular for vector data. This should be preferentially used to build AggregationQuery's for SimpleFeature data.

Method Summary

Modifier and Type	Method and Description
VectorAggregationQueryBuilder<P,R>	bboxOfResults(String... typeNames) Convenience method for getting a bounding box of the results of a query.
VectorAggregationQueryBuilder<P,R>	bboxOfResultsForGeometryField(String typeName, String geomAttributeName) Convenience method for getting a bounding box of the results of a query.
default VectorQueryConstraintsFactory	constraintsFactory()
static <P extends Persistable,R> VectorAggregationQueryBuilder<P,R>	newBuilder() get a default implementation of this builder
VectorAggregationQueryBuilder<P,R>	timeRangeOfResults(String... typeNames) Convenience method for getting a time range of the results of a query.
VectorAggregationQueryBuilder<P,R>	timeRangeOfResultsForTimeField(String typeName, String timeAttributeName) Convenience method for getting a time range of the results of a query.

Methods inherited from interface org.locationtech.geowave.core.store.api.AggregationQueryBuilder

aggregate, buildWithBinningStrategy, count

Methods inherited from interface org.locationtech.geowave.core.store.query.BaseQueryBuilder

addAuthorization, addHint, allIndices, build, constraints, filter, indexName, limit, noAuthorizations, noHints, noLimit, setAuthorizations

Method Detail

constraintsFactory

default VectorQueryConstraintsFactory constraintsFactory()

Specified by:

constraintsFactory in interface BaseQueryBuilder<R,AggregationQuery<P extends Persistable,R,org.opengis.feature.simple.SimpleFeature>,VectorAggregationQueryBuilder<P extends Persistable,R>>

newBuilder

static <P extends Persistable,R> VectorAggregationQueryBuilder<P,R> newBuilder()

get a default implementation of this builder

Specified by:

newBuilder in interface AggregationQueryBuilder<P extends Persistable,R,org.opengis.feature.simple.SimpleFeature,VectorAggregationQueryBuilder<P extends Persistable,R>>

Returns:

the builder

bboxOfResults

VectorAggregationQueryBuilder<P,R> bboxOfResults(String... typeNames)

Convenience method for getting a bounding box of the results of a query. It uses the default geometry for a feature type which is also the indexed geometry.

Parameters:

typeNames - the type names to constrain by

Returns:

this builder

bboxOfResultsForGeometryField

VectorAggregationQueryBuilder<P,R> bboxOfResultsForGeometryField(String typeName,
                                                                 String geomAttributeName)

Convenience method for getting a bounding box of the results of a query. This can be particularly useful if you want to calculate the bbox on a different field than the default/indexed Geometry.

Parameters:

typeName - the type name

geomAttributeName - the geometry attribute name

Returns:

this builder

timeRangeOfResults

VectorAggregationQueryBuilder<P,R> timeRangeOfResults(String... typeNames)

Convenience method for getting a time range of the results of a query. This has to use inferred or hinted temporal attribute names.

Parameters:

typeNames - the type names to constrain by

Returns:

this builder

timeRangeOfResultsForTimeField

VectorAggregationQueryBuilder<P,R> timeRangeOfResultsForTimeField(String typeName,
                                                                  String timeAttributeName)

Convenience method for getting a time range of the results of a query. This can be particularly useful if you want to calculate the time range on a specific time field.

Parameters:

typeName - the type names to constrain by

timeAttributeName - the time attribute name

Returns:

this builder