ch.sahits.model.db
Interface IDataBaseTable

All Known Subinterfaces:

IConnectableDataBaseTable

All Known Implementing Classes:

DataBaseTable

public interface IDataBaseTable

This interface defines methods that must be supplied by a model for a database table

Since:

0.9.3

Author:

Andi Hotz

Method Summary

void	add(DataBaseTableField field) Add a database field.
void	add(DataBaseTableIndex ind) Add a database index.
java.util.List<DataBaseTableField>	getFields() Retrieve a list of the database fields.
java.util.List<DataBaseTableIndex>	getIndexes() Retrieve a list of all table indexes
java.lang.String	getTableName() Retrieve the table name
void	setIndexes(java.util.List<DataBaseTableIndex> _indexes) Set the DataBaseTableIndex s
void	setTableName(java.lang.String tableName) Set the table name.
java.util.List<DataBaseTableIndex>	uniqueKeys() Retrieve a list of all indexes that represent a unique key
java.util.List<java.lang.Class>	usedClasses() Return all classes that are used as database fields

Method Detail

getFields

java.util.List<DataBaseTableField> getFields()

Retrieve a list of the database fields.

Returns:

DataBaseTableField s

add

void add(DataBaseTableField field)

Add a database field.

Parameters:

field -

getIndexes

java.util.List<DataBaseTableIndex> getIndexes()

Retrieve a list of all table indexes

Returns:

DataBaseTableIndex s

setIndexes

void setIndexes(java.util.List<DataBaseTableIndex> _indexes)

Set the DataBaseTableIndex s

Parameters:

_indexes -

add

void add(DataBaseTableIndex ind)

Add a database index.

Parameters:

ind -

usedClasses

java.util.List<java.lang.Class> usedClasses()

Return all classes that are used as database fields

Returns:

list of all classes TODO: refactor: the return type Listes restrict the use of this model to Java based output

getTableName

java.lang.String getTableName()

Retrieve the table name

Returns:

table name

setTableName

void setTableName(java.lang.String tableName)

Set the table name. Stored in upper-case

Parameters:

tableName -

uniqueKeys

java.util.List<DataBaseTableIndex> uniqueKeys()

Retrieve a list of all indexes that represent a unique key

Returns:

List of indexes

Since:

1.2.0