org.melati.poem.generated

Class TableCategoryTableBase<T extends TableCategory>

java.lang.Object

org.melati.poem.JdbcTable<P>

org.melati.poem.PoemTable<T>

org.melati.poem.generated.TableCategoryTableBase<T>

All Implemented Interfaces:

Selectable<T>, Table<T>

Direct Known Subclasses:

TableCategoryTable

public class TableCategoryTableBase<T extends TableCategory>
extends PoemTable<T>

Melati POEM generated base class for Table tableCategory. See org.melati.poem.prepro.TableDef#generateTableBaseJava

Constructor Summary

Constructors

Constructor and Description
TableCategoryTableBase(Database database, String name, DefinitionSource definitionSource) Constructor.

Method Summary

Modifier and Type	Method and Description
Integer	defaultCacheLimit()
String	defaultCategory()
String	defaultDescription() The `factory-default' description for the table, or null if it doesn't have one.
String	defaultDisplayName() The `factory-default' display name for the table.
int	defaultDisplayOrder()
boolean	defaultRememberAllTroids()
TableCategory	ensure(String name)
Column<Integer>	getIdColumn() Retrieves the Id Column for this tableCategory Table.
Column<String>	getNameColumn() Retrieves the Name Column for this tableCategory Table.
PoemDatabaseTables	getPoemDatabaseTables() Get the database tables.
TableCategory	getTableCategoryObject(int troid) Retrieve the TableCategory as a TableCategory.
TableCategory	getTableCategoryObject(Integer troid) Retrieve the TableCategory as a TableCategory.
void	init() Initialise this table by defining its columns.

Methods inherited from class org.melati.poem.PoemTable

postInitialise

Methods inherited from class org.melati.poem.JdbcTable

addColumnAndCommit, addListener, appendWhereClause, cachedCount, cachedCount, cachedCount, cachedCount, cachedCount, cachedCount, cachedExists, cachedSelection, cachedSelectionField, cachedSelectionType, canDeleteColumn, canReadColumn, canSelectColumn, canWriteColumn, clearColumnInfoCaches, cnfWhereClause, cnfWhereClause, columns, columnWithColumnInfoID, count, count, count, count, countSQL, countSQL, create, create, createTableInfo, dbAddConstraints, dbModifyStructure, defaultOrderByClause, defineColumn, delete_unsafe, delete, deleteColumnAndCommit, deletedColumn, displayColumn, displayColumns, displayColumnsCount, dump, dump, dumpCacheAnalysis, equals, exists, exists, extrasCount, firstSelection, getCacheInfo, getCanCreate, getCategory, getColumn, getColumns, getColumnsCount, getDatabase, getDbmsTableType, getDefaultCanDelete, getDefaultCanRead, getDefaultCanWrite, getDescription, getDetailDisplayColumns, getDetailDisplayColumnsCount, getDisplayName, getInfo, getMostRecentTroid, getName, getNextExtrasIndex, getObject, getObject, getRecordDisplayColumns, getRecordDisplayColumnsCount, getSearchCriterionColumns, getSearchCriterionColumnsCount, getSummaryDisplayColumns, getSummaryDisplayColumnsCount, getTableInfo, hashCode, invalidateTransactionStuffs, load, maybeFirst, newPersistent, notifyColumnInfo, notifyTouched, primaryCriterionColumn, quotedName, readLock, referencesTo, referencesTo, rememberAllTroids, selection, selection, selection, selection, selection, selection, selectionSQL, serial, setCacheLimit, setDisplayColumn, setSearchColumn, setTableInfo, tableInfoID, toString, trimCache, troidColumn, troidFor, troidSelection, troidSelection, troidSelection, uncache, unifyWithColumnInfo, unifyWithDB, unifyWithMetadata, whereClause, whereClause, writeDown

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TableCategoryTableBase

public TableCategoryTableBase(Database database,
                              String name,
                              DefinitionSource definitionSource)
                       throws PoemException

Constructor. See org.melati.poem.prepro.TableDef#generateTableBaseJava

Parameters:

database - the POEM database we are using

name - the name of this Table

definitionSource - which definition is being used

Throws:

PoemException - if anything goes wrong

Method Detail

getPoemDatabaseTables

public PoemDatabaseTables getPoemDatabaseTables()

Get the database tables. See org.melati.poem.prepro.TableDef#generateTableBaseJava

Returns:

the database tables

init

public void init()
          throws PoemException

Initialise this table by defining its columns. See org.melati.poem.prepro.TableDef#generateTableBaseJava

Specified by:

init in interface Table<T extends TableCategory>

Overrides:

init in class JdbcTable<T extends TableCategory>

Throws:

PoemException

getIdColumn

public final Column<Integer> getIdColumn()

Retrieves the Id Column for this tableCategory Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the id Column

getNameColumn

public final Column<String> getNameColumn()

Retrieves the Name Column for this tableCategory Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the name Column

getTableCategoryObject

public TableCategory getTableCategoryObject(Integer troid)

Retrieve the TableCategory as a TableCategory. See org.melati.poem.prepro.TableDef#generateTableBaseJava

Parameters:

troid - a Table Row Object ID

Returns:

the Persistent identified by the troid

getTableCategoryObject

public TableCategory getTableCategoryObject(int troid)

Retrieve the TableCategory as a TableCategory. See org.melati.poem.prepro.TableDef#generateTableBaseJava

Parameters:

troid - a Table Row Object ID

Returns:

the Persistent identified

defaultDisplayName

public String defaultDisplayName()

Description copied from class: JdbcTable

The `factory-default' display name for the table. By default this is the table's programmatic name, capitalised. Application-specialised tables override this to return any (displayname = ...) provided in the DSD. This is only ever used at startup time when creating columninfo records for tables that don't have them.

Specified by:

defaultDisplayName in interface Table<T extends TableCategory>

Overrides:

defaultDisplayName in class JdbcTable<T extends TableCategory>

defaultDescription

public String defaultDescription()

Description copied from class: JdbcTable

The `factory-default' description for the table, or null if it doesn't have one. Application-specialised tables override this to return any (description = ...) provided in the DSD. This is only ever used at startup time when creating columninfo records for tables that don't have them.

Specified by:

defaultDescription in interface Table<T extends TableCategory>

Overrides:

defaultDescription in class JdbcTable<T extends TableCategory>

defaultRememberAllTroids

public boolean defaultRememberAllTroids()

Specified by:

defaultRememberAllTroids in interface Table<T extends TableCategory>

Overrides:

defaultRememberAllTroids in class JdbcTable<T extends TableCategory>

defaultCacheLimit

public Integer defaultCacheLimit()

Specified by:

defaultCacheLimit in interface Table<T extends TableCategory>

Overrides:

defaultCacheLimit in class JdbcTable<T extends TableCategory>

defaultCategory

public String defaultCategory()

Specified by:

defaultCategory in interface Table<T extends TableCategory>

Overrides:

defaultCategory in class JdbcTable<T extends TableCategory>

defaultDisplayOrder

public int defaultDisplayOrder()

Specified by:

defaultDisplayOrder in interface Table<T extends TableCategory>

Overrides:

defaultDisplayOrder in class JdbcTable<T extends TableCategory>

ensure

public TableCategory ensure(String name)

Returns:

a newly created or existing TableCategory