org.melati.poem

Class UserTable<T extends User>

java.lang.Object

org.melati.poem.JdbcTable<P>

org.melati.poem.PoemTable<T>

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

org.melati.poem.UserTable<T>

All Implemented Interfaces:

Selectable<T>, Table<T>

public class UserTable<T extends User>
extends UserTableBase<T>

The Table of registered Users. Every Melati DB has this table. This table will contain at least a _guest_ and _administrator_ User. Melati POEM generated, programmer modifiable stub for a UserTable object.

Description: A registered user of the database.

Field summary for SQL table User

Name	Type	Description
id	Integer	The Table Row Object ID
name	String	The user's real name
login	String	The user's login name
password	String	The user's password

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
User	administratorUser()
Capability	canReadPasswords() Defaults to the db's administrator capability.
Capability	canWritePasswords() Defaults to the db's administraor capability.
User	guestUser()
void	postInitialise() Apply default protection to this table if it has not already been protected.
void	unifyWithDB(ResultSet colDescs, String troidColumnName) Create guestUser and administratorUser.

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

defaultCategory, defaultDescription, defaultDisplayOrder, defaultRememberAllTroids, ensure, getIdColumn, getLoginColumn, getNameColumn, getPasswordColumn, getPoemDatabaseTables, getUserObject, getUserObject, init

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

UserTable

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

Method Detail

guestUser

public User guestUser()

Returns:

the special User guest

administratorUser

public User administratorUser()

Returns:

the special User administrator

canReadPasswords

public Capability canReadPasswords()

Defaults to the db's administrator capability.

Returns:

the Capability required to read a password

canWritePasswords

public Capability canWritePasswords()

Defaults to the db's administraor capability.

Returns:

the Capability required to write a password

unifyWithDB

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

Create guestUser and administratorUser. Unify the JDBC description of this tables columns with the meta data held in the TableInfo

Specified by:

unifyWithDB in interface Table<T extends User>

Overrides:

unifyWithDB in class JdbcTable<T extends User>

Parameters:

colDescs - a JDBC ResultSet describing the columns with cursor at current row

troidColumnName - name of primary key column

Throws:

PoemException

See Also:

Table.unifyWithDB(java.sql.ResultSet, java.lang.String)

postInitialise

public void postInitialise()

Description copied from class: PoemTable

Apply default protection to this table if it has not already been protected.

Specified by:

postInitialise in interface Table<T extends User>

Overrides:

postInitialise in class PoemTable<T extends User>

See Also:

JdbcTable.notifyColumnInfo(ColumnInfo), JdbcTable.clearColumnInfoCaches()