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

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

Class PrometheusTableDataItem<T extends PrometheusDataItem>

java.lang.Object

io.github.tonywasher.joceanus.prometheus.database.PrometheusTableDataItem<T>

Type Parameters:

T - the DataType

All Implemented Interfaces:

PrometheusTableInstance<T>

Direct Known Subclasses:

PrometheusTableControlData, PrometheusTableControlKeys, PrometheusTableControlKeySet, PrometheusTableDataKeySet, PrometheusTableEncrypted

public abstract class PrometheusTableDataItem<T extends PrometheusDataItem>
extends Object
implements PrometheusTableInstance<T>

Database Table class. This controls should be extended for each DataType/Table.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusTableDataItem(PrometheusDatabaseControl pDatabase, String pTable)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	closeStmt()	Close the result set and statement.
protected int	countLoadItems()	Count the number of items to be loaded.
(package private) void	createDatabase(String pDatabase)	Create the database.
void	createTable()	Create the table.
protected abstract void	declareData(PrometheusDataSet pData)	Declare DataSet.
void	deleteItems(TethysUIThreadStatusReport pReport, PrometheusBatchControl pBatch)	Delete items from the list.
void	dropTable()	Drop the table.
protected PrometheusDatabaseControl	getDatabase()	Obtain database.
PrometheusTableDefinition	getDefinition()	Access the table definition.
PrometheusDataList<T>	getList()	Obtain the list of items.
protected PrometheusDataValues	getRowValues(String pName)	Obtain row values.
protected PrometheusTableDefinition	getTableDef()	Obtain table definition.
String	getTableName()	Access the table name.
void	insertItems(TethysUIThreadStatusReport pReport, PrometheusDataSet pData, PrometheusBatchControl pBatch)	Insert new items from the list.
void	loadItems(TethysUIThreadStatusReport pReport, PrometheusDataSet pData)	Load items from the list into the table.
protected abstract PrometheusDataValues	loadValues()	Load an individual item from the result set.
protected void	postProcessOnLoad()	Post-Process on a load operation.
void	purgeTable()	Truncate the table.
void	resolveReferences(List<PrometheusTableInstance<?>> pTables)	Resolve references.
protected void	setFieldValue(T pItem, MetisDataItem.MetisDataFieldId pField)	Set a field value for an item.
protected void	setList(PrometheusDataList<T> pList)	Set the list of items.
void	updateItems(TethysUIThreadStatusReport pReport, PrometheusBatchControl pBatch)	Update items from the list.

Methods inherited from class java.lang.Object

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

Constructor Details

PrometheusTableDataItem

protected PrometheusTableDataItem(PrometheusDatabaseControl pDatabase,
 String pTable)

Constructor.

Parameters:

pDatabase - the database control

pTable - the table name

Method Details

getDatabase

protected PrometheusDatabaseControl getDatabase()

Obtain database.

Returns:

the database

getTableDef

protected PrometheusTableDefinition getTableDef()

Obtain table definition.

Returns:

the table definition

getTableName

public String getTableName()

Description copied from interface: PrometheusTableInstance

Access the table name.

Specified by:

getTableName in interface PrometheusTableInstance<T extends PrometheusDataItem>

Returns:

the table name

getDefinition

public PrometheusTableDefinition getDefinition()

Description copied from interface: PrometheusTableInstance

Access the table definition.

Specified by:

getDefinition in interface PrometheusTableInstance<T extends PrometheusDataItem>

Returns:

the table definition

resolveReferences

public void resolveReferences(List<PrometheusTableInstance<?>> pTables)

Description copied from interface: PrometheusTableInstance

Resolve references.

Specified by:

resolveReferences in interface PrometheusTableInstance<T extends PrometheusDataItem>

Parameters:

pTables - the list of defined tables

closeStmt

public void closeStmt()
               throws SQLException

Close the result set and statement.

Throws:

SQLException - on error

countLoadItems

protected int countLoadItems()
                      throws SQLException

Count the number of items to be loaded.

Returns:

the count of items

Throws:

SQLException - on error

declareData

protected abstract void declareData(PrometheusDataSet pData)

Declare DataSet.

Parameters:

pData - the Data set

setList

protected void setList(PrometheusDataList<T> pList)

Set the list of items.

Parameters:

pList - the list of items

getList

public PrometheusDataList<T> getList()

Description copied from interface: PrometheusTableInstance

Obtain the list of items.

Specified by:

getList in interface PrometheusTableInstance<T extends PrometheusDataItem>

Returns:

the list of items

loadValues

protected abstract PrometheusDataValues loadValues()
                                            throws OceanusException

Load an individual item from the result set.

Returns:

the values for the row

Throws:

OceanusException - on error

setFieldValue

protected void setFieldValue(T pItem,
 MetisDataItem.MetisDataFieldId pField)
                      throws OceanusException

Set a field value for an item.

Parameters:

pItem - the item to insert

pField - the field id

Throws:

OceanusException - on error

postProcessOnLoad

protected void postProcessOnLoad()
                          throws OceanusException

Post-Process on a load operation.

Throws:

OceanusException - on error

loadItems

public void loadItems(TethysUIThreadStatusReport pReport,
 PrometheusDataSet pData)
               throws OceanusException

Load items from the list into the table.

Parameters:

pReport - the report

pData - the data

Throws:

OceanusException - on error

insertItems

public void insertItems(TethysUIThreadStatusReport pReport,
 PrometheusDataSet pData,
 PrometheusBatchControl pBatch)
                 throws OceanusException

Insert new items from the list.

Parameters:

pReport - the report

pData - the data

pBatch - the batch control

Throws:

OceanusException - on error

updateItems

public void updateItems(TethysUIThreadStatusReport pReport,
 PrometheusBatchControl pBatch)
                 throws OceanusException

Update items from the list.

Parameters:

pReport - the report

pBatch - the batch control

Throws:

OceanusException - on error

deleteItems

public void deleteItems(TethysUIThreadStatusReport pReport,
 PrometheusBatchControl pBatch)
                 throws OceanusException

Delete items from the list.

Parameters:

pReport - the report

pBatch - the batch control

Throws:

OceanusException - on error

createTable

public void createTable()
                 throws OceanusException

Create the table.

Throws:

OceanusException - on error

createDatabase

void createDatabase(String pDatabase)
             throws OceanusException

Create the database.

Parameters:

pDatabase - the database name

Throws:

OceanusException - on error

dropTable

public void dropTable()
               throws OceanusException

Drop the table.

Throws:

OceanusException - on error

purgeTable

public void purgeTable()
                throws OceanusException

Truncate the table.

Throws:

OceanusException - on error

getRowValues

protected PrometheusDataValues getRowValues(String pName)
                                     throws OceanusException

Obtain row values.

Parameters:

pName - the name of the item

Returns:

the row values.

Throws:

OceanusException - on error