Index
All Classes and Interfaces|All Packages|Serialized Form
B
- build() - Method in interface com.blazebit.query.spi.QueryContextBuilder
-
Builds a new
QueryContext
object based on the configuration provided by this builder.
C
- clear() - Method in interface com.blazebit.query.QuerySession
-
Clears the schema object data fetched by
DataFetcher
instances. - close() - Method in interface com.blazebit.query.QueryContext
-
Closes the QueryContext and all associated
QuerySession
to free up resources. - close() - Method in interface com.blazebit.query.QuerySession
-
Closes the QuerySession to free up resources.
- CollectionDataFormat - Interface in com.blazebit.query.spi
-
An object that describes the data format of a collection type.
- com.blazebit.query - package com.blazebit.query
-
Blaze-Query is a querying tool.
- com.blazebit.query.metamodel - package com.blazebit.query.metamodel
-
Blaze-Query metamodel.
- com.blazebit.query.spi - package com.blazebit.query.spi
-
SPI for implementers of the Blaze-Query API of extension providers.
- ConfigurationProvider - Interface in com.blazebit.query.spi
-
Provides access to configuration values in a lazy fashion.
- creatBuilder() - Method in interface com.blazebit.query.spi.QueryContextBuilderFactory
-
Returns a new
QueryContextBuilder
. - createEmptyQueryContextBuilder() - Static method in class com.blazebit.query.spi.Queries
-
Creates a new empty
QueryContextBuilder
. - createQuery(String) - Method in interface com.blazebit.query.QuerySession
-
Creates an executable query associated to this QuerySession.
- createQuery(String, Class<T>) - Method in interface com.blazebit.query.QuerySession
-
Creates an executable query associated to this QuerySession.
- createQuery(String, Class<T>, Map<String, Object>) - Method in interface com.blazebit.query.QuerySession
-
Creates an executable query associated to this QuerySession.
- createQuery(String, Map<String, Object>) - Method in interface com.blazebit.query.QuerySession
-
Creates an executable query associated to this QuerySession.
- createQueryContext() - Static method in class com.blazebit.query.spi.Queries
-
Creates a new
QueryContext
, based on default configuration. - createQueryContextBuilder() - Static method in class com.blazebit.query.spi.Queries
-
Creates a new
QueryContextBuilder
with all discoverable services loaded. - createSession() - Method in interface com.blazebit.query.QueryContext
-
Creates a new
QuerySession
with default configuration. - createSession(Map<String, Object>) - Method in interface com.blazebit.query.QueryContext
-
Creates a new
QuerySession
.
D
- DataFetchContext - Interface in com.blazebit.query.spi
-
The context object for
DataFetcher
invocations. - DataFetcher<T> - Interface in com.blazebit.query.spi
-
An object to fetch schema object data.
- DataFetcherConfig<T> - Interface in com.blazebit.query.spi
-
A config for
DataFetcher
. - DataFetcherException - Exception in com.blazebit.query.spi
-
Represents an exception that occurs during data fetching.
- DataFetcherException(String) - Constructor for exception com.blazebit.query.spi.DataFetcherException
-
Constructs a new DataFetcherException with the specified detail message.
- DataFetcherException(String, Throwable) - Constructor for exception com.blazebit.query.spi.DataFetcherException
-
Represents an exception that occurs during data fetching.
- DataFetcherException(String, Throwable, boolean, boolean) - Constructor for exception com.blazebit.query.spi.DataFetcherException
-
Constructs a new DataFetcherException with the specified detail message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.
- DataFetcherException(Throwable) - Constructor for exception com.blazebit.query.spi.DataFetcherException
-
Constructs a new DataFetcherException with the specified cause.
- DataFormat - Interface in com.blazebit.query.spi
-
An object that describes the data format of a type.
- DataFormatField - Interface in com.blazebit.query.spi
-
An object to fetch schema object data.
- DataFormatFieldAccessor - Interface in com.blazebit.query.spi
-
An accessor for a
DataFormatField
to access data.
E
- enumType(Type) - Static method in interface com.blazebit.query.spi.DataFormat
-
Returns a new enum data format for the given type.
F
- fetch(DataFetchContext) - Method in interface com.blazebit.query.spi.DataFetcher
-
Returns freshly fetched data for a schema object.
- fetch(DataFetchContext, int[][]) - Method in interface com.blazebit.query.spi.ProjectableDataFetcher
-
Returns freshly fetched data for a schema object.
- find(DataFetchContext) - Method in interface com.blazebit.query.spi.DataFetcherConfig
-
Returns the config value registered in the
DataFetchContext
ornull
if no value exists. - find(Class<T>) - Method in interface com.blazebit.query.metamodel.Metamodel
-
Returns the
SchemaObjectType
for the given class, ornull
if not found. - find(String) - Method in interface com.blazebit.query.metamodel.Metamodel
-
Returns the
SchemaObjectType
for the given class, ornull
if not found. - findAll(DataFetchContext) - Method in interface com.blazebit.query.spi.DataFetcherConfig
-
Returns the config value registered in the
DataFetchContext
ornull
if no value exists. - findProperty(String) - Method in interface com.blazebit.query.spi.DataFetchContext
-
Returns the value registered for the property in this DataFetchContext, or
null
if no value was found. - findSingleResult() - Method in interface com.blazebit.query.TypedQuery
-
Executes this query and returns a single result or
null
if no results were found. - forPropertyName(String) - Static method in interface com.blazebit.query.spi.DataFetcherConfig
-
Creates a new DataFetcherConfig object, that looks up a value in
DataFetchContext
by the given property name.
G
- get(DataFetchContext) - Method in interface com.blazebit.query.spi.DataFetcherConfig
-
Returns the config value registered in the
DataFetchContext
. - get(Class<T>) - Method in interface com.blazebit.query.metamodel.Metamodel
-
Returns the
SchemaObjectType
for the given class. - get(Class<T>) - Method in interface com.blazebit.query.QuerySession
-
Returns the schema object data for the given schema object type stored in this QuerySession, or
null
if there is none. - get(Object) - Method in interface com.blazebit.query.spi.DataFormatFieldAccessor
-
Returns the value for a field as accessed by this accessor.
- get(String) - Method in interface com.blazebit.query.metamodel.Metamodel
-
Returns the
SchemaObjectType
for the given class. - getAccessor() - Method in interface com.blazebit.query.spi.DataFormatField
-
Returns the accessor for the field.
- getAll(DataFetchContext) - Method in interface com.blazebit.query.spi.DataFetcherConfig
-
Returns the config value registered in the
DataFetchContext
ornull
if no value exists. - getContext() - Method in interface com.blazebit.query.QuerySession
-
Returns the
QueryContext
that created this QuerySession. - getDataFetcher() - Method in interface com.blazebit.query.metamodel.SchemaObjectType
-
Returns the data fetcher for the schema object.
- getDataFormat() - Method in interface com.blazebit.query.spi.DataFetcher
-
Returns the data format of the fetched data.
- getElementFormat() - Method in interface com.blazebit.query.spi.CollectionDataFormat
-
Returns the format of the collection element.
- getElementFormat() - Method in interface com.blazebit.query.spi.MapDataFormat
-
Returns the format of the map element.
- getFetchedSchemaObjectTypes() - Method in interface com.blazebit.query.QuerySession
-
Returns the schema object types for which data is stored in this QuerySession.
- getFields() - Method in interface com.blazebit.query.spi.DataFormat
-
Returns the fields encapsulated by this format.
- getFormat() - Method in interface com.blazebit.query.spi.DataFormatField
-
Returns the format of the field type.
- getKeyFormat() - Method in interface com.blazebit.query.spi.MapDataFormat
-
Returns the format of the map key.
- getMetamodel() - Method in interface com.blazebit.query.QueryContext
-
Returns the metamodel of this QueryContext.
- getName() - Method in interface com.blazebit.query.spi.DataFormatField
-
Returns the name of the field.
- getOrFetch(Class<T>) - Method in interface com.blazebit.query.QuerySession
-
Returns the schema object data for the given schema object type stored in this QuerySession, fetching and storing the data by calling the underlying
DataFetcher
if necessary. - getProperties() - Method in interface com.blazebit.query.Query
-
Returns the properties and hints and associated values that are in effect for the Query.
- getProperties() - Method in interface com.blazebit.query.QuerySession
-
Returns the properties and hints and associated values that are in effect for the QuerySession.
- getProperty(String) - Method in interface com.blazebit.query.spi.ConfigurationProvider
-
Returns a property value set for the property name, or
null
if no value was set. - getPropertyName() - Method in interface com.blazebit.query.spi.DataFetcherConfig
-
Returns the property name for the config.
- getPropertyProvider(String) - Method in interface com.blazebit.query.spi.ConfigurationProvider
-
Returns a property provider for the property name.
- getPropertyProvider(String) - Method in interface com.blazebit.query.spi.QueryContextBuilder
-
Returns the property provider for the property name.
- getQueryString() - Method in interface com.blazebit.query.Query
-
Returns the query string of this query.
- getQueryString() - Method in exception com.blazebit.query.QueryException
-
Returns the query string associated to this exception.
- getResultList() - Method in interface com.blazebit.query.TypedQuery
-
Executes this query and returns the query results.
- getResultStream() - Method in interface com.blazebit.query.TypedQuery
-
Executes this query and returns the query results as stream.
- getSession() - Method in interface com.blazebit.query.Query
-
Returns the associated
QuerySession
that created this Query. - getSession() - Method in interface com.blazebit.query.spi.DataFetchContext
-
Returns the current query session.
- getSingleResult() - Method in interface com.blazebit.query.TypedQuery
-
Executes this query and returns the query results.
- getType() - Method in interface com.blazebit.query.metamodel.SchemaObjectType
-
Returns the type of the schema object.
- getType() - Method in interface com.blazebit.query.spi.CollectionDataFormat
-
Returns the Java type for this format.
- getType() - Method in interface com.blazebit.query.spi.DataFormat
-
Returns the Java type for this format.
- getType() - Method in interface com.blazebit.query.spi.MapDataFormat
-
Returns the Java type for this format.
I
- isEnum() - Method in interface com.blazebit.query.spi.DataFormat
-
Returns whether this data format represents an enum.
- isOpen() - Method in interface com.blazebit.query.QueryContext
-
Returns whether the QueryContext is open.
- isOpen() - Method in interface com.blazebit.query.QuerySession
-
Determine whether the entity manager is open.
L
- loadServices() - Method in interface com.blazebit.query.spi.QueryContextBuilder
-
Loads the available services through the Java
ServiceLoader
API.
M
- MapDataFormat - Interface in com.blazebit.query.spi
-
An object that describes the data format of a map type.
- Metamodel - Interface in com.blazebit.query.metamodel
-
The metamodel of schema object types.
N
- NonUniqueResultException - Exception in com.blazebit.query
-
Thrown if a unique result was expected, but multiple results were found.
- NonUniqueResultException(String, String) - Constructor for exception com.blazebit.query.NonUniqueResultException
-
Creates a new NonUniqueResultException.
- NonUniqueResultException(String, Throwable, String) - Constructor for exception com.blazebit.query.NonUniqueResultException
-
Creates a new NonUniqueResultException.
- NoResultException - Exception in com.blazebit.query
-
Thrown if a unique result was expected, but no results were found.
- NoResultException(String, String) - Constructor for exception com.blazebit.query.NoResultException
-
Creates a new NoResultException.
- NoResultException(String, Throwable, String) - Constructor for exception com.blazebit.query.NoResultException
-
Creates a new NoResultException.
O
- of(Type, DataFormat) - Static method in interface com.blazebit.query.spi.CollectionDataFormat
-
Returns a new collection data format.
- of(Type, DataFormat, DataFormat) - Static method in interface com.blazebit.query.spi.MapDataFormat
-
Returns a new map data format.
- of(Type, List<DataFormatField>) - Static method in interface com.blazebit.query.spi.DataFormat
-
Returns a new data format for the given type and fields.
- of(String, DataFormatFieldAccessor, DataFormat) - Static method in interface com.blazebit.query.spi.DataFormatField
-
Creates a new data format field.
P
- ProjectableDataFetcher<T> - Interface in com.blazebit.query.spi
-
An object to fetch schema object data.
- PropertyProvider<X> - Interface in com.blazebit.query.spi
-
The PropertyProvider interface is a functional interface that provides an object based on the given DataFetchContext.
- provide(DataFetchContext) - Method in interface com.blazebit.query.spi.PropertyProvider
-
Provides the Object.
- put(Class<T>, List<? extends T>) - Method in interface com.blazebit.query.QuerySession
-
Stores the given schema objects for the given schema object type in this QuerySession and returns the previously stored schema object data stored, or
null
if there was none.
Q
- Queries - Class in com.blazebit.query.spi
-
Bootstrap class to obtain a
QueryContext
or builder for such. - Query - Interface in com.blazebit.query
-
An executable query to query data stored in the associated
QuerySession
. - QueryContext - Interface in com.blazebit.query
-
Context object for creating query sessions.
- QueryContextBuilder - Interface in com.blazebit.query.spi
-
Builder for the Blaze-Query
QueryContext
. - QueryContextBuilderFactory - Interface in com.blazebit.query.spi
-
Interface implemented by the Blaze-Query provider.
- QueryException - Exception in com.blazebit.query
-
Thrown if an exception during query execution occurs.
- QueryException(String, String) - Constructor for exception com.blazebit.query.QueryException
-
Creates a new QueryException.
- QueryException(String, Throwable, String) - Constructor for exception com.blazebit.query.QueryException
-
Creates a new QueryException.
- QuerySchemaProvider - Interface in com.blazebit.query.spi
-
A
ServiceLoader
SPI to provide schema objects. - QuerySession - Interface in com.blazebit.query
-
A session within which queries can be executed against schema object data.
R
- refresh(Class<T>) - Method in interface com.blazebit.query.QuerySession
-
Refreshes the schema object data for the given schema object type by fetching data again through the underlying
DataFetcher
. - registerSchemaObject(Class<T>, DataFetcher<T>) - Method in interface com.blazebit.query.spi.QueryContextBuilder
-
Registers the data fetcher for a schema object type.
- registerSchemaObjectAlias(Class<?>, String) - Method in interface com.blazebit.query.spi.QueryContextBuilder
-
Registers a fully qualified alias for a schema object type.
- registerSchemaProvider(QuerySchemaProvider) - Method in interface com.blazebit.query.spi.QueryContextBuilder
-
Registers a
QuerySchemaProvider
to provide schema objects. - remove(Class<T>) - Method in interface com.blazebit.query.QuerySession
-
Removes the schema objects for the given schema object type from this QuerySession and returns the previously stored schema object data stored, or
null
if there was none. - resolveSchemaObjects(ConfigurationProvider) - Method in interface com.blazebit.query.spi.QuerySchemaProvider
-
Resolves the schema objects based on a configuration provider.
S
- SchemaObjectType<T> - Interface in com.blazebit.query.metamodel
-
A schema object type.
- setParameter(int, Object) - Method in interface com.blazebit.query.Query
-
Sets a value for the 1-based positional query parameter at the given position.
- setParameter(int, Object) - Method in interface com.blazebit.query.TypedQuery
-
Sets a value for the 1-based positional query parameter at the given position.
- setProperty(String, Object) - Method in interface com.blazebit.query.Query
-
Set a
Query
property or hint. - setProperty(String, Object) - Method in interface com.blazebit.query.QuerySession
-
Set a
QuerySession
property or hint. - setProperty(String, Object) - Method in interface com.blazebit.query.spi.QueryContextBuilder
-
Constructs a property provider for the value and registers it via
QueryContextBuilder.setPropertyProvider(String, PropertyProvider)
. - setPropertyProvider(String, PropertyProvider<?>) - Method in interface com.blazebit.query.spi.QueryContextBuilder
-
Sets the given supplier as value provider for the given property name.
T
- TypedQuery<T> - Interface in com.blazebit.query
-
An executable query to query data stored in the associated
QuerySession
. - types() - Method in interface com.blazebit.query.metamodel.Metamodel
-
Returns the schema object types.
U
- unwrap(Class<T>) - Method in interface com.blazebit.query.Query
-
Return an object of the specified type to allow access to the provider-specific API.
- unwrap(Class<T>) - Method in interface com.blazebit.query.QueryContext
-
Return an object of the specified type to allow access to the provider-specific API.
- unwrap(Class<T>) - Method in interface com.blazebit.query.QuerySession
-
Return an object of the specified type to allow access to the provider-specific API.
All Classes and Interfaces|All Packages|Serialized Form