Module io.github.mmm.entity.bean

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

Class SqlFormatter

java.lang.Object

io.github.mmm.entity.bean.sql.SqlFormatter

All Implemented Interfaces:

ClauseVisitor

public class SqlFormatter
extends Object
implements ClauseVisitor

Formatter to format a Clause or Statement to SQL.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
SqlFormatter(io.github.mmm.property.criteria.CriteriaSqlFormatter criteriaFormatter)	The constructor.

Method Summary

Modifier and Type	Method	Description
io.github.mmm.property.criteria.CriteriaSqlFormatter	getCriteriaFormatter()
boolean	isSelectAllByAlias()
boolean	isUseAsBeforeAlias()
protected void	onAdditionalEntity(EntitySubClause<?> entity)
protected void	onAlias(String alias, Clause clause)
SqlFormatter	onClause(Clause clause)
void	onColumns(CreateIndexColumns<?> columns)
void	onColumns(CreateTableColumns<?> columns)
protected void	onCreateColumn(io.github.mmm.property.ReadableProperty<?> column)
void	onCreateTable(CreateTable<?> createTable)
void	onDelete(Delete delete)
protected void	onEntities(AbstractEntitiesClause<?,?> entities)
protected void	onEntity(AbstractEntityClause<?,?> entity)
void	onFrom(From<?,?> from)
void	onInsert(Insert insert)
void	onInto(Into<?,?> into)
void	onOrderBy(OrderBy<?> orderBy)
void	onSelect(Select select)
protected void	onSelectAll(SelectFrom<?> selectFrom)
protected void	onSelections(Select select, SelectFrom<?> selectFrom)
void	onSet(Set<?,?> set)
SqlFormatter	onStatement(Statement<?> statement)
protected void	onType(Class<?> valueClass)
void	onUpdate(Update<?> update)
void	onUpsert(Upsert upsert)
void	onValues(Values<?,?> values)
void	onWhere(Where<?,?> where)
protected io.github.mmm.base.io.AppendableWriter	out()
void	setSelectAllByAlias(boolean selectAllByAlias)
void	setUseAsbeforeAlias(boolean useAsbeforeAlias)
String	toString()
protected void	write(String text)

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

onCreateIndex, onGroupBy, onHaving, onMainClause, onMerge, onOtherClause, onStart

Constructor Detail

SqlFormatter

public SqlFormatter(io.github.mmm.property.criteria.CriteriaSqlFormatter criteriaFormatter)

The constructor.

Parameters:

criteriaFormatter - the CriteriaSqlFormatter used to format criteria fragments to SQL.

Method Detail

getCriteriaFormatter

public io.github.mmm.property.criteria.CriteriaSqlFormatter getCriteriaFormatter()

Returns:

the CriteriaSqlFormatter used to format criteria fragments to SQL.

write

protected void write(String text)

Parameters:

text - the SQL to append.

out

protected io.github.mmm.base.io.AppendableWriter out()

Returns:

the AppendableWriter wrapping the Appendable to write to.

onStatement

public SqlFormatter onStatement(Statement<?> statement)

Parameters:

statement - the Statement to format to SQL.

Returns:

this SqlFormatter for fluent API calls.

onClause

public SqlFormatter onClause(Clause clause)

Specified by:

onClause in interface ClauseVisitor

Parameters:

clause - the Clause to visit.

Returns:

this ClauseVisitor itself for fluent API calls.

onSelect

public void onSelect(Select select)

Specified by:

onSelect in interface ClauseVisitor

Parameters:

select - the Select-Clause to visit.

onDelete

public void onDelete(Delete delete)

Specified by:

onDelete in interface ClauseVisitor

Parameters:

delete - the Delete-Clause to visit.

onInsert

public void onInsert(Insert insert)

Specified by:

onInsert in interface ClauseVisitor

Parameters:

insert - the Insert-Clause to visit.

onUpdate

public void onUpdate(Update<?> update)

Specified by:

