com.jcorporate.expresso.core.dataobjects.jdbc
Interface JDBCObjectMetaData

All Superinterfaces:

DataObjectMetaData, Serializable

All Known Implementing Classes:

DBObjectDef

public interface JDBCObjectMetaData

extends DataObjectMetaData

DataObject Metadata that is specific to JDBC implementations only. For example, TableName is absolutely meaningless in a non-JDBC environment. The DBObject metadata is derived from this interface

Since:

Expresso 5.1

Author:

Michael Rimov

Method Summary

String	getTargetDbCatalog() Retrieve the database catalogue name associated with this data object
String	getTargetDbSchema() Retrieve the database schema name associated with this data object
String	getTargetSQLTable(String dataContext) Retrieve the full table name associated with this data object
String	getTargetTable() Return the Table Name of the current database object.
boolean	hasIndex() Returns true if an Index exists for this array.

Methods inherited from interface com.jcorporate.expresso.core.dataobjects.DataObjectMetaData

checkZeroUpdate, disableLogging, enableLogging, getAllAttributes, getAllFieldsMap, getAllKeysMap, getAttribute, getCacheSize, getCharset, getDefaultValue, getDescription, getDescription, getDescription, getDescription, getDetailFieldsForeign, getDetailFieldsLocal, getDetailSet, getFieldListArray, getFieldMetadata, getFields, getKeyFieldListArray, getLength, getLengthInt, getLookupField, getLookupObject, getName, getPrecision, getSchema, getType, hasField, isAllowsNull, isField, isFieldIgnoreCase, isLoggingEnabled, isMultiValued, isReadOnly, isSecret, isVirtual, removeAttribute, setAttribute, setCacheSize, setCheckZeroUpdate

Method Detail

getTargetTable

public String getTargetTable()
                      throws DataException

Return the Table Name of the current database object. Keep in mind that a database object could update or affect other tables as well.

Returns:

String: Table name of the target table of this database object

Throws:

DataException

hasIndex

public boolean hasIndex()
                 throws DataException

Returns true if an Index exists for this array.

Returns:

true if this has an index Use getMetaData().hasIndex() instead

Throws:

DataException - upon error

getTargetDbCatalog

public String getTargetDbCatalog()

Retrieve the database catalogue name associated with this data object

Returns:

the className of the schema associated with this DBObject

getTargetSQLTable

public String getTargetSQLTable(String dataContext)
                         throws DataException

Retrieve the full table name associated with this data object

Parameters:

dataContext - The target data context.

Returns:

the className of the schema associated with this DBObject

Throws:

DataException

getTargetDbSchema

public String getTargetDbSchema()

Retrieve the database schema name associated with this data object

Returns:

the className of the schema associated with this DBObject