Module io.github.tonywasher.joceanus.prometheus.core

Package io.github.tonywasher.joceanus.prometheus.database

Class PrometheusTableDefinition

java.lang.Object

io.github.tonywasher.joceanus.prometheus.database.PrometheusTableDefinition

public class PrometheusTableDefinition
extends Object

Database field definition class. Maps each dataType to a database field.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PrometheusTableDefinition.PrometheusSortOrder	SortOrder.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	QUOTE_STRING	The quote string.
protected static final String	STR_DESC	The Descending string.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusTableDefinition(PrometheusJDBCDriver pDriver, String pName)	Constructor.

Method Summary

Modifier and Type	Method	Description
PrometheusColumnDefinition.PrometheusBinaryColumn	addBinaryColumn(MetisDataItem.MetisDataFieldId pId, int pLength)	Add a binary column.
PrometheusColumnDefinition.PrometheusBooleanColumn	addBooleanColumn(MetisDataItem.MetisDataFieldId pId)	Add a boolean column.
PrometheusColumnDefinition.PrometheusDateColumn	addDateColumn(MetisDataItem.MetisDataFieldId pId)	Add a date column.
PrometheusColumnDefinition.PrometheusBinaryColumn	addEncryptedColumn(MetisDataItem.MetisDataFieldId pId, int pLength)	Add an encrypted column.
PrometheusColumnDefinition.PrometheusIntegerColumn	addIntegerColumn(MetisDataItem.MetisDataFieldId pId)	Add an integer column.
PrometheusColumnDefinition.PrometheusLongColumn	addLongColumn(MetisDataItem.MetisDataFieldId pId)	Add a long column.
PrometheusColumnDefinition.PrometheusMoneyColumn	addMoneyColumn(MetisDataItem.MetisDataFieldId pId)	Add a money column.
PrometheusColumnDefinition.PrometheusBinaryColumn	addNullBinaryColumn(MetisDataItem.MetisDataFieldId pId, int pLength)	Add a binary column, which can be null.
PrometheusColumnDefinition.PrometheusBooleanColumn	addNullBooleanColumn(MetisDataItem.MetisDataFieldId pId)	Add a boolean column, which can be null.
PrometheusColumnDefinition.PrometheusDateColumn	addNullDateColumn(MetisDataItem.MetisDataFieldId pId)	Add a date column, which can be null.
PrometheusColumnDefinition.PrometheusBinaryColumn	addNullEncryptedColumn(MetisDataItem.MetisDataFieldId pId, int pLength)	Add an encrypted column, which can be null.
PrometheusColumnDefinition.PrometheusIntegerColumn	addNullIntegerColumn(MetisDataItem.MetisDataFieldId pId)	Add an integer column, which can be null.
PrometheusColumnDefinition.PrometheusLongColumn	addNullLongColumn(MetisDataItem.MetisDataFieldId pId)	Add a long column, which can be null.
PrometheusColumnDefinition.PrometheusMoneyColumn	addNullMoneyColumn(MetisDataItem.MetisDataFieldId pId)	Add a money column, which can be null.
PrometheusColumnDefinition.PrometheusRateColumn	addNullRateColumn(MetisDataItem.MetisDataFieldId pId)	Add a rate column, which can be null.
PrometheusColumnDefinition.PrometheusRatioColumn	addNullRatioColumn(MetisDataItem.MetisDataFieldId pId)	Add a rate column, which can be null.
PrometheusColumnDefinition.PrometheusReferenceColumn	addNullReferenceColumn(MetisDataItem.MetisDataFieldId pId, String pRef)	Add a reference column, which can be null.
PrometheusColumnDefinition.PrometheusStringColumn	addNullStringColumn(MetisDataItem.MetisDataFieldId pId, int pLength)	Add a string column, which can be null.
(package private) void	addQuoteIfAllowed(StringBuilder pBuilder)	Add quote if necessary.
PrometheusColumnDefinition.PrometheusRateColumn	addRateColumn(MetisDataItem.MetisDataFieldId pId)	Add a rate column.
PrometheusColumnDefinition.PrometheusRatioColumn	addRatioColumn(MetisDataItem.MetisDataFieldId pId)	Add a rate column.
PrometheusColumnDefinition.PrometheusReferenceColumn	addReferenceColumn(MetisDataItem.MetisDataFieldId pId, String pRef)	Add a reference column.
PrometheusColumnDefinition.PrometheusStringColumn	addStringColumn(MetisDataItem.MetisDataFieldId pId, int pLength)	Add a string column.
protected void	clearValues()	Clear values for table.
byte[]	getBinaryValue(MetisDataItem.MetisDataFieldId pId)	Get Binary value for column.
Boolean	getBooleanValue(MetisDataItem.MetisDataFieldId pId)	Get Boolean value for column.
protected List<PrometheusColumnDefinition>	getColumns()	Column Definitions array.
protected String	getCountString()	Build the count string for a table.
protected String	getCreateIndexString()	Build the create index string for the table.
protected String	getCreateTableString()	Build the create table string for the table.
OceanusDate	getDateValue(MetisDataItem.MetisDataFieldId pId)	Get Date value for column.
protected String	getDeleteString()	Build the delete string for a table.
protected PrometheusJDBCDriver	getDriver()	Obtain the driver.
protected String	getDropIndexString()	Build the drop index string for the table.
protected String	getDropTableString()	Build the drop table string for the table.
protected String	getInsertString()	Build the insert string for a list of columns.
Integer	getIntegerValue(MetisDataItem.MetisDataFieldId pId)	Get Integer value for column.
protected String	getJoinString(char pChar, Integer pOffset)	Build the Join string for the list of columns.
protected String	getLoadString()	Build the load string for a list of columns.
Long	getLongValue(MetisDataItem.MetisDataFieldId pId)	Get Long value for column.
protected Map<MetisDataItem.MetisDataFieldId,PrometheusColumnDefinition>	getMap()	Obtain the column map.
OceanusMoney	getMoneyValue(MetisDataItem.MetisDataFieldId pId, OceanusDataFormatter pFormatter)	Get Money value for column.
protected String	getOrderString(char pChar, Integer pOffset)	Build the Order string for the list of columns.
OceanusPrice	getPriceValue(MetisDataItem.MetisDataFieldId pId, OceanusDataFormatter pFormatter)	Get Price value for column.
protected String	getPurgeString()	Build the purge string for a table.
OceanusRate	getRateValue(MetisDataItem.MetisDataFieldId pId, OceanusDataFormatter pFormatter)	Get Rate value for column.
OceanusRatio	getRatioValue(MetisDataItem.MetisDataFieldId pId, OceanusDataFormatter pFormatter)	Get Ratio value for column.
protected List<PrometheusColumnDefinition>	getSortList()	Sort List.
String	getStringValue(MetisDataItem.MetisDataFieldId pId)	Get String value for column.
protected String	getTableName()	Obtain the table name.
OceanusUnits	getUnitsValue(MetisDataItem.MetisDataFieldId pId, OceanusDataFormatter pFormatter)	Get Units value for column.
protected String	getUpdateString()	Build the update string for a list of columns.
protected void	insertValues(PreparedStatement pStmt)	Insert values.
protected boolean	isIndexed()	Is the table indexed.
protected void	loadResults(ResultSet pResults)	Load results.
protected void	resolveReferences(List<PrometheusTableDataItem<?>> pTables)	Locate reference.
void	setBinaryValue(MetisDataItem.MetisDataFieldId pId, byte[] pValue)	Set Binary value for column.
void	setBooleanValue(MetisDataItem.MetisDataFieldId pId, Boolean pValue)	Set Boolean value for column.
void	setDateValue(MetisDataItem.MetisDataFieldId pId, OceanusDate pValue)	Set Date value for column.
void	setIntegerValue(MetisDataItem.MetisDataFieldId pId, Integer pValue)	Set Integer value for column.
void	setLongValue(MetisDataItem.MetisDataFieldId pId, Long pValue)	Set Long value for column.
void	setMoneyValue(MetisDataItem.MetisDataFieldId pId, OceanusMoney pValue)	Set Money value for column.
void	setRateValue(MetisDataItem.MetisDataFieldId pId, OceanusRate pValue)	Set Rate value for column.
void	setRatioValue(MetisDataItem.MetisDataFieldId pId, OceanusRatio pValue)	Set Ratio value for column.
protected void	setSortOnReference()	Note that we have a sort on reference.
void	setStringValue(MetisDataItem.MetisDataFieldId pId, String pValue)	Set String value for column.
protected void	updateValues(PreparedStatement pStmt)	Update values.

