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

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

Class PrometheusColumnDefinition

java.lang.Object

io.github.tonywasher.joceanus.prometheus.database.PrometheusColumnDefinition

Direct Known Subclasses:

PrometheusColumnDefinition.PrometheusBinaryColumn, PrometheusColumnDefinition.PrometheusBooleanColumn, PrometheusColumnDefinition.PrometheusDateColumn, PrometheusColumnDefinition.PrometheusIntegerColumn, PrometheusColumnDefinition.PrometheusLongColumn, PrometheusColumnDefinition.PrometheusShortColumn, PrometheusColumnDefinition.PrometheusStringColumn

public abstract class PrometheusColumnDefinition
extends Object

Column definition classes handling data-type specifics.

Author:

Tony Washer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	PrometheusColumnDefinition.PrometheusBinaryColumn	The binaryColumn Class.
protected static final class	PrometheusColumnDefinition.PrometheusBooleanColumn	The booleanColumn Class.
protected static final class	PrometheusColumnDefinition.PrometheusDateColumn	The dateColumn Class.
protected static final class	PrometheusColumnDefinition.PrometheusIdColumn	The idColumn Class.
protected static class	PrometheusColumnDefinition.PrometheusIntegerColumn	The integerColumn Class.
protected static final class	PrometheusColumnDefinition.PrometheusLongColumn	The longColumn Class.
protected static final class	PrometheusColumnDefinition.PrometheusMoneyColumn	The moneyColumn Class.
protected static final class	PrometheusColumnDefinition.PrometheusPriceColumn	The priceColumn Class.
protected static final class	PrometheusColumnDefinition.PrometheusRateColumn	The rateColumn Class.
protected static final class	PrometheusColumnDefinition.PrometheusRatioColumn	The ratioColumn Class.
protected static final class	PrometheusColumnDefinition.PrometheusReferenceColumn	The referenceColumn Class.
protected static final class	PrometheusColumnDefinition.PrometheusShortColumn	The shortColumn Class.
protected static class	PrometheusColumnDefinition.PrometheusStringColumn	The stringColumn Class.
protected static final class	PrometheusColumnDefinition.PrometheusUnitsColumn	The unitsColumn Class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusColumnDefinition(PrometheusTableDefinition pTable, MetisDataItem.MetisDataFieldId pId)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected abstract void	buildColumnType(StringBuilder pBuilder)	Build the column type for this column.
protected void	buildCreateString(StringBuilder pBuilder)	Build the creation string for this column.
protected void	buildKeyReference(StringBuilder pBuilder)	Define the key reference.
protected void	clearValue()	Clear value.
protected MetisDataItem.MetisDataFieldId	getColumnId()	Obtain the column id.
protected String	getColumnName()	Obtain the column name.
protected PrometheusJDBCDriver	getDriver()	Obtain the value.
protected Object	getObject()	Obtain the value.
protected PrometheusTableDefinition.PrometheusSortOrder	getSortOrder()	Obtain the sort order.
protected PrometheusTableDefinition	getTable()	Obtain the table.
protected boolean	isValueSet()	Is the value set.
protected abstract void	loadValue(ResultSet pResults, int pIndex)	Load the value for this column.
protected void	locateReference(List<PrometheusTableDataItem<?>> pTables)	Locate reference.
protected void	setNullable()	Set null-able column.
protected void	setObject(Object pValue)	Set value.
protected void	setSortOnReference()	Note that we have a sort on reference.
void	setSortOrder(PrometheusTableDefinition.PrometheusSortOrder pOrder)	Set sortOrder.
protected abstract void	storeValue(PreparedStatement pStatement, int pIndex)	Store the value for this column.

Methods inherited from class java.lang.Object

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

Constructor Details

PrometheusColumnDefinition

protected PrometheusColumnDefinition(PrometheusTableDefinition pTable,
 MetisDataItem.MetisDataFieldId pId)

Constructor.

Parameters:

pTable - the table to which the column belongs

pId - the column id

Method Details

getColumnName

protected String getColumnName()

Obtain the column name.

Returns:

the name

getColumnId

protected MetisDataItem.MetisDataFieldId getColumnId()

Obtain the column id.

Returns:

the id

getSortOrder

protected PrometheusTableDefinition.PrometheusSortOrder getSortOrder()

Obtain the sort order.

Returns:

the sort order

getObject

protected Object getObject()

Obtain the value.

Returns:

the value

getTable

protected PrometheusTableDefinition getTable()

Obtain the table.

Returns:

the table

getDriver

protected PrometheusJDBCDriver getDriver()

Obtain the value.

Returns:

the value

clearValue

protected void clearValue()

Clear value.

setObject

protected void setObject(Object pValue)

Set value.

Parameters:

pValue - the value

isValueSet

protected boolean isValueSet()

Is the value set.

Returns:

true/false

buildCreateString

protected void buildCreateString(StringBuilder pBuilder)

Build the creation string for this column.

Parameters:

pBuilder - the String builder

setNullable

protected void setNullable()

Set null-able column.

setSortOnReference

protected void setSortOnReference()

Note that we have a sort on reference.

setSortOrder

public void setSortOrder(PrometheusTableDefinition.PrometheusSortOrder pOrder)

Set sortOrder.

Parameters:

pOrder - the Sort direction

buildColumnType

protected abstract void buildColumnType(StringBuilder pBuilder)

Build the column type for this column.

Parameters:

pBuilder - the String builder

loadValue

protected abstract void loadValue(ResultSet pResults,
 int pIndex)
                           throws SQLException

Load the value for this column.

Parameters:

pResults - the results

pIndex - the index of the result column

Throws:

SQLException - on error

storeValue

protected abstract void storeValue(PreparedStatement pStatement,
 int pIndex)
                            throws SQLException

Store the value for this column.

Parameters:

pStatement - the prepared statement

pIndex - the index of the statement

Throws:

SQLException - on error

buildKeyReference

protected void buildKeyReference(StringBuilder pBuilder)

Define the key reference.

Parameters:

pBuilder - the String builder

locateReference

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

Locate reference.

Parameters:

pTables - the list of defined tables