org.melati.example.contacts.generated
Class ContactTableBase

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

All Implemented Interfaces:

Selectable, Table

Direct Known Subclasses:

ContactTable

public class ContactTableBase
extends ContactsTable

Melati POEM generated base class for Table Contact.

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

Constructor Summary

ContactTableBase(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()
Column	getAddressColumn() Retrieves the Address Column for this Contact Table.
Contact	getContactObject(int troid) Retrieve the Contact as a Contact.
Contact	getContactObject(Integer troid) Retrieve the Contact as a Contact.
ContactsDatabaseTables	getContactsDatabaseTables() Get the database tables.
Column	getIdColumn() Retrieves the Id Column for this Contact Table.
Column	getLastupdatedColumn() Retrieves the Lastupdated Column for this Contact Table.
Column	getLastupdateuserColumn() Retrieves the Lastupdateuser Column for this Contact Table.
Column	getNameColumn() Retrieves the Name Column for this Contact Table.
Column	getOwnerColumn() Retrieves the Owner Column for this Contact Table.
Column	getUpdatesColumn() Retrieves the Updates Column for this Contact 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

ContactTableBase

public ContactTableBase(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 Contact Table.

Returns:

the id Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getNameColumn

public final Column getNameColumn()

Retrieves the Name Column for this Contact Table.

Returns:

the name Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getOwnerColumn

public final Column getOwnerColumn()

Retrieves the Owner Column for this Contact Table.

Returns:

the owner Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getAddressColumn

public final Column getAddressColumn()

Retrieves the Address Column for this Contact Table.

Returns:

the address Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getUpdatesColumn

public final Column getUpdatesColumn()

Retrieves the Updates Column for this Contact Table.

Returns:

the updates Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getLastupdatedColumn

public final Column getLastupdatedColumn()

Retrieves the Lastupdated Column for this Contact Table.

Returns:

the lastupdated Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getLastupdateuserColumn

public final Column getLastupdateuserColumn()

Retrieves the Lastupdateuser Column for this Contact Table.

Returns:

the lastupdateuser Column

See Also:

FieldDef.generateColAccessor(java.io.Writer)

getContactObject

public Contact getContactObject(Integer troid)

Retrieve the Contact as a Contact.

Parameters:

troid - a Table Row Oject ID

Returns:

the Persistent identified by the troid

See Also:

TableDef.generateTableBaseJava(java.io.Writer)

getContactObject

public Contact getContactObject(int troid)

Retrieve the Contact as a Contact.

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