Methods inherited from class java.lang.Object

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

Field Details

QUOTE_STRING

protected static final String QUOTE_STRING

The quote string.

See Also:

• Constant Field Values

STR_DESC

protected static final String STR_DESC

The Descending string.

See Also:

• Constant Field Values

Constructor Details

PrometheusTableDefinition

protected PrometheusTableDefinition(PrometheusJDBCDriver pDriver,
 String pName)

Constructor.

Parameters:

pDriver - the driver

pName - the table name

Method Details

getTableName

protected String getTableName()

Obtain the table name.

Returns:

the table name

getMap

protected Map<MetisDataItem.MetisDataFieldId,PrometheusColumnDefinition> getMap()

Obtain the column map.

Returns:

the map

isIndexed

protected boolean isIndexed()

Is the table indexed.

Returns:

true/false

getColumns

protected List<PrometheusColumnDefinition> getColumns()

Column Definitions array.

Returns:

the columns

getSortList

protected List<PrometheusColumnDefinition> getSortList()

Sort List.

Returns:

the sort list

getDriver

protected PrometheusJDBCDriver getDriver()

Obtain the driver.

Returns:

the driver

setSortOnReference

protected void setSortOnReference()

Note that we have a sort on reference.

addReferenceColumn

public PrometheusColumnDefinition.PrometheusReferenceColumn addReferenceColumn(MetisDataItem.MetisDataFieldId pId,
 String pRef)

