org.melati.poem.generated
Class TableInfoTableBase

java.lang.Object
  org.melati.poem.JdbcTable
      org.melati.poem.PoemTable
          org.melati.poem.generated.TableInfoTableBase

All Implemented Interfaces:

Selectable, Table

Direct Known Subclasses:

TableInfoTable

public class TableInfoTableBase
extends PoemTable

Melati POEM generated base class for Table TableInfo.

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

Constructor Summary

TableInfoTableBase(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 String	defaultDisplayName() The `factory-default' display name for the table.
protected int	defaultDisplayOrder()
protected boolean	defaultRememberAllTroids()
Column	getCachelimitColumn() Retrieves the Cachelimit Column for this TableInfo Table.
Column	getCancreateColumn() Retrieves the Cancreate Column for this TableInfo Table.
Column	getCategoryColumn() Retrieves the Category Column for this TableInfo Table.
Column	getDefaultcandeleteColumn() Retrieves the Defaultcandelete Column for this TableInfo Table.
Column	getDefaultcanreadColumn() Retrieves the Defaultcanread Column for this TableInfo Table.
Column	getDefaultcanwriteColumn() Retrieves the Defaultcanwrite Column for this TableInfo Table.
Column	getDescriptionColumn() Retrieves the Description Column for this TableInfo Table.
Column	getDisplaynameColumn() Retrieves the Displayname Column for this TableInfo Table.
Column	getDisplayorderColumn() Retrieves the Displayorder Column for this TableInfo Table.
Column	getIdColumn() Retrieves the Id Column for this TableInfo Table.
Column	getNameColumn() Retrieves the Name Column for this TableInfo Table.
PoemDatabaseTables	getPoemDatabaseTables() Get the database tables.
Column	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() Override this to perform pre-unification initialisation.

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

TableInfoTableBase

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

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 JdbcTable

Throws:

PoemException

getIdColumn

public final Column getIdColumn()

Retrieves the Id Column for this TableInfo Table.

Returns:

the id Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getNameColumn

public final Column getNameColumn()

Retrieves the Name Column for this TableInfo Table.

Returns:

the name Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getDisplaynameColumn

public final Column getDisplaynameColumn()

Retrieves the Displayname Column for this TableInfo Table.

Returns:

the displayname Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getDescriptionColumn

public final Column getDescriptionColumn()

Retrieves the Description Column for this TableInfo Table.

Returns:

the description Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getDisplayorderColumn

public final Column getDisplayorderColumn()

Retrieves the Displayorder Column for this TableInfo Table.

Returns:

the displayorder Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getDefaultcanreadColumn

public final Column getDefaultcanreadColumn()

Retrieves the Defaultcanread Column for this TableInfo Table.

Returns:

the defaultcanread Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getDefaultcanwriteColumn

public final Column getDefaultcanwriteColumn()

Retrieves the Defaultcanwrite Column for this TableInfo Table.

Returns:

the defaultcanwrite Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getDefaultcandeleteColumn

public final Column getDefaultcandeleteColumn()

Retrieves the Defaultcandelete Column for this TableInfo Table.

Returns:

the defaultcandelete Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getCancreateColumn

public final Column getCancreateColumn()

Retrieves the Cancreate Column for this TableInfo Table.

Returns:

the cancreate Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getCachelimitColumn

public final Column getCachelimitColumn()

Retrieves the Cachelimit Column for this TableInfo Table.

Returns:

the cachelimit Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getSeqcachedColumn

public final Column getSeqcachedColumn()

Retrieves the Seqcached Column for this TableInfo Table.

Returns:

the seqcached Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getCategoryColumn

public final Column getCategoryColumn()

Retrieves the Category Column for this TableInfo Table.

Returns:

the category Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getTableInfoObject

public TableInfo getTableInfoObject(Integer troid)

Retrieve the TableInfo as a TableInfo.

Parameters:

troid - a Table Row Oject ID

Returns:

the Persistent identified by the troid

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

getTableInfoObject

public TableInfo getTableInfoObject(int troid)

Retrieve the TableInfo as a TableInfo.

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

defaultDisplayName

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

Overrides:

defaultDisplayName 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 JdbcTable