net.sf.mmm.util.query.base.statement

Class AbstractSelectStatement<E,SELF extends SelectStatement<E,SELF>,T>

java.lang.Object

net.sf.mmm.util.query.base.statement.AbstractStatement<E,SELF>

net.sf.mmm.util.query.base.statement.AbstractSelectStatement<E,SELF,T>

Type Parameters:

E - the generic type of the queried object (typically a Bean).

SELF - the generic type of this query itself (this) for fluent API calls.

T - the generic type of the internal results. See getMapper().

All Implemented Interfaces:

Command, FeatureFetch<E>, FeatureGroupBy<SELF>, FeatureLimit<SELF>, FeatureOrderBy<SELF>, FeaturePaging<SELF>, FeatureWhere<SELF>, StatementFeature, SelectStatement<E,SELF>, Statement<E,SELF>

Direct Known Subclasses:

JpqlSelectStatementImpl, OrientDbSelectStatementImpl

public abstract class AbstractSelectStatement<E,SELF extends SelectStatement<E,SELF>,T>
extends AbstractStatement<E,SELF>
implements SelectStatement<E,SELF>

This is the abstract base-implementation of SelectStatement.

Since:

8.0.0

Author:

hohwille

Field Summary

Fields

Modifier and Type	Field and Description
private Function<T,E>	mapper
private PropertyPath<?>[]	selectionPaths

Constructor Summary

Constructors

Constructor and Description
AbstractSelectStatement(SqlDialect dialect, EntityAlias<?> alias, Function<T,E> mapper, Class<E> toClass, PropertyPath<?>... constructorArgs) The constructor.
AbstractSelectStatement(SqlDialect dialect, EntityAlias<?> alias, Function<T,E> mapper, PropertyPath<?>... paths) The constructor.
AbstractSelectStatement(SqlDialect dialect, EntityAlias<E> alias, Function<T,E> mapper) The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	buildStart(SqlBuilder builder)
protected String	createSqlSingleQuery(QueryMode mode)
protected abstract Object	doExecute(String sql, QueryMode mode, Long offset, Integer limit) Creates a select query with the given SQL and the given arguments.
Object	execute(String sql, QueryMode mode) Creates a select query with the given SQL and the given QueryMode.
Function<T,E>	getMapper()
PropertyPath<?>[]	getSelectionPaths()
SELF	groupBy(PropertyPath<?> path) Adds the given PropertyPath to the GROUP BY clause.
SELF	limit(int limit) Set the limit for the query matches.
SELF	offset(long offset) Set the offset for the query results.
SELF	orderBy(ComparablePath<?> path, SortOrder order) Adds the given PropertyPath to the ORDER BY clause.
ListQuery<E>	query()
NumberQuery<Long>	queryCount()
SingleQuery<E>	queryFirst()
SingleQuery<E>	queryOne()
protected SingleQuery<E>	querySingle(QueryMode mode)
SELF	where(Expression... expressions) Adds the given Expressions as filter criteria to the WHERE-clause.

Methods inherited from class net.sf.mmm.util.query.base.statement.AbstractStatement

addAlias, addAliases, build, createFeature, createSqlBuilder, feature, getAlias, getBuilder, getDialect, getFeature, getParameters, getResultClass, getSql, isSupportingAlias, self, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.mmm.util.query.api.statement.Statement

getAlias, getDialect, getParameters, getSql, toString

Methods inherited from interface net.sf.mmm.util.query.api.feature.FeatureFetch

fetch, fetchCount, fetchFirst, fetchFirstRequired, fetchOne, fetchOneRequired

Methods inherited from interface net.sf.mmm.util.query.api.feature.FeatureOrderBy

orderBy

Field Detail

selectionPaths

private final PropertyPath<?>[] selectionPaths

mapper

private final Function<T,E> mapper

Constructor Detail

AbstractSelectStatement

public AbstractSelectStatement(SqlDialect dialect,
                               EntityAlias<E> alias,
                               Function<T,E> mapper)

The constructor.

Parameters:

dialect - - see AbstractStatement.getDialect().

alias - - see AbstractStatement.getAlias().

mapper - - see getMapper().

AbstractSelectStatement

public AbstractSelectStatement(SqlDialect dialect,
                               EntityAlias<?> alias,
                               Function<T,E> mapper,
                               PropertyPath<?>... paths)

The constructor.

Parameters:

dialect - - see AbstractStatement.getDialect().

alias - - see AbstractStatement.getAlias().

mapper - - see getMapper().

paths - - see FeatureSelect.selectFrom(EntityAlias, Class, PropertyPath...) .

AbstractSelectStatement

public AbstractSelectStatement(SqlDialect dialect,
                               EntityAlias<?> alias,
                               Function<T,E> mapper,
                               Class<E> toClass,
                               PropertyPath<?>... constructorArgs)