Add a reference column.

Parameters:

pId - the column id

pRef - the reference table

Returns:

the reference column

addNullReferenceColumn

public PrometheusColumnDefinition.PrometheusReferenceColumn addNullReferenceColumn(MetisDataItem.MetisDataFieldId pId,
 String pRef)

Add a reference column, which can be null.

Parameters:

pId - the column id

pRef - the reference table

Returns:

the reference column

addIntegerColumn

public PrometheusColumnDefinition.PrometheusIntegerColumn addIntegerColumn(MetisDataItem.MetisDataFieldId pId)

Add an integer column.

Parameters:

pId - the column id

Returns:

the integer column

addNullIntegerColumn

public PrometheusColumnDefinition.PrometheusIntegerColumn addNullIntegerColumn(MetisDataItem.MetisDataFieldId pId)

Add an integer column, which can be null.

Parameters:

pId - the column id

Returns:

the integer column

addLongColumn

public PrometheusColumnDefinition.PrometheusLongColumn addLongColumn(MetisDataItem.MetisDataFieldId pId)

Add a long column.

Parameters:

pId - the column id

Returns:

the long column

addNullLongColumn

public PrometheusColumnDefinition.PrometheusLongColumn addNullLongColumn(MetisDataItem.MetisDataFieldId pId)

Add a long column, which can be null.

Parameters:

pId - the column id

Returns:

the long column

addBooleanColumn

public PrometheusColumnDefinition.PrometheusBooleanColumn addBooleanColumn(MetisDataItem.MetisDataFieldId pId)

Add a boolean column.

Parameters:

pId - the column id

Returns:

the boolean column

addNullBooleanColumn

