Module io.github.mmm.orm

Package io.github.mmm.orm.statement

Class AbstractEntityClause<R,E extends io.github.mmm.entity.bean.EntityBean,SELF extends AbstractEntityClause<R,E,SELF>>

java.lang.Object

io.github.mmm.orm.statement.AbstractDbClause

io.github.mmm.orm.statement.AbstractTypedClause<R,SELF>

io.github.mmm.orm.statement.AbstractEntityClause<R,E,SELF>

Type Parameters:

R - type of the result. Only different from <E> for complex selects.

E - type of the entity.

SELF - type of this class itself.

All Implemented Interfaces:

DbClause, TypedClause<R>

Direct Known Subclasses:

AbstractEntitiesClause, CreateIndexOnClause, CreateTableClause, EntitySubClause, IntoClause

public abstract class AbstractEntityClause<R,E extends io.github.mmm.entity.bean.EntityBean,SELF extends AbstractEntityClause<R,E,SELF>>
extends AbstractTypedClause<R,SELF>

A AbstractEntityClause is a DbClause of an SQL DbStatement that specifies the entity and/or entity name (table) to operate on.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected E	entity
static final String	NAME_ALIAS	Name of property alias for marshaling.
static final String	NAME_ENTITY	Name of property getEntityName() for marshalling.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntityClause(AliasMap aliasMap, E entity, String entityName)	The constructor.

Method Summary

Modifier and Type	Method	Description
SELF	as(String entityAlias)
String	getAlias()
protected AliasMap	getAliasMap()
E	getEntity()
String	getEntityName()
boolean	hasAlias()
protected void	setEntityName(String entityName)

Methods inherited from class io.github.mmm.orm.statement.AbstractTypedClause

self

Methods inherited from class io.github.mmm.orm.statement.AbstractDbClause

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.mmm.orm.statement.DbClause

isOmit

Field Details

NAME_ENTITY

public static final String NAME_ENTITY

Name of property getEntityName() for marshalling.

See Also:

• Constant Field Values

NAME_ALIAS

public static final String NAME_ALIAS

Name of property alias for marshaling.

See Also:

• Constant Field Values

entity

protected transient E extends io.github.mmm.entity.bean.EntityBean entity

See Also:

• getEntityName()

Constructor Details

AbstractEntityClause

protected AbstractEntityClause(AliasMap aliasMap,
 E entity,
 String entityName)

The constructor.

Parameters:

aliasMap - the AliasMap.

entity - the entity to operate on.

entityName - the entity name.

Method Details

getAliasMap

protected AliasMap getAliasMap()

Returns:

the Map to map from alias to entity. A single Map instance is used per DbStatement to ensure unique aliases.

getEntity

public E getEntity()

Returns:

the optional EntityBean from where to get the data and to operate on.

getEntityName

public String getEntityName()

Returns:

the name of the entity in the database (e.g. table name).

setEntityName

protected void setEntityName(String entityName)

Parameters:

entityName - new value of getEntityName().

getAlias

public String getAlias()

Returns:

alias the alias (variable name) for the EntityBean to query. Will be created lazily if not already created.

See Also:

• as(String)

hasAlias

public boolean hasAlias()

Returns:

true if an alias has already been assigned or created, false otherwise.

as

public SELF as(String entityAlias)

Parameters:

entityAlias - the alias (variable name) for the EntityBean to query.

Returns:

this DbClause itself for fluent API calls.

See Also:

• getAlias()