The constructor.

Parameters:

dialect - - see AbstractStatement.getDialect().

alias - - see AbstractStatement.getAlias().

mapper - - see getMapper().

toClass - - see net.sf.mmm.util.query.api.statement.StatementFactory#selectFrom(EntityAlias, Class, Path...).

constructorArgs - - see net.sf.mmm.util.query.api.statement.StatementFactory#selectFrom(EntityAlias, Class, Path...).

Method Detail

getMapper

public Function<T,E> getMapper()

Returns:

the Function to map the original query results to the external result type. May be null for the identity function if <T>=<E>.

getSelectionPaths

public PropertyPath<?>[] getSelectionPaths()

Returns:

the selectionPaths for tuple or constructor queries or null for regular select query

where

public SELF where(Expression... expressions)

Description copied from interface: FeatureWhere

Adds the given Expressions as filter criteria to the WHERE-clause. Multiple invocations will combine Expressions with logical AND but it is preferred to use a single invocation.

Specified by:

where in interface FeatureWhere<SELF extends SelectStatement<E,SELF>>

Parameters:

expressions - the Expressions to add.

Returns:

this query instance for fluent API calls.

orderBy

public SELF orderBy(ComparablePath<?> path,
                    SortOrder order)

Description copied from interface: FeatureOrderBy

Adds the given PropertyPath to the ORDER BY clause.

Specified by:

orderBy in interface FeatureOrderBy<SELF extends SelectStatement<E,SELF>>

Parameters:

path - the PropertyPath to order by.

order - the SortOrder.

Returns:

this query instance for fluent API calls.

groupBy

public SELF groupBy(PropertyPath<?> path)

Description copied from interface: FeatureGroupBy

Adds the given PropertyPath to the GROUP BY clause.

Specified by:

groupBy in interface FeatureGroupBy<SELF extends SelectStatement<E,SELF>>

Parameters:

path - the PropertyPath to group by.

Returns:

this query instance for fluent API calls.

limit

public SELF limit(int limit)

Description copied from interface: FeatureLimit

Set the limit for the query matches. Should be called only once per query.

Specified by:

limit in interface FeatureLimit<SELF extends SelectStatement<E,SELF>>

Parameters:

limit - the limit for the maximum number of matches for the query.

Returns:

this query instance for fluent API calls.

offset

public SELF offset(long offset)

Description copied from interface: FeaturePaging

Set the offset for the query results. Should be called only once per query. The offset is useful for paging results in combination with FeatureLimit.limit(int)).

Specified by:

offset in interface FeaturePaging<SELF extends SelectStatement<E,SELF>>

Parameters:

offset - the number of results to skip.

Returns:

this query instance for fluent API calls.

buildStart

protected void buildStart(SqlBuilder builder)

Overrides:

buildStart in class AbstractStatement<E,SELF extends SelectStatement<E,SELF>>

Parameters:

builder - the SqlBuilder with the query context to build the SQL and bind variables.

execute

public Object execute(String sql,
                      QueryMode mode)

Creates a select query with the given SQL and the given QueryMode.

Parameters:

sql - the SQL to execute.

mode - the QueryMode.

Returns:

the result of the SQL execution.

doExecute

protected abstract Object doExecute(String sql,
                                    QueryMode mode,
                                    Long offset,
                                    Integer limit)

Creates a select query with the given SQL and the given arguments.

Parameters:

sql - the SQL to execute.

mode - the QueryMode.

offset - the offset.

limit - the limit.

Returns:

the result of the SQL execution.

query

public ListQuery<E> query()

Specified by:

query in interface FeatureFetch<E>

Returns:

a ListQuery to fetch all matching results with a regular SELECT.

queryCount

public NumberQuery<Long> queryCount()

Specified by:

queryCount in interface FeatureFetch<E>

Returns:

a NumberQuery to fetch the number of matching objects with a SELECT COUNT.

querySingle

protected SingleQuery<E> querySingle(QueryMode mode)

Parameters:

mode - the QueryMode.

Returns:

the SingleQuery.

See Also:

queryFirst(), queryOne()

createSqlSingleQuery

protected String createSqlSingleQuery(QueryMode mode)

Parameters:

mode - the QueryMode for a single SELECT query what is QueryMode.FIRST or QueryMode.UNIQUE.

Returns:

the complete SQL for a single query.

queryFirst

public SingleQuery<E> queryFirst()

Specified by:

queryFirst in interface FeatureFetch<E>

Returns:

a SingleQuery to fetch the first matching results with a SELECT.

queryOne

public SingleQuery<E> queryOne()

Specified by:

queryOne in interface FeatureFetch<E>

Returns:

a SingleQuery to fetch a single unique matching result with a SELECT. The Query execution will fail with an exception if it matches multiple result objects. It can only have a single or an empty (null) result.