public PrometheusColumnDefinition.PrometheusBooleanColumn addNullBooleanColumn(MetisDataItem.MetisDataFieldId pId)

Add a boolean column, which can be null.

Parameters:

pId - the column id

Returns:

the boolean column

addDateColumn

public PrometheusColumnDefinition.PrometheusDateColumn addDateColumn(MetisDataItem.MetisDataFieldId pId)

Add a date column.

Parameters:

pId - the column id

Returns:

the date column

addNullDateColumn

public PrometheusColumnDefinition.PrometheusDateColumn addNullDateColumn(MetisDataItem.MetisDataFieldId pId)

Add a date column, which can be null.

Parameters:

pId - the column id

Returns:

the date column

addMoneyColumn

public PrometheusColumnDefinition.PrometheusMoneyColumn addMoneyColumn(MetisDataItem.MetisDataFieldId pId)

Add a money column.

Parameters:

pId - the column id

Returns:

the money column

addNullMoneyColumn

public PrometheusColumnDefinition.PrometheusMoneyColumn addNullMoneyColumn(MetisDataItem.MetisDataFieldId pId)

Add a money column, which can be null.

Parameters:

pId - the column id

Returns:

the money column

addRateColumn

public PrometheusColumnDefinition.PrometheusRateColumn addRateColumn(MetisDataItem.MetisDataFieldId pId)

Add a rate column.

Parameters:

pId - the column id

Returns:

the rate column

addNullRateColumn

public PrometheusColumnDefinition.PrometheusRateColumn addNullRateColumn(MetisDataItem.MetisDataFieldId pId)

Add a rate column, which can be null.

Parameters:

pId - the column id

Returns:

the rate column

addRatioColumn

public PrometheusColumnDefinition.PrometheusRatioColumn addRatioColumn(MetisDataItem.MetisDataFieldId pId)

Add a rate column.

Parameters:

pId - the column id

Returns:

the rate column

addNullRatioColumn

public PrometheusColumnDefinition.PrometheusRatioColumn addNullRatioColumn(MetisDataItem.MetisDataFieldId pId)

Add a rate column, which can be null.

Parameters:

pId - the column id

Returns:

the rate column

addBinaryColumn

public PrometheusColumnDefinition.PrometheusBinaryColumn addBinaryColumn(MetisDataItem.MetisDataFieldId pId,
 int pLength)

Add a binary column.

Parameters:

pId - the column id

pLength - the underlying (character) length

Returns:

the binary column

addNullBinaryColumn

public PrometheusColumnDefinition.PrometheusBinaryColumn addNullBinaryColumn(MetisDataItem.MetisDataFieldId pId,
 int pLength)

Add a binary column, which can be null.

Parameters:

pId - the column id

pLength - the underlying (character) length

Returns:

the binary column

addEncryptedColumn

public PrometheusColumnDefinition.PrometheusBinaryColumn addEncryptedColumn(MetisDataItem.MetisDataFieldId pId,
 int pLength)

Add an encrypted column.

Parameters:

pId - the column id

pLength - the underlying (character) length

Returns:

the binary column

addNullEncryptedColumn

public PrometheusColumnDefinition.PrometheusBinaryColumn addNullEncryptedColumn(MetisDataItem.MetisDataFieldId pId,
 int pLength)

Add an encrypted column, which can be null.

Parameters:

pId - the column id

pLength - the underlying (character) length

Returns:

the binary column

addStringColumn

public PrometheusColumnDefinition.PrometheusStringColumn addStringColumn(MetisDataItem.MetisDataFieldId pId,
 int pLength)

Add a string column.

Parameters:

pId - the column id

pLength - the character length

Returns:

the binary column

addNullStringColumn

public PrometheusColumnDefinition.PrometheusStringColumn addNullStringColumn(MetisDataItem.MetisDataFieldId pId,
 int pLength)

Add a string column, which can be null.

Parameters:

pId - the column id

