org.melati.poem.generated
Class SettingTableBase

java.lang.Object
  org.melati.poem.JdbcTable
      org.melati.poem.PoemTable
          org.melati.poem.generated.ValueInfoTableBase
              org.melati.poem.ValueInfoTable
                  org.melati.poem.generated.SettingTableBase

All Implemented Interfaces:

Selectable, Table

Direct Known Subclasses:

SettingTable

public class SettingTableBase
extends ValueInfoTable

Melati POEM generated base class for Table Setting.

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

Constructor Summary

SettingTableBase(Database database, String name, DefinitionSource definitionSource)
Constructor.

Method Summary

protected JdbcPersistent	_newPersistent() A freshly minted, and uninitialised, Persistent object for the table.
protected Integer	defaultCacheLimit()
protected String	defaultCategory()
protected String	defaultDescription() The `factory-default' description for the table, or null if it doesn't have one.
protected int	defaultDisplayOrder()
protected boolean	defaultRememberAllTroids()
Column	getIdColumn() Retrieves the Id Column for this Setting Table.
Column	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	getValueColumn() Retrieves the Value Column for this Setting Table.
void	init() Override this to perform pre-unification initialisation.

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

_getColumn, addColumnAndCommit, addListener, appendWhereClause, 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, getColumnsCount, getDatabase, getDbmsTableType, getDefaultCanDelete, getDefaultCanRead, getDefaultCanWrite, getDescription, getDetailDisplayColumns, getDetailDisplayColumnsCount, getDisplayName, getDsdName, 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, whereClause, whereClause, writeDown

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SettingTableBase

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

Constructor.

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

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

Method Detail

getPoemDatabaseTables

public PoemDatabaseTables getPoemDatabaseTables()

Get the database tables.

Overrides:

getPoemDatabaseTables in class ValueInfoTableBase

Returns:

the database tables

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

init

public void init()
          throws PoemException

Description copied from class: JdbcTable

Override this to perform pre-unification initialisation.

Specified by:

init in interface Table

Overrides:

init in class ValueInfoTableBase

Throws:

PoemException

getIdColumn

public final Column getIdColumn()

Retrieves the Id Column for this Setting Table.

Returns:

the id Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getNameColumn

public final Column getNameColumn()

Retrieves the Name Column for this Setting Table.

Returns:

the name Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getValueColumn

public final Column getValueColumn()

Retrieves the Value Column for this Setting Table.

Returns:

the value Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getSettingObject

public Setting getSettingObject(Integer troid)

Retrieve the Setting as a Setting.

Parameters:

troid - a Table Row Oject ID

Returns:

the Persistent identified by the troid

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

getSettingObject

public Setting getSettingObject(int troid)

Retrieve the Setting as a Setting.

Parameters:

troid - a Table Row Object ID

Returns:

the Persistent identified

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

_newPersistent

protected JdbcPersistent _newPersistent()

Description copied from class: JdbcTable

A freshly minted, and uninitialised, Persistent object for the table. You don't ever have to call this and there is no point in doing so This method is overridden in application-specialised Table subclasses derived from the Data Structure Definition.

Overrides:

_newPersistent in class JdbcTable

defaultDescription

protected 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.

Overrides:

defaultDescription in class JdbcTable

defaultRememberAllTroids

protected boolean defaultRememberAllTroids()

Overrides:

defaultRememberAllTroids in class JdbcTable

defaultCacheLimit

protected Integer defaultCacheLimit()

Overrides:

defaultCacheLimit in class JdbcTable

defaultCategory

protected String defaultCategory()

Overrides:

defaultCategory in class JdbcTable

defaultDisplayOrder

protected int defaultDisplayOrder()

Overrides:

defaultDisplayOrder in class ValueInfoTableBase