jodd.db.oom.sqlgen.chunks

Class ColumnsSelectChunk

java.lang.Object

jodd.db.oom.sqlgen.chunks.SqlChunk

jodd.db.oom.sqlgen.chunks.ColumnsSelectChunk

public class ColumnsSelectChunk
extends SqlChunk

Columns select chunk resolves entity column(s) from column references. Should be used for SELECT queries.

Column reference is specified as: tableReference.propertyName where property name is a property of the entity references by table reference. Result is rendered as: tableName.column or alias.column (if table has an alias).

There are some special values for propertyName

• wildcard (*), all table columns will be listed
• id sign (+), all table id columns will be listed

If previous chunk is also a column chunk, comma separator will be added in between.

Note that column alias are appended to the column name (using 'as' construct).

Macro rules:

• $C{tableRef} is rendered as FOO.col1, FOO.col2,...
• $C{tableRef.*} is equal to above, renders all entity columns
• $C{tableRef.+} renders to only identity columns
• $C{tableRef.%} renders all but identity columns
• $C{tableRef.colRef} is rendered as FOO.column
• $C{tableRef.[colRef1,colRef2|...]} is rendered as FOO.column1, FOO.column2,..., support id sign (+)
• $C{entityRef.colRef} renders to FOO$column
• $C{hint.entityRef...} defines a hint
• $C{hint:entityRef...} defines a hint with custom name
• $C{.columName} renders as column name
• $C{hint:.columName} renders as column name and defines its hint

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	columnAliasSeparator
protected java.lang.String	columnRef
protected java.lang.String[]	columnRefArr
protected java.lang.String	hint
protected int	includeColumns
protected java.lang.String	tableRef

Fields inherited from class jodd.db.oom.sqlgen.chunks.SqlChunk

CHUNK_INSERT, CHUNK_MATCH, CHUNK_RAW, CHUNK_REFERENCE, CHUNK_SELECT_COLUMNS, CHUNK_TABLE, CHUNK_UPDATE, CHUNK_VALUE, COLS_ALL, COLS_ALL_BUT_ID, COLS_NA, COLS_NA_MULTI, COLS_ONLY_EXISTING, COLS_ONLY_IDS, nextChunk, previousChunk, templateData

Constructor Summary

Constructors

Constructor and Description
ColumnsSelectChunk(DbEntityManager dbEntityManager, java.lang.String columnAliasSeparator, java.lang.String reference)
ColumnsSelectChunk(DbEntityManager dbEntityManager, java.lang.String columnAliasSeparator, java.lang.String tableRef, boolean includeAll)
ColumnsSelectChunk(DbEntityManager dbEntityManager, java.lang.String columnAliasSeparator, java.lang.String tableRef, java.lang.String... columnRefArr)
ColumnsSelectChunk(DbEntityManager dbEntityManager, java.lang.String columnAliasSeparator, java.lang.String tableRef, java.lang.String columnRef)

Method Summary

Modifier and Type	Method and Description
protected void	appendAlias(java.lang.StringBuilder query, DbEntityDescriptor ded, DbEntityColumnDescriptor dec) Appends alias.
protected void	appendColumnName(java.lang.StringBuilder query, DbEntityDescriptor ded, DbEntityColumnDescriptor dec) Simply appends column name with optional table reference and alias.
void	init(TemplateData templateData) Counts actual real hints.
void	process(java.lang.StringBuilder out) Process the chunk and appends data to the output.

Methods inherited from class jodd.db.oom.sqlgen.chunks.SqlChunk

appendMissingSpace, defineParameter, findColumnRef, getNextChunk, getPreviousChunk, insertChunkAfter, isEmptyColumnValue, isPreviousChunkOfSameType, isPreviousChunkOfType, isPreviousMacroChunk, isPreviousRawChunk, lookupName, lookupTableRef, lookupTableRef, lookupType, resolveClass, resolveTable, separateByCommaOrSpace

Methods inherited from class java.lang.Object

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

Field Detail

tableRef

protected final java.lang.String tableRef

columnRef

protected final java.lang.String columnRef

columnRefArr

protected final java.lang.String[] columnRefArr

includeColumns

protected final int includeColumns

hint

protected final java.lang.String hint

columnAliasSeparator

protected final java.lang.String columnAliasSeparator

Constructor Detail

ColumnsSelectChunk

public ColumnsSelectChunk(DbEntityManager dbEntityManager,
                          java.lang.String columnAliasSeparator,
                          java.lang.String tableRef,
                          java.lang.String columnRef)

ColumnsSelectChunk

public ColumnsSelectChunk(DbEntityManager dbEntityManager,
                          java.lang.String columnAliasSeparator,
                          java.lang.String tableRef,
                          java.lang.String... columnRefArr)

ColumnsSelectChunk

public ColumnsSelectChunk(DbEntityManager dbEntityManager,
                          java.lang.String columnAliasSeparator,
                          java.lang.String tableRef,
                          boolean includeAll)

ColumnsSelectChunk

public ColumnsSelectChunk(DbEntityManager dbEntityManager,
                          java.lang.String columnAliasSeparator,
                          java.lang.String reference)

Method Detail

init

public void init(TemplateData templateData)

Counts actual real hints.

Overrides:

init in class SqlChunk

process

public void process(java.lang.StringBuilder out)

Description copied from class: SqlChunk

Process the chunk and appends data to the output.

Specified by:

process in class SqlChunk

appendAlias

protected void appendAlias(java.lang.StringBuilder query,
                           DbEntityDescriptor ded,
                           DbEntityColumnDescriptor dec)

Appends alias.

appendColumnName

protected void appendColumnName(java.lang.StringBuilder query,
                                DbEntityDescriptor ded,
                                DbEntityColumnDescriptor dec)

Simply appends column name with optional table reference and alias.