pLength - the character length

Returns:

the binary column

resolveReferences

protected void resolveReferences(List<PrometheusTableDataItem<?>> pTables)

Locate reference.

Parameters:

pTables - the list of defined tables

loadResults

protected void loadResults(ResultSet pResults)
                    throws SQLException

Load results.

Parameters:

pResults - the result set

Throws:

SQLException - on error

insertValues

protected void insertValues(PreparedStatement pStmt)
                     throws SQLException,
OceanusException

Insert values.

Parameters:

pStmt - the statement

Throws:

SQLException - on error

OceanusException - on error

updateValues

protected void updateValues(PreparedStatement pStmt)
                     throws SQLException

Update values.

Parameters:

pStmt - the statement

Throws:

SQLException - on error

clearValues

protected void clearValues()

Clear values for table.

getIntegerValue

public Integer getIntegerValue(MetisDataItem.MetisDataFieldId pId)
                        throws OceanusException

Get Integer value for column.

Parameters:

pId - the column id

Returns:

the integer value

Throws:

OceanusException - on error

getLongValue

public Long getLongValue(MetisDataItem.MetisDataFieldId pId)
                  throws OceanusException

Get Long value for column.

Parameters:

pId - the column id

Returns:

the long value

Throws:

OceanusException - on error

getDateValue

public OceanusDate getDateValue(MetisDataItem.MetisDataFieldId pId)
                         throws OceanusException

Get Date value for column.

Parameters:

pId - the column id

Returns:

the Date value

Throws:

OceanusException - on error

getBooleanValue

public Boolean getBooleanValue(MetisDataItem.MetisDataFieldId pId)
                        throws OceanusException

Get Boolean value for column.

Parameters:

pId - the column id

Returns:

the boolean value

Throws:

OceanusException - on error

getStringValue

public String getStringValue(MetisDataItem.MetisDataFieldId pId)
                      throws OceanusException

Get String value for column.

Parameters:

pId - the column id

Returns:

the String value

Throws:

OceanusException - on error

getMoneyValue

public OceanusMoney getMoneyValue(MetisDataItem.MetisDataFieldId pId,
 OceanusDataFormatter pFormatter)
                           throws OceanusException

Get Money value for column.

Parameters:

pId - the column id

pFormatter - the data formatter

Returns:

the Money value

Throws:

OceanusException - on error

getPriceValue

public OceanusPrice getPriceValue(MetisDataItem.MetisDataFieldId pId,
 OceanusDataFormatter pFormatter)
                           throws OceanusException

Get Price value for column.

Parameters:

pId - the column id

pFormatter - the data formatter

Returns:

the price value

Throws:

OceanusException - on error

getRateValue

public OceanusRate getRateValue(MetisDataItem.MetisDataFieldId pId,
 OceanusDataFormatter pFormatter)
                         throws OceanusException

Get Rate value for column.

Parameters:

pId - the column id

pFormatter - the data formatter

Returns:

the rate value

Throws:

OceanusException - on error

getUnitsValue

public OceanusUnits getUnitsValue(MetisDataItem.MetisDataFieldId pId,
 OceanusDataFormatter pFormatter)
                           throws OceanusException

Get Units value for column.

Parameters:

pId - the column id

pFormatter - the data formatter

Returns:

the Units value

Throws:

OceanusException - on error

getRatioValue

public OceanusRatio getRatioValue(MetisDataItem.MetisDataFieldId pId,
 OceanusDataFormatter pFormatter)
                           throws OceanusException

Get Ratio value for column.

Parameters:

pId - the column id

pFormatter - the data formatter

Returns:

the Ratio value

Throws:

OceanusException - on error

getBinaryValue

public byte[] getBinaryValue(MetisDataItem.MetisDataFieldId pId)
                      throws OceanusException

Get Binary value for column.

Parameters:

pId - the column id

Returns:

the binary value

Throws:

OceanusException - on error

setIntegerValue