onUpdate in interface ClauseVisitor

Parameters:

update - the Update-Clause to visit.

onUpsert

public void onUpsert(Upsert upsert)

Specified by:

onUpsert in interface ClauseVisitor

Parameters:

upsert - the Upsert-Clause to visit.

onCreateTable

public void onCreateTable(CreateTable<?> createTable)

Specified by:

onCreateTable in interface ClauseVisitor

Parameters:

createTable - the CreateTable-Clause to visit.

onSelections

protected void onSelections(Select select,
                            SelectFrom<?> selectFrom)

Parameters:

select - the Select with the selections.

selectFrom - the SelectFrom.

isSelectAllByAlias

public boolean isSelectAllByAlias()

Returns:

true if a Select of all properties should happen via alias, false otherwise (to simply use *). The default is false. Override to change. E.g. in JPQL you would write "SELECT a FROM Entity a ..." whereas in plain SQL you would write "SELECT * FROM Entity ..."

setSelectAllByAlias

public void setSelectAllByAlias(boolean selectAllByAlias)

Parameters:

selectAllByAlias - new value of isSelectAllByAlias().

isUseAsBeforeAlias

public boolean isUseAsBeforeAlias()

Returns:

true to use the AS keyword before an alias (e.g. "FROM Entity AS e"), false otherwise.

setUseAsbeforeAlias

public void setUseAsbeforeAlias(boolean useAsbeforeAlias)

Parameters:

useAsbeforeAlias - new value of isUseAsBeforeAlias().

onSelectAll

protected void onSelectAll(SelectFrom<?> selectFrom)

Parameters:

selectFrom - the SelectFrom giving access to the alias.

onFrom

public void onFrom(From<?,?> from)

Specified by:

onFrom in interface ClauseVisitor

Parameters:

from - the From-Clause to visit.

onEntities

protected void onEntities(AbstractEntitiesClause<?,?> entities)

Parameters:

entities - the AbstractEntitiesClause to format.

onEntity

protected void onEntity(AbstractEntityClause<?,?> entity)

Parameters:

entity - the AbstractEntityClause to format.

onAdditionalEntity

protected void onAdditionalEntity(EntitySubClause<?> entity)

Parameters:

entity - the EntitySubClause to format.

onAlias

protected void onAlias(String alias,
                       Clause clause)

Parameters:

alias - the alias.

clause - the owning AbstractEntityClause.

onWhere

public void onWhere(Where<?,?> where)

Specified by:

onWhere in interface ClauseVisitor

Parameters:

where - the Where-Clause to visit.

onOrderBy

public void onOrderBy(OrderBy<?> orderBy)

Specified by:

onOrderBy in interface ClauseVisitor

Parameters:

orderBy - the OrderBy-Clause to visit.

onInto

public void onInto(Into<?,?> into)

Specified by:

onInto in interface ClauseVisitor

Parameters:

into - the Into-Clause to visit.

onValues

public void onValues(Values<?,?> values)

Specified by:

onValues in interface ClauseVisitor

Parameters:

values - the Values-Clause to visit.

onSet

public void onSet(Set<?,?> set)

Specified by:

onSet in interface ClauseVisitor

Parameters:

set - the Set-Clause to visit.

onColumns

public void onColumns(CreateTableColumns<?> columns)

Specified by:

onColumns in interface ClauseVisitor

Parameters:

columns - the CreateTableColumns-Clause to visit.

onCreateColumn

protected void onCreateColumn(io.github.mmm.property.ReadableProperty<?> column)

Parameters:

column - the ReadableProperty representing the column to create.

onType

protected void onType(Class<?> valueClass)

Parameters:

valueClass - the value class to map to an SQL type.

onColumns

public void onColumns(CreateIndexColumns<?> columns)

Specified by:

onColumns in interface ClauseVisitor

Parameters:

columns - the CreateIndexColumns-Clause to visit.

toString

public String toString()

Overrides:

toString in class Object