xdev.db

Interface DBMetaData

All Superinterfaces:

DataSourceMetaData, Serializable

All Known Implementing Classes:

AbstractDBMetaData, DelegatingDBMetaData, JDBCMetaData, ServletDBMetaData

public interface DBMetaData
extends DataSourceMetaData, Serializable

This class provides methods to read or change the meta data from the database.

Author:

XDEV Software

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DBMetaData.TableChange Holds table change information.
static class	DBMetaData.TableInfo This class includes limited information about the database table.
static class	DBMetaData.TableMetaData This class includes information about the database table, the columns of the database table and the indices.
static class	DBMetaData.TableType The table type of a database table.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL
static int	INDICES
static int	ROW_COUNT
static int	UNKNOWN_ROW_COUNT

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.
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.
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.
boolean	isCaseSensitive()
DBConnection.Query[]	synchronizeTables(ProgressMonitor monitor, DBMetaData.TableChange... changes) Synchronized tables in the database according to changes.

Methods inherited from interface xdev.util.DataSourceMetaData

getName, getVersion

Field Detail

INDICES

static final int INDICES

See Also:

Constant Field Values

ROW_COUNT

static final int ROW_COUNT

See Also:

Constant Field Values

ALL

static final int ALL

See Also:

Constant Field Values

UNKNOWN_ROW_COUNT

static final int UNKNOWN_ROW_COUNT

See Also:

Constant Field Values

Method Detail

isCaseSensitive

boolean isCaseSensitive()
                 throws DBException

Returns:

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

Throws:

DBException

getMaxColumnNameLength

int getMaxColumnNameLength()
                    throws DBException

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

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

Since:

4.1

getTableInfos

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.

Returns:

the table infos for this DBMetaData

Throws:

DBException - if a database access error occurs

getTableMetaData

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

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

Parameters:

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

tables - a number of DBMetaData.TableInfo instances

Returns:

a array of DBMetaData.TableMetaData

Throws:

DBException - if a database access error occurs

getStoredProcedures

StoredProcedure[] getStoredProcedures(ProgressMonitor monitor)
                               throws DBException

Create the StoredProcedure Objects of this DBMetaData.

Returns:

a array of StoredProcedure

Throws:

DBException - if a database access error occurs

getEntityRelationshipModel

EntityRelationshipModel getEntityRelationshipModel(ProgressMonitor monitor)
                                            throws DBException

Create the EntityRelationshipModel of all tables of this DBMetaData.

Returns:

a EntityRelationshipModel of this DBMetaData

Throws:

DBException - if a database access error occurs

getEntityRelationshipModel

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

Create the EntityRelationshipModel of this DBMetaData.

Returns:

a EntityRelationshipModel of this DBMetaData

Throws:

DBException - if a database access error occurs

equalsType

boolean equalsType(ColumnMetaData clientColumn,
                   ColumnMetaData dbColumn)

Compares the two ColumnMetaData.

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

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

Synchronized tables in the database according to changes.

Parameters:

monitor -

changes - all changes to be synchronized

Returns:

all stored queries

Throws:

DBException - if a database access error occurs

dispose

void dispose()

Releases all resources used by this metadata object.

Since:

4.0