public void setIntegerValue(MetisDataItem.MetisDataFieldId pId,
 Integer pValue)
                     throws OceanusException

Set Integer value for column.

Parameters:

pId - the column id

pValue - the value

Throws:

OceanusException - on error

setLongValue

public void setLongValue(MetisDataItem.MetisDataFieldId pId,
 Long pValue)
                  throws OceanusException

Set Long value for column.

Parameters:

pId - the column id

pValue - the value

Throws:

OceanusException - on error

setBooleanValue

public void setBooleanValue(MetisDataItem.MetisDataFieldId pId,
 Boolean pValue)
                     throws OceanusException

Set Boolean value for column.

Parameters:

pId - the column id

pValue - the value

Throws:

OceanusException - on error

setDateValue

public void setDateValue(MetisDataItem.MetisDataFieldId pId,
 OceanusDate pValue)
                  throws OceanusException

Set Date value for column.

Parameters:

pId - the column id

pValue - the value

Throws:

OceanusException - on error

setStringValue

public void setStringValue(MetisDataItem.MetisDataFieldId pId,
 String pValue)
                    throws OceanusException

Set String value for column.

Parameters:

pId - the column id

pValue - the value

Throws:

OceanusException - on error

setBinaryValue

public void setBinaryValue(MetisDataItem.MetisDataFieldId pId,
 byte[] pValue)
                    throws OceanusException

Set Binary value for column.

Parameters:

pId - the column id

pValue - the value

Throws:

OceanusException - on error

setMoneyValue

public void setMoneyValue(MetisDataItem.MetisDataFieldId pId,
 OceanusMoney pValue)
                   throws OceanusException

Set Money value for column.

Parameters:

pId - the column id

pValue - the value

Throws:

OceanusException - on error

setRateValue

public void setRateValue(MetisDataItem.MetisDataFieldId pId,
 OceanusRate pValue)
                  throws OceanusException

Set Rate value for column.

Parameters:

pId - the column id

pValue - the value

Throws:

OceanusException - on error

setRatioValue

public void setRatioValue(MetisDataItem.MetisDataFieldId pId,
 OceanusRatio pValue)
                   throws OceanusException

Set Ratio value for column.

Parameters:

pId - the column id

pValue - the value

Throws:

OceanusException - on error

getCreateTableString

protected String getCreateTableString()

Build the create table string for the table.

Returns:

the SQL string

getCreateIndexString

protected String getCreateIndexString()

Build the create index string for the table.

Returns:

the SQL string

getDropTableString

protected String getDropTableString()

Build the drop table string for the table.

Returns:

the SQL string

getDropIndexString

protected String getDropIndexString()

Build the drop index string for the table.

Returns:

the SQL string

getLoadString

protected String getLoadString()

Build the load string for a list of columns.

Returns:

the SQL string

getJoinString

protected String getJoinString(char pChar,
 Integer pOffset)

Build the Join string for the list of columns.

Parameters:

pChar - the character for this table

pOffset - the join offset

Returns:

the SQL string

getOrderString

protected String getOrderString(char pChar,
 Integer pOffset)

Build the Order string for the list of columns.

Parameters:

pChar - the character for this table

pOffset - the join offset

Returns:

the SQL string

getInsertString

protected String getInsertString()

Build the insert string for a list of columns.

Returns:

the SQL string

getUpdateString

protected String getUpdateString()
                          throws OceanusException

Build the update string for a list of columns.

Returns:

the SQL string

Throws:

OceanusException - on error

getDeleteString

protected String getDeleteString()

Build the delete string for a table.

Returns:

the SQL string

getPurgeString

protected String getPurgeString()

Build the purge string for a table.

Returns:

the SQL string

getCountString

protected String getCountString()

Build the count string for a table.

Returns:

the SQL string

addQuoteIfAllowed

void addQuoteIfAllowed(StringBuilder pBuilder)

Add quote if necessary.

Parameters:

pBuilder - the builder