org.melati.poem.generated

Class GroupTableBase<T extends Group>

java.lang.Object

org.melati.poem.JdbcTable<P>

org.melati.poem.PoemTable<T>

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

All Implemented Interfaces:

Selectable<T>, Table<T>

Direct Known Subclasses:

GroupTable

public class GroupTableBase<T extends Group>
extends PoemTable<T>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	defaultCategory()
String	defaultDescription() The `factory-default' description for the table, or null if it doesn't have one.
int	defaultDisplayOrder()
boolean	defaultRememberAllTroids()
Group	ensure(String name)
Group	getGroupObject(int troid) Retrieve the Group as a Group.
Group	getGroupObject(Integer troid) Retrieve the Group as a Group.
Column<Integer>	getIdColumn() Retrieves the Id Column for this group Table.
Column<String>	getNameColumn() Retrieves the Name Column for this group Table.
PoemDatabaseTables	getPoemDatabaseTables() Get the database tables.
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, defaultCacheLimit, defaultDisplayName, 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

GroupTableBase

public GroupTableBase(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 Group>

Overrides:

init in class JdbcTable<T extends Group>

Throws:

PoemException

getIdColumn

public final Column<Integer> getIdColumn()

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

Returns:

the id Column

getNameColumn

public final Column<String> getNameColumn()

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

Returns:

the name Column

getGroupObject

public Group getGroupObject(Integer troid)

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

Parameters:

troid - a Table Row Object ID

Returns:

the Persistent identified by the troid

getGroupObject

public Group getGroupObject(int troid)

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

Parameters:

troid - a Table Row Object ID

Returns:

the Persistent identified

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

Overrides:

defaultDescription in class JdbcTable<T extends Group>

defaultRememberAllTroids

public boolean defaultRememberAllTroids()

Specified by:

defaultRememberAllTroids in interface Table<T extends Group>

Overrides:

defaultRememberAllTroids in class JdbcTable<T extends Group>

defaultCategory

public String defaultCategory()

Specified by:

defaultCategory in interface Table<T extends Group>

Overrides:

defaultCategory in class JdbcTable<T extends Group>

defaultDisplayOrder

public int defaultDisplayOrder()

Specified by:

defaultDisplayOrder in interface Table<T extends Group>

Overrides:

defaultDisplayOrder in class JdbcTable<T extends Group>

ensure

public Group ensure(String name)

Returns:

a newly created or existing Group