xdev.db

Class DelegatingDBMetaData

java.lang.Object

xdev.db.DelegatingDBMetaData

All Implemented Interfaces:

Serializable, DBMetaData, DataSourceMetaData

public abstract class DelegatingDBMetaData
extends Object
implements DBMetaData

Abstract base class for delegating db metadata.

This class is not intended to be subclassed by the user!

Since:

4.0

Author:

XDEV Software

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface xdev.db.DBMetaData

DBMetaData.TableChange, DBMetaData.TableInfo, DBMetaData.TableMetaData, DBMetaData.TableType

Field Summary

Fields inherited from interface xdev.db.DBMetaData

ALL, INDICES, ROW_COUNT, UNKNOWN_ROW_COUNT

Constructor Summary

Constructors

Constructor and Description
DelegatingDBMetaData(DBMetaData delegate)

Method Summary

Modifier and Type	Method and Description
void	dispose() Releases all resources used by this metadata object.
boolean	equalsType(ColumnMetaData clientColumn, ColumnMetaData dbColumn) Compares the two ColumnMetaData.
DBMetaData	getDelegate()
EntityRelationshipModel	getEntityRelationshipModel(ProgressMonitor monitor) Create the EntityRelationshipModel of all tables of this DBMetaData.
EntityRelationshipModel	getEntityRelationshipModel(ProgressMonitor monitor, DBMetaData.TableInfo... tables) Create the EntityRelationshipModel of this DBMetaData.
int	getMaxColumnNameLength() Retrieves the maximum number of characters this database allows for a column name.
String	getName()
StoredProcedure[]	getStoredProcedures(ProgressMonitor monitor) Create the StoredProcedure Objects of this DBMetaData.
DBMetaData.TableInfo[]	getTableInfos(ProgressMonitor monitor, EnumSet<DBMetaData.TableType> types) Create the table infos for this DBMetaData.
DBMetaData.TableMetaData[]	getTableMetaData(ProgressMonitor monitor, int flags, DBMetaData.TableInfo... tables) Create the table meta data for the given DBMetaData.TableInfos.
String	getVersion()
boolean	isCaseSensitive()
DBConnection.Query[]	synchronizeTables(ProgressMonitor monitor, DBMetaData.TableChange... changes) Synchronized tables in the database according to changes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DelegatingDBMetaData

public DelegatingDBMetaData(DBMetaData delegate)

Method Detail

getDelegate

public DBMetaData getDelegate()

Returns:

the metadata to which the calls are delegated to

getName

public String getName()

Specified by:

getName in interface DataSourceMetaData

getVersion

public String getVersion()

Specified by:

getVersion in interface DataSourceMetaData

isCaseSensitive

public boolean isCaseSensitive()
                        throws DBException

Specified by:

isCaseSensitive in interface DBMetaData

Returns:

true if identifiers like table or columns names are case sensitive, false otherwise

Throws:

DBException

getMaxColumnNameLength

public int getMaxColumnNameLength()
                           throws DBException

Retrieves the maximum number of characters this database allows for a column name.

Specified by:

getMaxColumnNameLength in interface DBMetaData

Returns:

the maximum number of characters allowed for a column name; a result of zero means that there is no limit or the limit is not known

Throws:

DBException

getTableInfos

public DBMetaData.TableInfo[] getTableInfos(ProgressMonitor monitor,
                                            EnumSet<DBMetaData.TableType> types)
                                     throws DBException

Create the table infos for this DBMetaData. Read only the table name and data types.

Specified by:

getTableInfos in interface DBMetaData

Returns:

the table infos for this DBMetaData

Throws:

DBException - if a database access error occurs

getTableMetaData

public DBMetaData.TableMetaData[] getTableMetaData(ProgressMonitor monitor,
                                                   int flags,
                                                   DBMetaData.TableInfo... tables)
                                            throws DBException

Create the table meta data for the given DBMetaData.TableInfos.

Specified by:

getTableMetaData in interface DBMetaData

flags - requested data, e.g DBMetaData.INDICES | DBMetaData.ROW_COUNT or DBMetaData.ALL

tables - a number of DBMetaData.TableInfo instances

Returns:

a array of DBMetaData.TableMetaData

Throws:

DBException - if a database access error occurs

getStoredProcedures

public StoredProcedure[] getStoredProcedures(ProgressMonitor monitor)
                                      throws DBException

Create the StoredProcedure Objects of this DBMetaData.

Specified by:

getStoredProcedures in interface DBMetaData

Returns:

a array of StoredProcedure

Throws:

DBException - if a database access error occurs

getEntityRelationshipModel

public EntityRelationshipModel getEntityRelationshipModel(ProgressMonitor monitor)
                                                   throws DBException

Create the EntityRelationshipModel of all tables of this DBMetaData.

Specified by:

getEntityRelationshipModel in interface DBMetaData

Returns:

a EntityRelationshipModel of this DBMetaData

Throws:

DBException - if a database access error occurs

getEntityRelationshipModel

public EntityRelationshipModel getEntityRelationshipModel(ProgressMonitor monitor,
                                                          DBMetaData.TableInfo... tables)
                                                   throws DBException

Create the EntityRelationshipModel of this DBMetaData.

Specified by:

getEntityRelationshipModel in interface DBMetaData

Returns:

a EntityRelationshipModel of this DBMetaData

Throws:

DBException - if a database access error occurs

equalsType

public boolean equalsType(ColumnMetaData clientColumn,
                          ColumnMetaData dbColumn)

Compares the two ColumnMetaData.

Specified by:

equalsType in interface DBMetaData

Parameters:

clientColumn - the ColumnMetaData to compare

dbColumn - the ColumnMetaData to compare clientColumn against

Returns:

true if the given ColumnMetaDatas are the same, otherwise flase

synchronizeTables

public DBConnection.Query[] synchronizeTables(ProgressMonitor monitor,
                                              DBMetaData.TableChange... changes)
                                       throws DBException

Synchronized tables in the database according to changes.

Specified by:

synchronizeTables in interface DBMetaData

changes - all changes to be synchronized

Returns:

all stored queries

Throws:

DBException - if a database access error occurs

dispose

public void dispose()

Releases all resources used by this metadata object.

Specified by:

dispose in interface DBMetaData