Module io.github.mmm.entity.bean

Package io.github.mmm.entity.bean.sql

Class AbstractEntitiesClause<E extends EntityBean,SELF extends AbstractEntitiesClause<E,SELF>>

java.lang.Object

io.github.mmm.marshall.AbstractMarshallingObject

io.github.mmm.entity.bean.sql.AbstractClause

io.github.mmm.entity.bean.sql.AbstractTypedClause<E,SELF>

io.github.mmm.entity.bean.sql.AbstractEntityClause<E,SELF>

io.github.mmm.entity.bean.sql.AbstractEntitiesClause<E,SELF>

Type Parameters:

E - type of the entity.

SELF - type of this class itself.

All Implemented Interfaces:

Clause, TypedClause<E>, io.github.mmm.marshall.MarshallableObject, io.github.mmm.marshall.Marshaller<Object>, io.github.mmm.marshall.Marshalling<Object>, io.github.mmm.marshall.MarshallingObject, io.github.mmm.marshall.UnmarshallableObject, io.github.mmm.marshall.Unmarshaller<Object>

Direct Known Subclasses:

From

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

A AbstractEntitiesClause is a Clause of an SQL Statement 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 String	NAME_ADDITIONAL_ENTITIES	Name of property AbstractEntityClause.getEntityName() for marshalling.

Fields inherited from class io.github.mmm.entity.bean.sql.AbstractEntityClause

entity, NAME_ALIAS, NAME_ENTITY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntitiesClause(E entity)	The constructor.
protected	AbstractEntitiesClause(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)
List<EntitySubClause<?>>	getAdditionalEntities()
protected void	readProperty(io.github.mmm.marshall.StructuredReader reader, String name)
protected void	writeProperties(io.github.mmm.marshall.StructuredWriter writer)

Methods inherited from class io.github.mmm.entity.bean.sql.AbstractEntityClause

as, getAlias, getEntity, getEntityName, setEntityName

Methods inherited from class io.github.mmm.entity.bean.sql.AbstractTypedClause

self

Methods inherited from class io.github.mmm.entity.bean.sql.AbstractClause

getMarshallingName, toString

Methods inherited from class io.github.mmm.marshall.AbstractMarshallingObject

read, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.mmm.entity.bean.sql.Clause

isOmit

Methods inherited from interface io.github.mmm.marshall.MarshallableObject

write, writeObject

Methods inherited from interface io.github.mmm.marshall.UnmarshallableObject

read, readObject

Field Detail

NAME_ADDITIONAL_ENTITIES

public static final String NAME_ADDITIONAL_ENTITIES

Name of property AbstractEntityClause.getEntityName() for marshalling.

See Also:

Constant Field Values

Constructor Detail

AbstractEntitiesClause

protected AbstractEntitiesClause(E entity)

The constructor.

Parameters:

entity - the entity.

AbstractEntitiesClause

protected AbstractEntitiesClause(E entity,
                                 String entityName)

The constructor.

Parameters:

entity - the entity to operate on.

entityName - the entity name.

Method Detail

and

public SELF and(EntityBean additionalEntity)

Parameters:

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

Returns:

this Clause 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 Clause 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 Clause itself for fluent API calls.

and

protected SELF and(EntitySubClause<?> entityFragment)

Parameters:

entityFragment - the EntitySubClause to add.

Returns:

this Clause itself for fluent API calls.

getAdditionalEntities

public List<EntitySubClause<?>> getAdditionalEntities()

Returns:

the List of EntitySubClauses in addition to the main entity.

writeProperties

protected void writeProperties(io.github.mmm.marshall.StructuredWriter writer)

Overrides:

writeProperties in class AbstractEntityClause<E extends EntityBean,SELF extends AbstractEntitiesClause<E,SELF>>

readProperty

protected void readProperty(io.github.mmm.marshall.StructuredReader reader,
                            String name)

Overrides:

readProperty in class AbstractEntityClause<E extends EntityBean,SELF extends AbstractEntitiesClause<E,SELF>>