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

Class AbstractStatement<E,SELF extends Statement<E,SELF>>

java.lang.Object

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

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.

All Implemented Interfaces:

Command, Statement<E,SELF>

Direct Known Subclasses:

AbstractModifyStatement, AbstractSelectStatement

public abstract class AbstractStatement<E,SELF extends Statement<E,SELF>>
extends Object
implements Statement<E,SELF>

This is the abstract base-implementation of Statement.

Since:

8.0.0

Author:

hohwille

Field Summary

Fields

Modifier and Type	Field and Description
private EntityAlias<?>	alias
private Map<String,EntityAlias<?>>	aliasMap
private SqlBuilder	builder
private SqlDialect	dialect
private Map<Class<? extends StatementFeature>,AbstractFeature>	featureMap
private Class<E>	resultClass

Constructor Summary

Constructors

Constructor and Description
AbstractStatement(SqlDialect dialect, EntityAlias<?> alias, Class<E> resultClass) The constructor.
AbstractStatement(SqlDialect dialect, EntityAlias<E> alias) The constructor.

Method Summary

Modifier and Type	Method and Description
void	addAlias(EntityAlias<?> entityAlias)
void	addAliases(EntityAlias<?>... aliases)
protected void	build(SqlBuilder sqlBuilder)
protected void	buildStart(SqlBuilder sqlBuilder)
protected <F extends AbstractFeature> F	createFeature(Class<F> featureClass)
protected SqlBuilder	createSqlBuilder()
protected <F extends AbstractFeature> F	feature(Class<F> featureClass)
EntityAlias<?>	getAlias()
protected SqlBuilder	getBuilder()
SqlDialect	getDialect()
protected <F extends AbstractFeature> F	getFeature(Class<F> featureClass)
List<Object>	getParameters()
protected Class<E>	getResultClass()
String	getSql()
boolean	isSupportingAlias()
protected SELF	self()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

dialect

private final SqlDialect dialect

alias

private final EntityAlias<?> alias

resultClass

private final Class<E> resultClass

featureMap

private final Map<Class<? extends StatementFeature>,AbstractFeature> featureMap

aliasMap

private final Map<String,EntityAlias<?>> aliasMap

builder

private SqlBuilder builder

Constructor Detail

AbstractStatement

public AbstractStatement(SqlDialect dialect,
                         EntityAlias<E> alias)

The constructor.

Parameters:

dialect - - see getDialect().

alias - - see getAlias().

AbstractStatement

public AbstractStatement(SqlDialect dialect,
                         EntityAlias<?> alias,
                         Class<E> resultClass)

The constructor.

Parameters:

dialect - - see getDialect().

alias - - see getAlias().

resultClass - - see getResultClass().

Method Detail

getDialect

public SqlDialect getDialect()

Specified by:

getDialect in interface Statement<E,SELF extends Statement<E,SELF>>

Returns:

the SqlDialect to use.

getAlias

public EntityAlias<?> getAlias()

Specified by:

getAlias in interface Statement<E,SELF extends Statement<E,SELF>>

Returns:

the EntityAlias to work on (select from, insert into, etc.). For regular Statements this will be EntityAlias<E> but for special queries such as tuple or constructor queries this is not bound to the generic <E>.

isSupportingAlias

public boolean isSupportingAlias()

Returns:

true if this Statement supports aliasing, false otherwise (if aliasing has to be omitted).

getResultClass

protected Class<E> getResultClass()

Returns:

the Class reflecting the result or destination of this Statement. For a regular Statement this is getAlias().getType() but e.g. for constructor queries this will the top-level class to return.

getFeature

protected <F extends AbstractFeature> F getFeature(Class<F> featureClass)

Type Parameters:

F - the generic type of the requested feature.

Parameters:

featureClass - the Class reflecting the requested feature.

Returns:

the requested feature or null if NOT yet created.

feature

protected <F extends AbstractFeature> F feature(Class<F> featureClass)

Type Parameters:

F - the generic type of the requested feature.

Parameters:

featureClass - the Class reflecting the requested feature.

Returns:

the requested feature.

createFeature

protected <F extends AbstractFeature> F createFeature(Class<F> featureClass)

Type Parameters:

F - the generic type of the feature.

Parameters:

featureClass - the Class reflecting the feature.

Returns:

a new instance of the specified feature.

self

protected SELF self()

Returns:

this query instance for fluent API calls.

getBuilder

protected SqlBuilder getBuilder()

Returns:

the SqlBuilder.

createSqlBuilder

protected SqlBuilder createSqlBuilder()

Returns:

a new instance of SqlContext.

buildStart

protected void buildStart(SqlBuilder sqlBuilder)

Parameters:

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

build

protected final void build(SqlBuilder sqlBuilder)

Parameters:

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

getParameters

public List<Object> getParameters()

Specified by:

getParameters in interface Statement<E,SELF extends Statement<E,SELF>>

Returns:

an unmodifiable List with the bind variables.

getSql

public String getSql()

Specified by:

getSql in interface Command

Specified by:

getSql in interface Statement<E,SELF extends Statement<E,SELF>>

Returns:

the current SQL String of this Statement. May only be an SQL fragment as the final operation such as FeatureFetch.fetch() will complete the statement. Has to be rebuild after every modification to the Statement.

toString

public String toString()

Specified by:

toString in interface Statement<E,SELF extends Statement<E,SELF>>

Overrides:

toString in class Object

Returns:

the same as Statement.getSql().

See Also:

Statement.getSql()

addAlias

public void addAlias(EntityAlias<?> entityAlias)

Parameters:

entityAlias - the EntityAlias to add.

addAliases

public void addAliases(EntityAlias<?>... aliases)

Parameters:

aliases - the EntityAliases to add.