org.melati.poem.generated
Class ColumnInfoTableBase

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

All Implemented Interfaces:

Selectable, Table

Direct Known Subclasses:

ColumnInfoTable

public class ColumnInfoTableBase
extends ValueInfoTable

Melati POEM generated base class for Table ColumnInfo.

See Also:

org.melati.poem.prepro.TableDef#generateTableBaseJava

Constructor Summary

ColumnInfoTableBase(Database database, java.lang.String name, DefinitionSource definitionSource)
Constructor.

Method Summary

protected JdbcPersistent	_newPersistent() A freshly minted, and uninitialised, Persistent object for the table.
protected java.lang.Integer	defaultCacheLimit()
protected java.lang.String	defaultCategory()
protected java.lang.String	defaultDescription() The `factory-default' description for the table, or null if it doesn't have one.
protected java.lang.String	defaultDisplayName() The `factory-default' display name for the table.
protected int	defaultDisplayOrder()
protected boolean	defaultRememberAllTroids()
ColumnInfo	getColumnInfoObject(int troid) Retrieve the ColumnInfo as a ColumnInfo.
ColumnInfo	getColumnInfoObject(java.lang.Integer troid) Retrieve the ColumnInfo as a ColumnInfo.
Column	getDisplaylevelColumn() Retrieves the Displaylevel Column for this ColumnInfo Table.
Column	getDisplayorderColumn() Retrieves the Displayorder Column for this ColumnInfo Table.
Column	getDisplayorderpriorityColumn() Retrieves the Displayorderpriority Column for this ColumnInfo Table.
Column	getIdColumn() Retrieves the Id Column for this ColumnInfo Table.
Column	getIndexedColumn() Retrieves the Indexed Column for this ColumnInfo Table.
Column	getIntegrityfixColumn() Retrieves the Integrityfix Column for this ColumnInfo Table.
Column	getNameColumn() Retrieves the Name Column for this ColumnInfo Table.
PoemDatabaseTables	getPoemDatabaseTables() Get the database tables.
Column	getSearchabilityColumn() Retrieves the Searchability Column for this ColumnInfo Table.
Column	getSortdescendingColumn() Retrieves the Sortdescending Column for this ColumnInfo Table.
Column	getTableinfoColumn() Retrieves the Tableinfo Column for this ColumnInfo Table.
Column	getUniqueColumn() Retrieves the Unique Column for this ColumnInfo Table.
Column	getUsercreateableColumn() Retrieves the Usercreateable Column for this ColumnInfo 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, 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

ColumnInfoTableBase

public ColumnInfoTableBase(Database database,
                           java.lang.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:

org.melati.poem.prepro.TableDef#generateTableBaseJava

Method Detail

getPoemDatabaseTables

public PoemDatabaseTables getPoemDatabaseTables()

Get the database tables.

Overrides:

getPoemDatabaseTables in class ValueInfoTableBase

Returns:

the database tables

See Also:

org.melati.poem.prepro.TableDef#generateTableBaseJava

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

Returns:

the id Column

See Also:

org.melati.poem.prepro.FieldDef#generateColAccessor

getTableinfoColumn

public final Column getTableinfoColumn()

Retrieves the Tableinfo Column for this ColumnInfo Table.

Returns:

the tableinfo Column

See Also:

org.melati.poem.prepro.FieldDef#generateColAccessor

getNameColumn

public final Column getNameColumn()

Retrieves the Name Column for this ColumnInfo Table.

Returns:

the name Column

See Also:

org.melati.poem.prepro.FieldDef#generateColAccessor

getDisplayorderColumn

public final Column getDisplayorderColumn()

Retrieves the Displayorder Column for this ColumnInfo Table.

Returns:

the displayorder Column

See Also:

org.melati.poem.prepro.FieldDef#generateColAccessor

getUsercreateableColumn

public final Column getUsercreateableColumn()

Retrieves the Usercreateable Column for this ColumnInfo Table.

Returns:

the usercreateable Column

See Also:

org.melati.poem.prepro.FieldDef#generateColAccessor

getDisplaylevelColumn

public final Column getDisplaylevelColumn()

Retrieves the Displaylevel Column for this ColumnInfo Table.

Returns:

the displaylevel Column

See Also:

org.melati.poem.prepro.FieldDef#generateColAccessor

getSearchabilityColumn

public final Column getSearchabilityColumn()

Retrieves the Searchability Column for this ColumnInfo Table.

Returns:

the searchability Column

See Also:

org.melati.poem.prepro.FieldDef#generateColAccessor

getDisplayorderpriorityColumn

public final Column getDisplayorderpriorityColumn()

Retrieves the Displayorderpriority Column for this ColumnInfo Table.

Returns:

the displayorderpriority Column

See Also:

org.melati.poem.prepro.FieldDef#generateColAccessor

getSortdescendingColumn

public final Column getSortdescendingColumn()

Retrieves the Sortdescending Column for this ColumnInfo Table.

Returns:

the sortdescending Column

See Also:

org.melati.poem.prepro.FieldDef#generateColAccessor

getIndexedColumn

public final Column getIndexedColumn()

Retrieves the Indexed Column for this ColumnInfo Table.

Returns:

the indexed Column

See Also:

org.melati.poem.prepro.FieldDef#generateColAccessor

getUniqueColumn

public final Column getUniqueColumn()

Retrieves the Unique Column for this ColumnInfo Table.

Returns:

the unique Column

See Also:

org.melati.poem.prepro.FieldDef#generateColAccessor

getIntegrityfixColumn

public final Column getIntegrityfixColumn()

Retrieves the Integrityfix Column for this ColumnInfo Table.

Returns:

the integrityfix Column

See Also:

org.melati.poem.prepro.FieldDef#generateColAccessor

getColumnInfoObject

public ColumnInfo getColumnInfoObject(java.lang.Integer troid)

Retrieve the ColumnInfo as a ColumnInfo.

Parameters:

troid - a Table Row Oject ID

Returns:

the Persistent identified by the troid

See Also:

org.melati.poem.prepro.TableDef#generateTableBaseJava

getColumnInfoObject

public ColumnInfo getColumnInfoObject(int troid)

Retrieve the ColumnInfo as a ColumnInfo.

Parameters:

troid - a Table Row Object ID

Returns:

the Persistent identified

See Also:

org.melati.poem.prepro.TableDef#generateTableBaseJava

_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 java.lang.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 java.lang.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 java.lang.Integer defaultCacheLimit()

Overrides:

defaultCacheLimit in class JdbcTable

defaultCategory

protected java.lang.String defaultCategory()

Overrides:

defaultCategory in class JdbcTable

defaultDisplayOrder

protected int defaultDisplayOrder()

Overrides:

defaultDisplayOrder in class ValueInfoTableBase