org.melati.poem.generated

Class ColumnInfoTableBase<T extends ColumnInfo>

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.ColumnInfoTableBase<T>

All Implemented Interfaces:

Selectable<T>, Table<T>

Direct Known Subclasses:

ColumnInfoTable

public class ColumnInfoTableBase<T extends ColumnInfo>
extends ValueInfoTable<T>

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

Constructor Summary

Constructors

Constructor and Description
ColumnInfoTableBase(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.
String	defaultDisplayName() The `factory-default' display name for the table.
int	defaultDisplayOrder()
boolean	defaultRememberAllTroids()
ColumnInfo	getColumnInfoObject(int troid) Retrieve the ColumnInfo as a ColumnInfo.
ColumnInfo	getColumnInfoObject(Integer troid) Retrieve the ColumnInfo as a ColumnInfo.
Column<Integer>	getDisplaylevelColumn() Retrieves the Displaylevel Column for this columnInfo Table.
Column<Integer>	getDisplayorderColumn() Retrieves the Displayorder Column for this columnInfo Table.
Column<Integer>	getDisplayorderpriorityColumn() Retrieves the Displayorderpriority Column for this columnInfo Table.
Column<Integer>	getIdColumn() Retrieves the Id Column for this columnInfo Table.
Column<Boolean>	getIndexedColumn() Retrieves the Indexed Column for this columnInfo Table.
Column<Integer>	getIntegrityfixColumn() Retrieves the Integrityfix Column for this columnInfo Table.
Column<String>	getNameColumn() Retrieves the Name Column for this columnInfo Table.
PoemDatabaseTables	getPoemDatabaseTables() Get the database tables.
Column<Integer>	getSearchabilityColumn() Retrieves the Searchability Column for this columnInfo Table.
Column<Boolean>	getSortdescendingColumn() Retrieves the Sortdescending Column for this columnInfo Table.
Column<Integer>	getTableinfoColumn() Retrieves the Tableinfo Column for this columnInfo Table.
Column<Boolean>	getUniqueColumn() Retrieves the Unique Column for this columnInfo Table.
Column<Boolean>	getUsercreateableColumn() Retrieves the Usercreateable Column for this columnInfo 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, 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

ColumnInfoTableBase

public ColumnInfoTableBase(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 ColumnInfo>

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

Overrides:

init in class ValueInfoTableBase<T extends ColumnInfo>

Throws:

PoemException

getIdColumn

public final Column<Integer> getIdColumn()

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

Returns:

the id Column

getTableinfoColumn

public final Column<Integer> getTableinfoColumn()

Retrieves the Tableinfo Column for this columnInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the tableinfo Column

getNameColumn

public final Column<String> getNameColumn()

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

Returns:

the name Column

getDisplayorderColumn

public final Column<Integer> getDisplayorderColumn()

Retrieves the Displayorder Column for this columnInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the displayorder Column

getUsercreateableColumn

public final Column<Boolean> getUsercreateableColumn()

Retrieves the Usercreateable Column for this columnInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the usercreateable Column

getDisplaylevelColumn

public final Column<Integer> getDisplaylevelColumn()

Retrieves the Displaylevel Column for this columnInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the displaylevel Column

getSearchabilityColumn

public final Column<Integer> getSearchabilityColumn()

Retrieves the Searchability Column for this columnInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the searchability Column

getDisplayorderpriorityColumn

public final Column<Integer> getDisplayorderpriorityColumn()

Retrieves the Displayorderpriority Column for this columnInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the displayorderpriority Column

getSortdescendingColumn

public final Column<Boolean> getSortdescendingColumn()

Retrieves the Sortdescending Column for this columnInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the sortdescending Column

getIndexedColumn

public final Column<Boolean> getIndexedColumn()

Retrieves the Indexed Column for this columnInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the indexed Column

getUniqueColumn

public final Column<Boolean> getUniqueColumn()

Retrieves the Unique Column for this columnInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the unique Column

getIntegrityfixColumn

public final Column<Integer> getIntegrityfixColumn()

Retrieves the Integrityfix Column for this columnInfo Table. see org.melati.poem.prepro.FieldDef#generateColAccessor

Returns:

the integrityfix Column

getColumnInfoObject

public ColumnInfo getColumnInfoObject(Integer troid)

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

Parameters:

troid - a Table Row Object ID

Returns:

the Persistent identified by the troid

getColumnInfoObject

public ColumnInfo getColumnInfoObject(int troid)

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

Parameters:

troid - a Table Row Object ID

Returns:

the Persistent identified

defaultDisplayName

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

Specified by:

defaultDisplayName in interface Table<T extends ColumnInfo>

Overrides:

defaultDisplayName in class JdbcTable<T extends ColumnInfo>

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

Overrides:

defaultDescription in class JdbcTable<T extends ColumnInfo>

defaultRememberAllTroids

public boolean defaultRememberAllTroids()

Specified by:

defaultRememberAllTroids in interface Table<T extends ColumnInfo>

Overrides:

defaultRememberAllTroids in class JdbcTable<T extends ColumnInfo>

defaultCacheLimit

public Integer defaultCacheLimit()

Specified by:

defaultCacheLimit in interface Table<T extends ColumnInfo>

Overrides:

defaultCacheLimit in class JdbcTable<T extends ColumnInfo>

defaultCategory

public String defaultCategory()

Specified by:

defaultCategory in interface Table<T extends ColumnInfo>

Overrides:

defaultCategory in class JdbcTable<T extends ColumnInfo>

defaultDisplayOrder

public int defaultDisplayOrder()

Specified by:

defaultDisplayOrder in interface Table<T extends ColumnInfo>

Overrides:

defaultDisplayOrder in class ValueInfoTableBase<T extends ColumnInfo>