Package sonia.scm.store

Interface QueryableStore<T>

Type Parameters:

T - The type of the objects to query.

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

QueryableMutableStore<T>

public interface QueryableStore<T>
extends AutoCloseable

This interface is used to query objects annotated with QueryableType. It will be created by the QueryableStoreFactory.
It is not meant to be instantiated by users of the API. Instead, use the query factory created by the annotation processor for the annotated type.

Since:

3.8.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	QueryableStore.AggregatableNumberQueryField<T,A>	Query fields implementing this can compute aggregates like sum or average.
static interface	QueryableStore.AggregatableQueryField<T,A>	Query fields implementing this can compute aggregates like minimum or maximum.
static class	QueryableStore.BaseQueryField<T,F>
static class	QueryableStore.BooleanQueryField<T>	This class is used to create conditions for queries.
static class	QueryableStore.CollectionQueryField<T>	This class is used to create conditions for queries.
static class	QueryableStore.CollectionSizeQueryField<T>	This class is used to create conditions for queries, based on the size of a collection.
static class	QueryableStore.DoubleQueryField<T>
static class	QueryableStore.EnumQueryField<T,E extends Enum<E>>	This class is used to create conditions for queries.
static class	QueryableStore.FloatQueryField<T>
static class	QueryableStore.IdQueryField<T>	This class is used to create conditions for queries.
static class	QueryableStore.InstantQueryField<T>	This class is used to create conditions for queries.
static class	QueryableStore.IntegerQueryField<T>
static class	QueryableStore.LongQueryField<T>
static class	QueryableStore.MapQueryField<T>	This class is used to create conditions for queries.
static class	QueryableStore.MapSizeQueryField<T>	This class is used to create conditions for queries, based on the size of a map.
static class	QueryableStore.NumberQueryField<T,N extends Number>	This class is used to create conditions for queries.
static enum	QueryableStore.Order	Used to specify the order of the result of a query.
static interface	QueryableStore.Query<T,T_RESULT>	The terminal interface for a query build by query(Condition[]).
static interface	QueryableStore.QueryField<T,F>	Instances of this class will be created by the annotation processor for each class annotated with QueryableType.
static interface	QueryableStore.Result<T>	The result of a query that was built by QueryableStore.Query.withIds().
static class	QueryableStore.StringQueryField<T>	This class is used to create conditions for queries.
static class	QueryableStore.TooManyResultsException	An exception occurring, if the client queried for one result with QueryableStore.Query.findOne(), but the query returned multiple results.

Method Summary

Modifier and Type	Method	Description
QueryableStore.Query<T,T>	query(Condition<T>... conditions)	Creates a query for the objects of the type T with the given conditions.

Methods inherited from interface java.lang.AutoCloseable

close

Method Details

query

QueryableStore.Query<T,T> query(Condition<T>... conditions)

Creates a query for the objects of the type T with the given conditions. Conditions should be created by either using the static methods of the Conditions class or by using the query fields of the type T that will be created by the annotation processor in a separate class. If your annotated type is named MyType, the query fields class will be named MyTypeQueryFields.
If no conditions are given, all objects of the type T will be returned (limited by the ids of the parent objects that had been specified when this instance of the store had been created by the factory). If more than one condition is given, the conditions will be combined with a logical AND.

Parameters:

conditions - The conditions to filter the objects.

Returns:

The query object to retrieve the result.