Module io.github.mmm.orm

Package io.github.mmm.orm.statement

Class AbstractEntitiesClause<R,E extends EntityBean,SELF extends AbstractEntitiesClause<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>

io.github.mmm.orm.statement.AbstractEntitiesClause<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:

FromClause, UpdateClause

public abstract class AbstractEntitiesClause<R,E extends EntityBean,SELF extends AbstractEntitiesClause<R,E,SELF>>
extends AbstractEntityClause<R,E,SELF>

A AbstractEntitiesClause 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
static final String	NAME_ADDITIONAL_ENTITIES	Name of property AbstractEntityClause.getEntityName() for marshalling.

Fields inherited from class io.github.mmm.orm.statement.AbstractEntityClause

entity, NAME_ALIAS, NAME_ENTITY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SELF	and(EntityBean additionalEntity)
SELF	and(EntityBean additionalEntity, String alias)
protected SELF	and(EntitySubClause<?,?> entityFragment)
SELF	and(String entityName, EntityBean additionalEntity, String alias)
SELF	as(String entityAlias)
List<EntitySubClause<?,?>>	getAdditionalEntities()

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

getAlias, getAliasMap, getEntity, getEntityName, hasAlias, setEntityName

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_ADDITIONAL_ENTITIES

public static final String NAME_ADDITIONAL_ENTITIES

Name of property AbstractEntityClause.getEntityName() for marshalling.

See Also:

• Constant Field Values

Constructor Details

AbstractEntitiesClause

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

The constructor.

Parameters:

aliasMap - the aliasMap.

entity - the entity to operate on.

entityName - the entity name.

Method Details

and

public SELF and(EntityBean additionalEntity)

Parameters:

additionalEntity - the additional entity to access (similar to a JOIN).

Returns:

this DbClause itself for fluent API calls.

and

public SELF and(EntityBean additionalEntity,
 String alias)

Parameters:

additionalEntity - the additional entity to access (similar to a JOIN).

alias - the alias.

Returns:

this DbClause itself for fluent API calls.

and

public SELF and(String entityName,
 EntityBean additionalEntity,
 String alias)

Parameters:

entityName - the entity name.

additionalEntity - the additional entity to access (similar to a JOIN).

alias - the alias.

Returns:

this DbClause itself for fluent API calls.

and

protected SELF and(EntitySubClause<?,?> entityFragment)

Parameters:

entityFragment - the EntitySubClause to add.

Returns:

this DbClause itself for fluent API calls.

as

public SELF as(String entityAlias)

Overrides:

as in class AbstractEntityClause<R,E extends EntityBean,SELF extends AbstractEntitiesClause<R,E,SELF>>

Parameters:

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

Returns:

this DbClause itself for fluent API calls.

See Also:

• AbstractEntityClause.getAlias()

getAdditionalEntities

public List<EntitySubClause<?,?>> getAdditionalEntities()

Returns:

the List of EntitySubClauses in addition to the main entity.