jodd.db.oom.sqlgen

Class TemplateData

java.lang.Object

jodd.db.oom.sqlgen.TemplateData

Direct Known Subclasses:

DbSqlBuilder

public abstract class TemplateData
extends java.lang.Object

Template common data used during template parsing. Extracted to super class for better visibility.

Field Summary

Fields

Modifier and Type	Field and Description
protected ColumnAliasType	columnAliasType Specifies column alias type.
protected int	columnCount Column counter for COLUMN_CODE column alias type.
protected java.util.Map<java.lang.String,ColumnData>	columnData Column or table aliases.
protected DbOomManager	dbOomManager
protected int	hintCount
protected java.util.List<java.lang.String>	hints
DbEntityColumnDescriptor	lastColumnDec
protected java.util.Map<java.lang.String,java.lang.Object>	objectRefs
protected int	paramCount
protected java.util.Map<java.lang.String,ParameterValue>	parameters
protected java.util.Map<java.lang.String,jodd.db.oom.sqlgen.TemplateData.TableRefData>	tableRefs

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TemplateData()

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(java.lang.String name, java.lang.Object value, DbEntityColumnDescriptor dec) Adds query parameter.
protected void	defineParameter(java.lang.StringBuilder query, java.lang.String name, java.lang.Object value) Defines parameter with name and its value.
DbEntityDescriptor	findTableDescriptorByColumnRef(java.lang.String columnRef) Finds entity descriptor of a table that contains provided column reference.
ColumnAliasType	getColumnAliasType() Returns column alias type.
DbOomManager	getDbOomManager() Returns associated DbOomManager.
java.lang.String	getNextParameterName() Returns the next auto-generated parameter name.
java.lang.Object	getObjectReference(java.lang.String name) Returns object reference.
java.lang.String	getTableAlias(java.lang.String tableRef) Returns table alias for provided table reference.
DbEntityDescriptor	getTableDescriptor(java.lang.String tableRef) Returns entity descriptor for provided table reference.
boolean	hasHints() Returns true if there are hints.
void	incrementHintsCount() Increments hints count.
protected DbEntityDescriptor	lookupName(java.lang.String entityName) Lookups for entity name and throws exception if entity name not found.
java.lang.Object	lookupObject(java.lang.String ref) Lookups for object reference and throws an exception if reference doesn't exist.
protected DbEntityDescriptor	lookupTableRef(java.lang.String tableRef) Lookups for table reference and throws an exception if table reference not found.
protected DbEntityDescriptor	lookupType(java.lang.Class entity) Lookups for entity name and throws an exception if entity type is invalid.
java.lang.String	registerColumnDataForColumnCode(java.lang.String tableName, java.lang.String column)
void	registerColumnDataForTableRef(java.lang.String tableRef, java.lang.String tableName)
void	registerHint(java.lang.String hint) Registers a hint.
void	registerTableReference(java.lang.String tableReference, DbEntityDescriptor ded, java.lang.String tableAlias) Registers table reference for provided entity.
protected void	resetAll() Resets the builder so it can be used again.
protected void	resetOnPreInit() Resets the build before initializing and processing.
void	setObjectReference(java.lang.String name, java.lang.Object object) Saves object reference.

Methods inherited from class java.lang.Object

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

Field Detail

dbOomManager

protected final DbOomManager dbOomManager

objectRefs

protected java.util.Map<java.lang.String,java.lang.Object> objectRefs

tableRefs

protected java.util.Map<java.lang.String,jodd.db.oom.sqlgen.TemplateData.TableRefData> tableRefs

columnData

protected java.util.Map<java.lang.String,ColumnData> columnData

Column or table aliases.

columnCount

protected int columnCount

Column counter for COLUMN_CODE column alias type.

columnAliasType

protected ColumnAliasType columnAliasType

Specifies column alias type. May be null when column aliases are not used.

parameters

protected java.util.Map<java.lang.String,ParameterValue> parameters

paramCount

protected int paramCount

hintCount

protected int hintCount

hints

protected java.util.List<java.lang.String> hints

lastColumnDec

public DbEntityColumnDescriptor lastColumnDec

Constructor Detail

TemplateData

protected TemplateData()

Method Detail

getDbOomManager

public DbOomManager getDbOomManager()

Returns associated DbOomManager.

resetOnPreInit

protected void resetOnPreInit()

Resets the build before initializing and processing.

resetAll

protected void resetAll()

Resets the builder so it can be used again. Note that object references are not cleared.

setObjectReference

public void setObjectReference(java.lang.String name,
                      java.lang.Object object)

Saves object reference.

getObjectReference

public java.lang.Object getObjectReference(java.lang.String name)

Returns object reference.

lookupObject

public java.lang.Object lookupObject(java.lang.String ref)

Lookups for object reference and throws an exception if reference doesn't exist.

getTableDescriptor

public DbEntityDescriptor getTableDescriptor(java.lang.String tableRef)

Returns entity descriptor for provided table reference.

findTableDescriptorByColumnRef

public DbEntityDescriptor findTableDescriptorByColumnRef(java.lang.String columnRef)

Finds entity descriptor of a table that contains provided column reference.

getTableAlias

public java.lang.String getTableAlias(java.lang.String tableRef)

Returns table alias for provided table reference.

registerTableReference

public void registerTableReference(java.lang.String tableReference,
                          DbEntityDescriptor ded,
                          java.lang.String tableAlias)

Registers table reference for provided entity.

getColumnAliasType

public ColumnAliasType getColumnAliasType()

Returns column alias type.

registerColumnDataForTableRef

public void registerColumnDataForTableRef(java.lang.String tableRef,
                                 java.lang.String tableName)

registerColumnDataForColumnCode

public java.lang.String registerColumnDataForColumnCode(java.lang.String tableName,
                                               java.lang.String column)

getNextParameterName

public java.lang.String getNextParameterName()

Returns the next auto-generated parameter name.

addParameter

public void addParameter(java.lang.String name,
                java.lang.Object value,
                DbEntityColumnDescriptor dec)

Adds query parameter.

lookupName

protected DbEntityDescriptor lookupName(java.lang.String entityName)

Lookups for entity name and throws exception if entity name not found.

lookupType

protected DbEntityDescriptor lookupType(java.lang.Class entity)

Lookups for entity name and throws an exception if entity type is invalid.

lookupTableRef

protected DbEntityDescriptor lookupTableRef(java.lang.String tableRef)

Lookups for table reference and throws an exception if table reference not found.

defineParameter

protected void defineParameter(java.lang.StringBuilder query,
                   java.lang.String name,
                   java.lang.Object value)

Defines parameter with name and its value.

registerHint

public void registerHint(java.lang.String hint)

Registers a hint.

incrementHintsCount

public void incrementHintsCount()

Increments hints count.

hasHints

public boolean hasHints()

Returns true if there are hints.