org.melati.example.contacts.generated
Class CategoryTableBase

java.lang.Object
  org.melati.poem.JdbcTable
      org.melati.example.contacts.ContactsTable
          org.melati.example.contacts.generated.CategoryTableBase

All Implemented Interfaces:

Selectable, Table

Direct Known Subclasses:

CategoryTable

public class CategoryTableBase
extends ContactsTable

Melati POEM generated base class for Table Category.

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

Constructor Summary

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

Method Summary

protected JdbcPersistent	_newPersistent() A freshly minted, and uninitialised, Persistent object for the table.
protected String	defaultCategory()
protected String	defaultDescription() The `factory-default' description for the table, or null if it doesn't have one.
protected int	defaultDisplayOrder()
Category	getCategoryObject(int troid) Retrieve the Category as a Category.
Category	getCategoryObject(Integer troid) Retrieve the Category as a Category.
ContactsDatabaseTables	getContactsDatabaseTables() Get the database tables.
Column	getIdColumn() Retrieves the Id Column for this Category Table.
Column	getNameColumn() Retrieves the Name Column for this Category Table.
void	init() Override this to perform pre-unification initialisation.

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, defaultCacheLimit, defaultDisplayName, defaultOrderByClause, defaultRememberAllTroids, 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, postInitialise, 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

CategoryTableBase

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

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

Method Detail

getContactsDatabaseTables

public ContactsDatabaseTables getContactsDatabaseTables()

Get the database tables.

Returns:

the database tables

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

init

public void init()
          throws PoemException

Description copied from class: JdbcTable

Override this to perform pre-unification initialisation.

Specified by:

init in interface Table

Overrides:

init in class JdbcTable

Throws:

PoemException

getIdColumn

public final Column getIdColumn()

Retrieves the Id Column for this Category Table.

Returns:

the id Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getNameColumn

public final Column getNameColumn()

Retrieves the Name Column for this Category Table.

Returns:

the name Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getCategoryObject

public Category getCategoryObject(Integer troid)

Retrieve the Category as a Category.

Parameters:

troid - a Table Row Oject ID

Returns:

the Persistent identified by the troid

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

getCategoryObject

public Category getCategoryObject(int troid)

Retrieve the Category as a Category.

Parameters:

troid - a Table Row Object ID

Returns:

the Persistent identified

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

_newPersistent

protected JdbcPersistent _newPersistent()

Description copied from class: JdbcTable

A freshly minted, and uninitialised, Persistent object for the table. You don't ever have to call this and there is no point in doing so This method is overridden in application-specialised Table subclasses derived from the Data Structure Definition.

Overrides:

_newPersistent in class JdbcTable

defaultDescription

protected String defaultDescription()

Description copied from class: JdbcTable

The `factory-default' description for the table, or null if it doesn't have one. Application-specialised tables override this to return any (description = ...) provided in the DSD. This is only ever used at startup time when creating columninfo records for tables that don't have them.

Overrides:

defaultDescription in class JdbcTable

defaultCategory

protected String defaultCategory()

Overrides:

defaultCategory in class JdbcTable

defaultDisplayOrder

protected int defaultDisplayOrder()

Overrides:

defaultDisplayOrder in class JdbcTable