org.melati.poem

Class CapabilityTable<T extends Capability>

java.lang.Object

org.melati.poem.JdbcTable<P>

org.melati.poem.PoemTable<T>

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

org.melati.poem.CapabilityTable<T>

All Implemented Interfaces:

Selectable<T>, Table<T>

public class CapabilityTable<T extends Capability>
extends CapabilityTableBase<T>

The Table of Capabilitys. Every Melati DB has this table. This table will contain at least _administer_. Melati POEM generated, programmer modifiable stub for a CapabilityTable object.

Description: A capability which users can be required to possess before accessing data.

Field summary for SQL table Capability

Name	Type	Description
id	Integer	The Table Row Object ID
name	String	A human-readable name for the capability

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Capability	ensure(String name) Make sure that a record exists.
Capability	get(String name) Retrieve a Capability by name.
void	unifyWithDB(ResultSet colDescs, String troidColumnName) Ensure that the _administer_ Capability exists and apply it to this table, also create canRead, canWrite, candelete and canSelect as they are referrred to in column definition.

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

defaultCategory, defaultDescription, defaultDisplayOrder, defaultRememberAllTroids, getCapabilityObject, getCapabilityObject, getIdColumn, getNameColumn, getPoemDatabaseTables, 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, defaultCacheLimit, defaultDisplayName, 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, unifyWithMetadata, whereClause, whereClause, writeDown

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CapabilityTable

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

Method Detail

unifyWithDB

public void unifyWithDB(ResultSet colDescs,
                        String troidColumnName)
                 throws PoemException

Ensure that the _administer_ Capability exists and apply it to this table, also create canRead, canWrite, candelete and canSelect as they are referrred to in column definition.

Specified by:

unifyWithDB in interface Table<T extends Capability>

Overrides:

unifyWithDB in class JdbcTable<T extends Capability>

Parameters:

colDescs - the Column descriptions

troidColumnName - name of primary key column

Throws:

PoemException

See Also:

Table.defineColumn(Column)

get

public Capability get(String name)

Retrieve a Capability by name.

Parameters:

name - the name of the Capability to return

Returns:

the existing Capability

ensure

public Capability ensure(String name)

Make sure that a record exists.

Overrides:

ensure in class CapabilityTableBase<T extends Capability>

Parameters:

name - the name of the Capability to ensure

Returns:

the existing or newly created Capability