com.im.df.api.capabilities
Interface DBEntityCapability

All Superinterfaces:

DFCapability, PropertiesEditingConfigurable

All Known Subinterfaces:

JChemBaseEntityCapability, JChemCartridgeCapability, JChemCartridgeJChemBaseCapability, JChemCartridgeStandardCapability, JChemEntityCapability

public interface DBEntityCapability
extends DFCapability, PropertiesEditingConfigurable

The definition of an entity residing in a relational database, typically a database table. It will contain DFFields that typically correspond to columns in the table.

Nested Class Summary

Nested classes/interfaces inherited from interface com.im.df.api.support.PropertiesEditingConfigurable

PropertiesEditingConfigurable.Extra

Field Summary

static String	PROP_DOMAIN The JChem property table name, named "domain" for historical reasons.
static String	PROP_FILTER_QUERY_ALLOWED XAttributes property name that toggles the use of cartridge filterQuery parameter.
static String	PROP_TABLE_NAME

Method Summary

boolean	canDrop()
String	claimTableOwnership(String tableName) Deprecated.
DBTableInfo	claimTableOwnership(String dbSchemaName, String table) Does this entity claim ownership to this table.
DBTableInfo[]	getTableInfo() Deprecated. Use the better named getTableInfos() method
DBTableInfo[]	getTableInfos() Get the descriptions of the tables used by this entity.
String	getTableName() Deprecated.
void	setTableName(String tableName, DFEnvironmentRW env) Rename the database table.

Methods inherited from interface com.im.df.api.support.PropertiesEditingConfigurable

isPropertyEditable

Field Detail

PROP_TABLE_NAME

static final String PROP_TABLE_NAME

See Also:

Constant Field Values

PROP_DOMAIN

static final String PROP_DOMAIN

The JChem property table name, named "domain" for historical reasons. TODO see if this property can be removed

See Also:

Constant Field Values

PROP_FILTER_QUERY_ALLOWED

static final String PROP_FILTER_QUERY_ALLOWED

XAttributes property name that toggles the use of cartridge filterQuery parameter.

See Also:

Constant Field Values

Method Detail

getTableName

@Deprecated
String getTableName()

Deprecated.

Convenience method to get the name of the primary database table used by this entity. More information is available if you use the @{link #getTableInfos} method.

Returns:

The table name

getTableInfos

DBTableInfo[] getTableInfos()

Get the descriptions of the tables used by this entity. Often there will only be a single table.

Returns:

The table infos describing the tables used by this entity

getTableInfo

DBTableInfo[] getTableInfo()

Deprecated. Use the better named getTableInfos() method

Returns:

The table infos describing the tables used by this entity

setTableName

void setTableName(String tableName,
                  DFEnvironmentRW env)

Rename the database table.

Parameters:

tableName - New database table name

claimTableOwnership

@Deprecated
String claimTableOwnership(String tableName)

Deprecated.

Does this entity claim ownership to this table.

Parameters:

tableName -

Returns:

The primary table name for this table. Usually the table itself, but if the table is a secondary table for the entity the primary table name if returned. If the table does not belong to this entity null returned.

claimTableOwnership

DBTableInfo claimTableOwnership(String dbSchemaName,
                                String table)

Does this entity claim ownership to this table.

Parameters:

dbSchemaName - the database schema name

table - The table name

Returns:

The primary table info for this table. Usually the table itself, but if the table is a secondary table for the entity the primary table name if returned. If the table does not belong to this entity null returned.

canDrop

boolean canDrop()