Module io.github.mmm.entity.bean

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

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

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:

AbstractEntitiesClause, EntitySubClause, Into, Update

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

A AbstractEntityClause 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
protected E	entity
static String	NAME_ALIAS	Name of property alias for marshaling.
static String	NAME_ENTITY	Name of property getEntityName() for marshalling.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SELF	as(String entityAlias)
String	getAlias()
E	getEntity()
String	getEntityName()
protected void	readProperty(io.github.mmm.marshall.StructuredReader reader, String name)
void	setEntityName(String entityName)
protected void	writeProperties(io.github.mmm.marshall.StructuredWriter writer)

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_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 final transient E extends EntityBean entity

See Also:

getEntityName()

Constructor Detail

AbstractEntityClause

protected AbstractEntityClause(E entity)

The constructor.

Parameters:

entity - the entity.

AbstractEntityClause

protected AbstractEntityClause(E entity,
                               String entityName)

The constructor.

Parameters:

entity - the entity to operate on.

entityName - the entity name.

Method Detail

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

public 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.

See Also:

as(String)

as

public SELF as(String entityAlias)

Parameters:

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

Returns:

this Clause itself for fluent API calls.

See Also:

getAlias()

writeProperties

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

Overrides:

writeProperties in class AbstractClause

readProperty

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

Overrides:

readProperty in class AbstractClause