org.melati.poem
Class TableInfoTable

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

All Implemented Interfaces:

Selectable, Table

public class TableInfoTable
extends TableInfoTableBase

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

Generator

org.melati.poem.prepro.TableDef#generateTableMainJava

Constructor Summary

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

Method Summary

protected TableInfo

defaultTableInfoFor(Table table) Create a TableInfo of the correct type for our DB.

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

_newPersistent, defaultCacheLimit, defaultCategory, defaultDescription, defaultDisplayName, defaultDisplayOrder, defaultRememberAllTroids, 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

_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

TableInfoTable

public TableInfoTable(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

Generator

org.melati.poem.prepro.TableDef#generateTableMainJava

Method Detail

defaultTableInfoFor

protected TableInfo defaultTableInfoFor(Table table)

Create a TableInfo of the correct type for our DB. NOTE you should override this if you extend TableInfo in your own db.

Parameters:

table - the Table to get metadata from.

Returns:

a new TableInfo Persistent