org.melati.poem.generated

Class TableInfoTableBase<T extends TableInfo>

java.lang.Object

org.melati.poem.JdbcTable<P>

org.melati.poem.PoemTable<T>

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

All Implemented Interfaces:

Selectable<T>, Table<T>

Direct Known Subclasses:

TableInfoTable

public class TableInfoTableBase<T extends TableInfo>
extends PoemTable<T>

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

Constructor Summary

Constructors

Constructor and Description
TableInfoTableBase(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()
TableInfo	ensure(String name, String displayname, Integer displayorder, Boolean seqcached, TableCategory category)
Column<Integer>	getCachelimitColumn() Retrieves the Cachelimit Column for this tableInfo Table.
Column<Integer>	getCancreateColumn() Retrieves the Cancreate Column for this tableInfo Table.
Column<Integer>	getCategoryColumn() Retrieves the Category Column for this tableInfo Table.
Column<Integer>	getDefaultcandeleteColumn() Retrieves the Defaultcandelete Column for this tableInfo Table.
Column<Integer>	getDefaultcanreadColumn() Retrieves the Defaultcanread Column for this tableInfo Table.
Column<Integer>	getDefaultcanwriteColumn() Retrieves the Defaultcanwrite Column for this tableInfo Table.
Column<String>	getDescriptionColumn() Retrieves the Description Column for this tableInfo Table.
Column<String>	getDisplaynameColumn() Retrieves the Displayname Column for this tableInfo Table.
Column<Integer>	getDisplayorderColumn() Retrieves the Displayorder Column for this tableInfo Table.
Column<Integer>	getIdColumn() Retrieves the Id Column for this tableInfo Table.
Column<String>	getNameColumn() Retrieves the Name Column for this tableInfo Table.
PoemDatabaseTables	getPoemDatabaseTables() Get the database tables.
Column<Boolean>	getSeqcachedColumn() Retrieves the Seqcached Column for this tableInfo Table.
TableInfo	getTableInfoObject(int troid) Retrieve the TableInfo as a TableInfo.
TableInfo	getTableInfoObject(Integer troid) Retrieve the TableInfo as a TableInfo.
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

TableInfoTableBase

public TableInfoTableBase(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 TableInfo>

Overrides:

init in class JdbcTable<T extends TableInfo>

Throws:

PoemException

getIdColumn

public final Column<Integer> getIdColumn()

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

Returns:

the id Column

getNameColumn

public final Column<String> getNameColumn()

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

Returns:

the name Column

getDisplaynameColumn

public final Column<String> getDisplaynameColumn()

Retrieves the Displayname Column for this tableInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the displayname Column

getDescriptionColumn

public final Column<String> getDescriptionColumn()

Retrieves the Description Column for this tableInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the description Column

getDisplayorderColumn

public final Column<Integer> getDisplayorderColumn()

Retrieves the Displayorder Column for this tableInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the displayorder Column

getDefaultcanreadColumn

public final Column<Integer> getDefaultcanreadColumn()

Retrieves the Defaultcanread Column for this tableInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the defaultcanread Column

getDefaultcanwriteColumn

public final Column<Integer> getDefaultcanwriteColumn()

Retrieves the Defaultcanwrite Column for this tableInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the defaultcanwrite Column

getDefaultcandeleteColumn

public final Column<Integer> getDefaultcandeleteColumn()

Retrieves the Defaultcandelete Column for this tableInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the defaultcandelete Column

getCancreateColumn

public final Column<Integer> getCancreateColumn()

Retrieves the Cancreate Column for this tableInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the cancreate Column

getCachelimitColumn

public final Column<Integer> getCachelimitColumn()

Retrieves the Cachelimit Column for this tableInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the cachelimit Column

getSeqcachedColumn

public final Column<Boolean> getSeqcachedColumn()

Retrieves the Seqcached Column for this tableInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the seqcached Column

getCategoryColumn

public final Column<Integer> getCategoryColumn()

Retrieves the Category Column for this tableInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the category Column

getTableInfoObject

public TableInfo getTableInfoObject(Integer troid)

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

Parameters:

troid - a Table Row Object ID

Returns:

the Persistent identified by the troid

getTableInfoObject

public TableInfo getTableInfoObject(int troid)

Retrieve the TableInfo as a TableInfo. 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 TableInfo>

Overrides:

defaultDisplayName in class JdbcTable<T extends TableInfo>

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 TableInfo>

Overrides:

defaultDescription in class JdbcTable<T extends TableInfo>

defaultRememberAllTroids

public boolean defaultRememberAllTroids()

Specified by:

defaultRememberAllTroids in interface Table<T extends TableInfo>

Overrides:

defaultRememberAllTroids in class JdbcTable<T extends TableInfo>

defaultCacheLimit

public Integer defaultCacheLimit()

Specified by:

defaultCacheLimit in interface Table<T extends TableInfo>

Overrides:

defaultCacheLimit in class JdbcTable<T extends TableInfo>

defaultCategory

public String defaultCategory()

Specified by:

defaultCategory in interface Table<T extends TableInfo>

Overrides:

defaultCategory in class JdbcTable<T extends TableInfo>

defaultDisplayOrder

public int defaultDisplayOrder()

Specified by:

defaultDisplayOrder in interface Table<T extends TableInfo>

Overrides:

defaultDisplayOrder in class JdbcTable<T extends TableInfo>

ensure

public TableInfo ensure(String name,
                        String displayname,
                        Integer displayorder,
                        Boolean seqcached,
                        TableCategory category)

Returns:

a newly created or existing TableInfo