org.melati.poem.generated

Class SettingTableBase<T extends Setting>

java.lang.Object

org.melati.poem.JdbcTable<P>

org.melati.poem.PoemTable<T>

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

org.melati.poem.ValueInfoTable<T>

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

All Implemented Interfaces:

Selectable<T>, Table<T>

Direct Known Subclasses:

SettingTable

public class SettingTableBase<T extends Setting>
extends ValueInfoTable<T>

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

Constructor Summary

Constructors

Constructor and Description
SettingTableBase(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.
int	defaultDisplayOrder()
boolean	defaultRememberAllTroids()
Setting	ensure(String name)
Column<Integer>	getIdColumn() Retrieves the Id Column for this setting Table.
Column<String>	getNameColumn() Retrieves the Name Column for this setting Table.
PoemDatabaseTables	getPoemDatabaseTables() Get the database tables.
Setting	getSettingObject(int troid) Retrieve the Setting as a Setting.
Setting	getSettingObject(Integer troid) Retrieve the Setting as a Setting.
Column<String>	getValueColumn() Retrieves the Value Column for this setting Table.
void	init() Initialise this table by defining its columns.

Methods inherited from class org.melati.poem.generated.ValueInfoTableBase

getDescriptionColumn, getDisplaynameColumn, getHeightColumn, getNullableColumn, getPrecisionColumn, getRangelimit_stringColumn, getRangelow_stringColumn, getRenderinfoColumn, getScaleColumn, getSizeColumn, getTypefactoryColumn, getUsereditableColumn, getValueInfoObject, getValueInfoObject, getWidthColumn

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

SettingTableBase

public SettingTableBase(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

Overrides:

getPoemDatabaseTables in class ValueInfoTableBase<T extends Setting>

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

Overrides:

init in class ValueInfoTableBase<T extends Setting>

Throws:

PoemException

getIdColumn

public final Column<Integer> getIdColumn()

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

Returns:

the id Column

getNameColumn

public final Column<String> getNameColumn()

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

Returns:

the name Column

getValueColumn

public final Column<String> getValueColumn()

Retrieves the Value Column for this setting Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the value Column

getSettingObject

public Setting getSettingObject(Integer troid)

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

Parameters:

troid - a Table Row Object ID

Returns:

the Persistent identified by the troid

getSettingObject

public Setting getSettingObject(int troid)

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

Overrides:

defaultDescription in class JdbcTable<T extends Setting>

defaultRememberAllTroids

public boolean defaultRememberAllTroids()

Specified by:

defaultRememberAllTroids in interface Table<T extends Setting>

Overrides:

defaultRememberAllTroids in class JdbcTable<T extends Setting>

defaultCacheLimit

public Integer defaultCacheLimit()

Specified by:

defaultCacheLimit in interface Table<T extends Setting>

Overrides:

defaultCacheLimit in class JdbcTable<T extends Setting>

defaultCategory

public String defaultCategory()

Specified by:

defaultCategory in interface Table<T extends Setting>

Overrides:

defaultCategory in class JdbcTable<T extends Setting>

defaultDisplayOrder

public int defaultDisplayOrder()

Specified by:

defaultDisplayOrder in interface Table<T extends Setting>

Overrides:

defaultDisplayOrder in class ValueInfoTableBase<T extends Setting>

ensure

public Setting ensure(String name)

Returns:

a newly created or existing Setting