xdev.db.servlet

Class ServletDBMetaData

java.lang.Object

xdev.db.AbstractDBMetaData

xdev.db.servlet.ServletDBMetaData

All Implemented Interfaces:

Serializable, DBMetaData, DataSourceMetaData

public class ServletDBMetaData
extends AbstractDBMetaData

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
ServletDBMetaData(ServletDBDataSource dataSource, DBMetaData original)

Method Summary

Modifier and Type	Method and Description
boolean	equalsType(ColumnMetaData clientColumn, ColumnMetaData dbColumn) Compares the two ColumnMetaData.
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 xdev.db.AbstractDBMetaData

dispose, getEntityRelationshipModel, isColumnEqual, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletDBMetaData

public ServletDBMetaData(ServletDBDataSource dataSource,
                         DBMetaData original)

Method Detail

getName

public String getName()

getVersion

public String getVersion()

isCaseSensitive

public boolean isCaseSensitive()
                        throws DBException

Returns:

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

Throws:

DBException

getMaxColumnNameLength

public int getMaxColumnNameLength()
                           throws DBException

Description copied from interface: DBMetaData

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

getTableInfos

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

Description copied from interface: DBMetaData

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

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

Description copied from interface: DBMetaData

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

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

Description copied from interface: DBMetaData

Create the StoredProcedure Objects of this DBMetaData.

Returns:

a array of StoredProcedure

Throws:

DBException - if a database access error occurs

getEntityRelationshipModel

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

Description copied from interface: DBMetaData

Create the EntityRelationshipModel of this DBMetaData.

Returns:

a EntityRelationshipModel of this DBMetaData

Throws:

DBException - if a database access error occurs

equalsType

public boolean equalsType(ColumnMetaData clientColumn,
                          ColumnMetaData dbColumn)

Description copied from interface: DBMetaData

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

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

Description copied from interface: DBMetaData

Synchronized tables in the database according to changes.

changes - all changes to be synchronized

Returns:

all stored queries

Throws:

DBException - if a database access error occurs