org.melati.poem

Class TableInfoTable<T extends TableInfo>

java.lang.Object

org.melati.poem.JdbcTable<P>

org.melati.poem.PoemTable<T>

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

org.melati.poem.TableInfoTable<T>

All Implemented Interfaces:

Selectable<T>, Table<T>

public class TableInfoTable<T extends TableInfo>
extends TableInfoTableBase<T>

A Table which holds information about all Tables in the Database. If a database does not contain a table called tableinfo it will be created during the unification phase of startup. see Database#unifyWithDB Note that when overriding you need to override defaultTableInfoFor. Melati POEM generated, programmer modifiable stub for a TableInfoTable object.

Description: Configuration information about a table in the database.

Field summary for SQL table TableInfo

Name	Type	Description
id	Integer	The Table Row Object ID
name	String	A code-name for the table
displayname	String	A user-friendly name for the table
description	String	A brief description of the table's function
displayorder	Integer	A rank determining where the table appears in the list of all tables
defaultcanread	Capability	The capability required, by default, for reading the table's records
defaultcanwrite	Capability	The capability required, by default, for updating the table's records
defaultcandelete	Capability	The capability required, by default, for deleting the table's records
cancreate	Capability	The capability required, by default, for creating records in the table
cachelimit	Integer	The maximum number of records from the table to keep in the cache
seqcached	Boolean	Whether the display sequence for the table's records is cached
category	TableCategory	Which category the table falls into

See org.melati.poem.prepro.TableDef#generateTableMainJava

Constructor Summary

Constructors

Constructor and Description
TableInfoTable(Database database, String name, DefinitionSource definitionSource) Constructor.

Method Summary

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

defaultCacheLimit, defaultCategory, defaultDescription, defaultDisplayName, defaultDisplayOrder, defaultRememberAllTroids, ensure, getCachelimitColumn, getCancreateColumn, getCategoryColumn, getDefaultcandeleteColumn, getDefaultcanreadColumn, getDefaultcanwriteColumn, getDescriptionColumn, getDisplaynameColumn, getDisplayorderColumn, getIdColumn, getNameColumn, getPoemDatabaseTables, getSeqcachedColumn, getTableInfoObject, getTableInfoObject, init

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

TableInfoTable

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

Constructor. See org.melati.poem.prepro.TableDef#generateTableMainJava

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