org.resoa.persistence.rdbms

Class TableDescriptor

java.lang.Object

org.resoa.persistence.rdbms.TableDescriptor

public class TableDescriptor
extends java.lang.Object

Descriptor of a database table

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FOREIGNKEY_SUFFIX
static java.lang.String	INDEX_SUFFIX
static java.lang.String	PRIMARYKEY_SUFFIX
static java.lang.String	RELATION_SUFFIX
static java.lang.String	TYPECOLUMN

Constructor Summary

Constructors

Constructor and Description
TableDescriptor(DatabaseDescriptor dbd, PersistentType<?> persistentType) Constructor
TableDescriptor(DatabaseDescriptor dbd, java.lang.String tableName) Constructor by name

Method Summary

Methods

Modifier and Type	Method and Description
ColumnDescriptor	addClassReferenceColumn(java.lang.String columnName, ColumnConstraintType constraintType, SQLType sqlType, java.lang.String javaPropertyName, org.resoa.json.stream.Serializer serializer, TableDescriptor refTo, Relation relationInfo) Add a foreignKey column
void	addColumn(java.lang.Class<?> type, java.lang.String propertyName, org.resoa.codegen.PropertyHandler javaProperty, org.resoa.json.stream.Serializer serializer, ColumnConstraintType columnConstraint, TableRelation relation) Add an object field as column.
void	addJavaTypeColumn() Add a name for stored type (used in case of inheritance)
void	addTableRelation(TableRelation newRelation) Add a new relation to another table
void	checkPrimaryKeyColumn() Generate primary keyColumn if not yet exists
void	finalizeRelations() Finalize Table References
void	generateNMRelationColumns(TableRelation tableRelation)
java.util.List<TableRelation>	generateReferenceColumns(java.util.Map<java.lang.String,TableDescriptor> tables) Generate Reference Columns
ColumnDescriptor	getColumn(java.lang.String columnName)
java.util.Collection<ColumnDescriptor>	getColumns() The collection of table columns
org.skife.jdbi.v2.DBI	getDatabase()
DatabaseDescriptor	getDatabaseDescriptor()
java.util.List<Relation>	getDeclaredRelations()
ForeignKeyColumnDescriptor	getForeignKeyColumn(TableDescriptor table, java.lang.String javaPropertyName) Get a ForeignKey Columns
java.util.Collection<ForeignKeyColumnDescriptor>	getForeignKeyColumns() Get all declared ForeignKey Columns
java.util.Collection<java.lang.String>	getIndices()
java.util.List<ColumnDescriptor>	getNMRelationColumns()
java.lang.Object[]	getObjectArrayFromJSON(org.resoa.json.JSONObject json) Create an object out of JSON for SQL transactions
PersistentType<?>	getPersistentType()
java.lang.reflect.Field	getPrimaryJavaKeyField()
ColumnDescriptor	getPrimaryKeyColumn()
java.lang.Object	getPrimaryKeyFromJSON(org.resoa.json.JSONObject json, java.lang.String referenceColumn, boolean generateNew)
java.lang.String	getTableName()
java.util.Collection<TableRelation>	getTableRelations() Get all relations to other tables
boolean	hasFKReferenceColumns()
boolean	isInheritanceEnabled()
void	printColumns() Dump columns
void	setDatabase(org.skife.jdbi.v2.DBI database) Set the DBI handle for database processing
java.lang.String	SQL_getDELETE() Get a JDBI compatible SQL DELETE statement
java.lang.String	SQL_getINSERT() Get a JDBI compatible SQL INSERT statement
java.lang.String	SQL_getSELECT_FOREIGNKEY(java.lang.String keyColumnName, boolean keysOnly)
java.lang.String	SQL_getSELECT_GENERIC(java.lang.String whereStatement, boolean keyOnly)
java.lang.String	SQL_getSELECT_PRIMARYKEY(boolean keyOnly)
java.lang.String	SQL_getUPDATE() Get a JDBI compatible SQL UPDATE statement

Methods inherited from class java.lang.Object

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

Field Detail

TYPECOLUMN

public static java.lang.String TYPECOLUMN

RELATION_SUFFIX

public static java.lang.String RELATION_SUFFIX

INDEX_SUFFIX

public static java.lang.String INDEX_SUFFIX

FOREIGNKEY_SUFFIX

public static java.lang.String FOREIGNKEY_SUFFIX

PRIMARYKEY_SUFFIX

public static java.lang.String PRIMARYKEY_SUFFIX

Constructor Detail

TableDescriptor

public TableDescriptor(DatabaseDescriptor dbd,
               PersistentType<?> persistentType)

Constructor

Parameters:

persistentType -

dbd -

TableDescriptor

public TableDescriptor(DatabaseDescriptor dbd,
               java.lang.String tableName)

Constructor by name

Parameters:

tableName -

dbd -

Method Detail

getColumns

public java.util.Collection<ColumnDescriptor> getColumns()

The collection of table columns

getColumn

public ColumnDescriptor getColumn(java.lang.String columnName)

Parameters:

columnName -

Returns:

a dedicated table column

getTableRelations

public java.util.Collection<TableRelation> getTableRelations()

Get all relations to other tables

getForeignKeyColumns

public java.util.Collection<ForeignKeyColumnDescriptor> getForeignKeyColumns()

Get all declared ForeignKey Columns

getForeignKeyColumn

public ForeignKeyColumnDescriptor getForeignKeyColumn(TableDescriptor table,
                                             java.lang.String javaPropertyName)

Get a ForeignKey Columns

Parameters:

table -

javaPropertyName -

addTableRelation

public void addTableRelation(TableRelation newRelation)

Add a new relation to another table

Parameters:

newRelation -

getIndices

public java.util.Collection<java.lang.String> getIndices()

Returns:

all defined indices

isInheritanceEnabled

public boolean isInheritanceEnabled()

Returns:

true, if table stores values of types with inheritance (requires dedicated CLASS column)

hasFKReferenceColumns

public boolean hasFKReferenceColumns()

Returns:

true, if table has foreignKey reference columns

getTableName

public java.lang.String getTableName()

Returns:

the tableName

getDatabase

public org.skife.jdbi.v2.DBI getDatabase()

Returns:

The DBI handle for database processing

setDatabase

public void setDatabase(org.skife.jdbi.v2.DBI database)

Set the DBI handle for database processing

Parameters:

database -

getPersistentType

public PersistentType<?> getPersistentType()

Returns:

the PersistentType for the table

getPrimaryJavaKeyField

public java.lang.reflect.Field getPrimaryJavaKeyField()

Returns:

the primary Key field

getPrimaryKeyColumn

public ColumnDescriptor getPrimaryKeyColumn()

Returns:

the primaryKeyColumn

getPrimaryKeyFromJSON

public java.lang.Object getPrimaryKeyFromJSON(org.resoa.json.JSONObject json,
                                     java.lang.String referenceColumn,
                                     boolean generateNew)

checkPrimaryKeyColumn

public void checkPrimaryKeyColumn()

Generate primary keyColumn if not yet exists

getNMRelationColumns

public java.util.List<ColumnDescriptor> getNMRelationColumns()

Returns:

the Columns of NM Relation relation tables

getDeclaredRelations

public java.util.List<Relation> getDeclaredRelations()

Returns:

the resoa.persistence.xml declared relations

getDatabaseDescriptor

public DatabaseDescriptor getDatabaseDescriptor()

Returns:

the database Descriptor

addColumn

public void addColumn(java.lang.Class<?> type,
             java.lang.String propertyName,
             org.resoa.codegen.PropertyHandler javaProperty,
             org.resoa.json.stream.Serializer serializer,
             ColumnConstraintType columnConstraint,
             TableRelation relation)

Add an object field as column. In case it is a reference, the referred type is returned

Parameters:

type -

propertyName -

columnConstraint -

relation -

javaProperty -

serializer -

addJavaTypeColumn

public void addJavaTypeColumn()

Add a name for stored type (used in case of inheritance)

addClassReferenceColumn

public ColumnDescriptor addClassReferenceColumn(java.lang.String columnName,
                                       ColumnConstraintType constraintType,
                                       SQLType sqlType,
                                       java.lang.String javaPropertyName,
                                       org.resoa.json.stream.Serializer serializer,
                                       TableDescriptor refTo,
                                       Relation relationInfo)

Add a foreignKey column

Parameters:

columnName -

constraintType -

sqlType -

refTo -

relationInfo -

generateNMRelationColumns

public void generateNMRelationColumns(TableRelation tableRelation)

generateReferenceColumns

public java.util.List<TableRelation> generateReferenceColumns(java.util.Map<java.lang.String,TableDescriptor> tables)

Generate Reference Columns

Parameters:

tables -

Returns:

A list with n:m relations

finalizeRelations

public void finalizeRelations()

Finalize Table References

SQL_getSELECT_PRIMARYKEY

public java.lang.String SQL_getSELECT_PRIMARYKEY(boolean keyOnly)

SQL_getSELECT_GENERIC

public java.lang.String SQL_getSELECT_GENERIC(java.lang.String whereStatement,
                                     boolean keyOnly)

SQL_getSELECT_FOREIGNKEY

public java.lang.String SQL_getSELECT_FOREIGNKEY(java.lang.String keyColumnName,
                                        boolean keysOnly)

SQL_getUPDATE

public java.lang.String SQL_getUPDATE()

Get a JDBI compatible SQL UPDATE statement

SQL_getINSERT

public java.lang.String SQL_getINSERT()

Get a JDBI compatible SQL INSERT statement

SQL_getDELETE

public java.lang.String SQL_getDELETE()

Get a JDBI compatible SQL DELETE statement

getObjectArrayFromJSON

public java.lang.Object[] getObjectArrayFromJSON(org.resoa.json.JSONObject json)
                                          throws org.resoa.exception.JSONException

Create an object out of JSON for SQL transactions

Parameters:

json -

Throws:

org.resoa.exception.JSONException

printColumns

public void printColumns()

Dump columns