org.melati.poem
Class TableInfo

java.lang.Object
  org.melati.poem.transaction.Transactioned
      org.melati.poem.JdbcPersistent
          org.melati.poem.generated.TableInfoBase
              org.melati.poem.TableInfo

All Implemented Interfaces:

Cloneable, Persistable, Persistent, Treeable

public class TableInfo
extends TableInfoBase

All the data defining a Table; actually a Persistent from the TableInfoTable. Melati POEM generated, programmer modifiable stub for a Persistent TableInfo 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#generateMainJava

Field Summary

Fields inherited from class org.melati.poem.generated.TableInfoBase

cachelimit, cancreate, category, defaultcandelete, defaultcanread, defaultcanwrite, description, displayname, displayorder, id, name, seqcached

Fields inherited from class org.melati.poem.transaction.Transactioned

valid

Constructor Summary

TableInfo()
Constructor for a Persistent TableInfo object.

TableInfo(JdbcTable table)
Constructor creates a TableInfo from a Table.

Method Summary

Table	actualTable() Get the Table this is about.
void	assertCanRead(AccessToken token) Allow this object to be read by anyone.
void	setCachelimit(Integer limit) Set here and in table we represent.
void	setName(String name) Overridden to disallow table renaming.
void	setSeqcached(Boolean b) Set here and in table we represent.

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

getCachelimit_unsafe, getCachelimit, getCachelimitField, getCancreate_unsafe, getCancreate, getCancreateField, getCancreateTroid, getCategory_unsafe, getCategory, getCategoryField, getCategoryTroid, getDefaultcandelete_unsafe, getDefaultcandelete, getDefaultcandeleteField, getDefaultcandeleteTroid, getDefaultcanread_unsafe, getDefaultcanread, getDefaultcanreadField, getDefaultcanreadTroid, getDefaultcanwrite_unsafe, getDefaultcanwrite, getDefaultcanwriteField, getDefaultcanwriteTroid, getDescription_unsafe, getDescription, getDescriptionField, getDisplayname_unsafe, getDisplayname, getDisplaynameField, getDisplayorder_unsafe, getDisplayorder, getDisplayorderField, getId_unsafe, getId, getIdField, getName_unsafe, getName, getNameField, getPoemDatabaseTables, getSeqcached_unsafe, getSeqcached, getSeqcachedField, getTableInfoTable, setCachelimit_unsafe, setCachelimit, setCancreate_unsafe, setCancreate, setCancreateTroid, setCategory_unsafe, setCategory, setCategoryTroid, setDefaultcandelete_unsafe, setDefaultcandelete, setDefaultcandeleteTroid, setDefaultcanread_unsafe, setDefaultcanread, setDefaultcanreadTroid, setDefaultcanwrite_unsafe, setDefaultcanwrite, setDefaultcanwriteTroid, setDescription_unsafe, setDescription, setDisplayname_unsafe, setDisplayname, setDisplayorder_unsafe, setDisplayorder, setDisplayorder, setId_unsafe, setId, setId, setName_unsafe, setSeqcached_unsafe, setSeqcached

Methods inherited from class org.melati.poem.JdbcPersistent

assertCanCreate, assertCanCreate, assertCanDelete, assertCanDelete, assertCanRead, assertCanWrite, assertCanWrite, clone, commit, countMatchSQL, delete_unsafe, delete, delete, deleteAndCommit, deleteAndCommit, deleteLock, displayString, displayString, displayString, dump, dump, duplicated, duplicatedFloating, equals, existenceLock, existenceLock, fieldsOfColumns, fromClause, getCanDelete, getCanRead, getCanSelect, getCanWrite, getChildren, getCooked, getCookedString, getDatabase, getDetailDisplayFields, getField, getFields, getPrimaryDisplayField, getRaw, getRawString, getReadable, getRecordDisplayFields, getSearchCriterionFields, getSummaryDisplayFields, getTable, getTroid, hashCode, invalidate, isDirty, load, makePersistent, postEdit, postInsert, postModify, postWrite, preEdit, readLock, readLock, readLock, rollback, setCooked, setDirty, setRaw, setRawString, statusExistent, statusNonexistent, toString, troid, upToDate, writeDown, writeLock, writeLock, writeLock

Methods inherited from class org.melati.poem.transaction.Transactioned

markValid, reset, setTransactionPool, transactionPool, unSee

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TableInfo

public TableInfo()

Constructor for a Persistent TableInfo object.

Description: Configuration information about a table in the database.

Generator

org.melati.poem.prepro.TableDef#generateMainJava

TableInfo

public TableInfo(JdbcTable table)

Constructor creates a TableInfo from a Table. Note This must be overridden if you extend TableInfo in your DSD.

Parameters:

table - from which to get metadata

Method Detail

actualTable

public Table actualTable()

Get the Table this is about.

Returns:

The table this object represents.

assertCanRead

public void assertCanRead(AccessToken token)

Allow this object to be read by anyone.

Specified by:

assertCanRead in interface Persistent

Overrides:

assertCanRead in class JdbcPersistent

Parameters:

token - any AccessToken

See Also:

Persistent.assertCanRead(org.melati.poem.AccessToken)

setName

public void setName(String name)

Overridden to disallow table renaming.

Overrides:

setName in class TableInfoBase

Parameters:

name - a validated int

See Also:

TableInfoBase.setName(java.lang.String)

setSeqcached

public void setSeqcached(Boolean b)
                  throws AccessPoemException

Set here and in table we represent.

Overrides:

setSeqcached in class TableInfoBase

Parameters:

b - a validated int

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

TableInfoBase.setSeqcached(java.lang.Boolean)

setCachelimit

public void setCachelimit(Integer limit)
                   throws AccessPoemException

Set here and in table we represent.

Overrides:

setCachelimit in class TableInfoBase

Parameters:

limit - a validated int

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

See Also:

TableInfoBase.setCachelimit(java.lang.Integer)