org.melati.poem
Class ColumnInfoTable

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
                      org.melati.poem.ColumnInfoTable

All Implemented Interfaces:

Selectable, Table

public class ColumnInfoTable
extends ColumnInfoTableBase

A Table which holds information about all Columns in a Database. If a database does not contain a table called columninfo it will be created. Melati POEM generated, programmer modifiable stub for a ColumnInfoTable object.

Description: Configuration information about a column in the database.

Field summary for SQL table ColumnInfo
Name	Type	Description
id	Integer
tableinfo	TableInfo	The table to which the field belongs
name	String	A code-name for the field
displayorder	Integer	A rank determining where the field appears in lists
usercreateable	Boolean	Whether it makes sense for the user to initialise the field's value
displaylevel	DisplayLevel	A category determining what granularity of report the field appears in
searchability	Searchability	A category determining what level of searching this field supports
displayorderpriority	Integer	If present, the level at which lists of records are sorted by the field
sortdescending	Boolean	Whether when sorting by this column, the sort order should be reversed
indexed	Boolean	Whether the field is indexed (ignored if the field is marked `unique')
unique	Boolean	Whether the field is unique (implies that it's `indexed')
integrityfix	StandardIntegrityFix	How referential integrity is maintained, what to do when the object referred to is deleted

Generator

org.melati.poem.prepro.TableDef#generateTableMainJava

Constructor Summary

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

Method Summary

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

_newPersistent, defaultCacheLimit, defaultCategory, defaultDescription, defaultDisplayName, defaultDisplayOrder, defaultRememberAllTroids, getColumnInfoObject, getColumnInfoObject, getDisplaylevelColumn, getDisplayorderColumn, getDisplayorderpriorityColumn, getIdColumn, getIndexedColumn, getIntegrityfixColumn, getNameColumn, getPoemDatabaseTables, getSearchabilityColumn, getSortdescendingColumn, getTableinfoColumn, getUniqueColumn, getUsercreateableColumn, init

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

ColumnInfoTable

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