org.melati.poem.generated

Class CapabilityTableBase<T extends Capability>

java.lang.Object

org.melati.poem.JdbcTable<P>

org.melati.poem.PoemTable<T>

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

All Implemented Interfaces:

Selectable<T>, Table<T>

Direct Known Subclasses:

CapabilityTable

public class CapabilityTableBase<T extends Capability>
extends PoemTable<T>

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

Constructor Summary

Constructors

Constructor and Description
CapabilityTableBase(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()
Capability	ensure(String name)
Capability	getCapabilityObject(int troid) Retrieve the Capability as a Capability.
Capability	getCapabilityObject(Integer troid) Retrieve the Capability as a Capability.
Column<Integer>	getIdColumn() Retrieves the Id Column for this capability Table.
Column<String>	getNameColumn() Retrieves the Name Column for this capability 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, 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

CapabilityTableBase

public CapabilityTableBase(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 Capability>

Overrides:

init in class JdbcTable<T extends Capability>

Throws:

PoemException

getIdColumn

public final Column<Integer> getIdColumn()

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

Returns:

the id Column

getNameColumn

public final Column<String> getNameColumn()

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

Returns:

the name Column

getCapabilityObject

public Capability getCapabilityObject(Integer troid)

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

Parameters:

troid - a Table Row Object ID

Returns:

the Persistent identified by the troid

getCapabilityObject

public Capability getCapabilityObject(int troid)

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

Overrides:

defaultDescription in class JdbcTable<T extends Capability>

defaultRememberAllTroids

public boolean defaultRememberAllTroids()

Specified by:

defaultRememberAllTroids in interface Table<T extends Capability>

Overrides:

defaultRememberAllTroids in class JdbcTable<T extends Capability>

defaultCategory

public String defaultCategory()

Specified by:

defaultCategory in interface Table<T extends Capability>

Overrides:

defaultCategory in class JdbcTable<T extends Capability>

defaultDisplayOrder

public int defaultDisplayOrder()

Specified by:

defaultDisplayOrder in interface Table<T extends Capability>

Overrides:

defaultDisplayOrder in class JdbcTable<T extends Capability>

ensure

public Capability ensure(String name)

Returns:

a newly created or existing Capability