org.julp.db

Class DBMetaData<T>

java.lang.Object

org.julp.AbstractMetaData<T>

org.julp.db.DBMetaData<T>

All Implemented Interfaces:

java.io.Serializable, MetaData<T>

public class DBMetaData<T>
extends AbstractMetaData<T>

Populates and caches columns, tables, fields, read/write methods, etc... Not all properties are used/populated. Add support for properties as needed.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean[]	autoIncrement
protected java.lang.String[]	catalogName
protected java.lang.String[]	columnClassName
protected int[]	columnDisplaySize
protected java.lang.String[]	columnLabel
protected java.lang.String[]	columnName
protected int[]	columnType
protected java.lang.String[]	columnTypeName
protected java.lang.String[]	fullColumnName
protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	primaryKeyMap
protected java.lang.String[]	schemaName
protected java.lang.String[]	tableName
protected java.util.Map<java.lang.String,java.lang.String[]>	tables
protected java.util.Map<java.lang.String,java.lang.reflect.Method>	uniqueIdWriteMethods

Fields inherited from class org.julp.AbstractMetaData

caseSensitive, currency, definitelyWritable, domainClass, fieldClass, fieldClassName, fieldCount, fieldLabel, fieldName, logger, mapping, nullable, precision, readMethod, readOnly, scale, searchable, signed, throwMissingFieldException, writable, writeMethod

Constructor Summary

Constructors

Constructor and Description
DBMetaData()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCatalogName(int columnIndex) Gets the designated column's table's catalog name.
java.lang.String	getColumnClassName(int columnIndex) Returns the fully-qualified name of the Java class whose instances are manufactured if the method ResultSet.getObject is called to retrieve a value from the column.
int	getColumnDisplaySize(int columnIndex) Indicates the designated column's normal maximum width in characters.
int	getColumnIndexByColumnName(java.lang.String columnName)
int	getColumnIndexByFullColumnName(java.lang.String fullColumnNameParam)
java.lang.String	getColumnLabel(int columnIndex) Gets the designated column's suggested title for use in printouts and displays.
java.lang.String	getColumnName(int columnIndex) Get the designated column's name.
int	getColumnType(int columnIndex) Retrieves the designated column's SQL type.
java.lang.String	getColumnTypeName(int columnIndex) Retrieves the designated column's database-specific type name.
java.lang.String	getFullColumnName(int columnIndex)
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getPrimaryKeyMap()
java.lang.String	getSchemaName(int columnIndex) Get the designated column's table's schema.
java.lang.String	getTableName(int columnIndex) Gets the designated column's table name.
java.util.Map<java.lang.String,java.lang.String[]>	getTables()
java.util.Map<java.lang.String,java.lang.reflect.Method>	getUniqueIdWriteMethods()
boolean	isAutoIncrement(int columnIndex) Indicates whether the designated column is automatically numbered, thus read-only.
void	populate(java.util.Map<java.lang.String,java.lang.String> mapping, java.lang.Class domainClass)
void	setAutoIncrement(int columnIndex, boolean property) Sets whether the designated column is automatically numbered, and thus read-only.
void	setCatalogName(int columnIndex, java.lang.String catalogName) Sets the designated column's table's catalog name, if any, to the given String.
void	setColumnClassName(int columnIndex, java.lang.String columnClassName)
void	setColumnDisplaySize(int columnIndex, int size) Sets the designated column's normal maximum width in chars to the given int.
void	setColumnLabel(int columnIndex, java.lang.String label) Sets the suggested column title for use in printouts and displays, if any, to the given String.
void	setColumnName(int columnIndex, java.lang.String columnName) Sets the name of the designated column to the given String.
void	setColumnType(int columnIndex, int SQLType) Sets the designated column's SQL type to the one given.
void	setColumnTypeName(int columnIndex, java.lang.String typeName) Sets the designated column's type name that is specific to the data source, if any, to the given String.
void	setFullColumnName(int columnIndex, java.lang.String columnName)
void	setSchemaName(int columnIndex, java.lang.String schemaName) Sets the name of the designated column's table's schema, if any, to the given String.
void	setTableName(int columnIndex, java.lang.String tableName) Sets the designated column's table name, if any, to the given String.
void	setTables(java.util.Map<java.lang.String,java.lang.String[]> tables)
java.lang.String	toString()

Methods inherited from class org.julp.AbstractMetaData

getDomainClass, getFieldClass, getFieldClassName, getFieldCount, getFieldIndexByFieldName, getFieldLabel, getFieldName, getMapping, getPrecision, getReadMethod, getScale, getWriteMethod, isCaseSensitive, isCurrency, isDefinitelyWritable, isNullable, isPopulated, isReadOnly, isSearchable, isSigned, isThrowMissingFieldException, isWritable, populateReadMethod, populateWriteMethod, setCaseSensitive, setCurrency, setDefinitelyWritable, setFieldClass, setFieldClassName, setFieldCount, setFieldLabel, setFieldName, setNullable, setPrecision, setReadMethod, setReadOnly, setScale, setSearchable, setSigned, setThrowMissingFieldException, setWritable, setWriteMethod, toLabel

Methods inherited from class java.lang.Object

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

Field Detail

columnDisplaySize

protected int[] columnDisplaySize

columnType

protected int[] columnType

catalogName

protected java.lang.String[] catalogName

schemaName

protected java.lang.String[] schemaName

tableName

protected java.lang.String[] tableName

columnClassName

protected java.lang.String[] columnClassName

columnLabel

protected java.lang.String[] columnLabel

columnName

protected java.lang.String[] columnName

columnTypeName

protected java.lang.String[] columnTypeName

fullColumnName

protected java.lang.String[] fullColumnName

autoIncrement

protected boolean[] autoIncrement

tables

protected java.util.Map<java.lang.String,java.lang.String[]> tables

primaryKeyMap

protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>> primaryKeyMap

uniqueIdWriteMethods

protected java.util.Map<java.lang.String,java.lang.reflect.Method> uniqueIdWriteMethods

Constructor Detail

DBMetaData

public DBMetaData()

Method Detail

getCatalogName

public java.lang.String getCatalogName(int columnIndex)
                                throws DataAccessException

Gets the designated column's table's catalog name.

Returns:

the name of the catalog for the table in which the given column appears or "" if not applicable

Throws:

DataAccessException - if a database access error occurs

getColumnClassName

public java.lang.String getColumnClassName(int columnIndex)
                                    throws DataAccessException

Returns the fully-qualified name of the Java class whose instances are manufactured if the method ResultSet.getObject is called to retrieve a value from the column. ResultSet.getObject may return a subclass of the class returned by this method.

Returns:

the fully-qualified name of the class in the Java programming language that would be used by the method ResultSet.getObject to retrieve the value in the specified column. This is the class name used for custom mapping.

Throws:

DataAccessException - if a database access error occurs

getColumnDisplaySize

public int getColumnDisplaySize(int columnIndex)
                         throws DataAccessException

Indicates the designated column's normal maximum width in characters.

Returns:

the normal maximum number of characters allowed as the width of the designated column

Throws:

DataAccessException - if a database access error occurs

getColumnLabel

public java.lang.String getColumnLabel(int columnIndex)
                                throws DataAccessException

Gets the designated column's suggested title for use in printouts and displays.

Returns:

the suggested column title

Throws:

DataAccessException - if a database access error occurs

getColumnName

public java.lang.String getColumnName(int columnIndex)
                               throws DataAccessException

Get the designated column's name.

Returns:

column name

Throws:

DataAccessException - if a database access error occurs

getColumnType

public int getColumnType(int columnIndex)
                  throws DataAccessException

Retrieves the designated column's SQL type.

Returns:

SQL type from Types

Throws:

DataAccessException - if a database access error occurs

See Also:

Types

getColumnTypeName

public java.lang.String getColumnTypeName(int columnIndex)
                                   throws DataAccessException

Retrieves the designated column's database-specific type name.

Returns:

type name used by the database. If the column type is a user-defined type, then a fully-qualified type name is returned.

Throws:

DataAccessException - if a database access error occurs

getSchemaName

public java.lang.String getSchemaName(int columnIndex)
                               throws DataAccessException

Get the designated column's table's schema.

Returns:

schema name or "" if not applicable

Throws:

DataAccessException - if a database access error occurs

getTableName

public java.lang.String getTableName(int columnIndex)
                              throws DataAccessException

Gets the designated column's table name.

Returns:

table name or "" if not applicable

Throws:

DataAccessException - if a database access error occurs

isAutoIncrement

public boolean isAutoIncrement(int columnIndex)
                        throws DataAccessException

Indicates whether the designated column is automatically numbered, thus read-only.

Returns:

true if so; false otherwise

Throws:

DataAccessException - if a database access error occurs

setAutoIncrement

public void setAutoIncrement(int columnIndex,
                             boolean property)
                      throws DataAccessException

Sets whether the designated column is automatically numbered, and thus read-only. The default is for a RowSet object's columns not to be automatically numbered.

Parameters:

property - true if the column is automatically numbered; false if it is not

Throws:

DataAccessException - if a database access error occurs

setCatalogName

public void setCatalogName(int columnIndex,
                           java.lang.String catalogName)
                    throws DataAccessException

Sets the designated column's table's catalog name, if any, to the given String.

Parameters:

catalogName - the column's catalog name

Throws:

DataAccessException - if a database access error occurs

setColumnDisplaySize

public void setColumnDisplaySize(int columnIndex,
                                 int size)
                          throws DataAccessException

Sets the designated column's normal maximum width in chars to the given int.

Parameters:

size - the normal maximum number of characters for the designated column

Throws:

DataAccessException - if a database access error occurs

setColumnLabel

public void setColumnLabel(int columnIndex,
                           java.lang.String label)
                    throws DataAccessException

Sets the suggested column title for use in printouts and displays, if any, to the given String.

Parameters:

label - the column title

Throws:

DataAccessException - if a database access error occurs

setColumnName

public void setColumnName(int columnIndex,
                          java.lang.String columnName)
                   throws DataAccessException

Sets the name of the designated column to the given String.

Parameters:

columnName - the designated column's name

Throws:

DataAccessException - if a database access error occurs

setColumnType

public void setColumnType(int columnIndex,
                          int SQLType)
                   throws DataAccessException

Sets the designated column's SQL type to the one given.

Parameters:

SQLType - the column's SQL type

Throws:

DataAccessException - if a database access error occurs

See Also:

Types

setColumnTypeName

public void setColumnTypeName(int columnIndex,
                              java.lang.String typeName)
                       throws DataAccessException

Sets the designated column's type name that is specific to the data source, if any, to the given String.

Parameters:

typeName - data source specific type name.

Throws:

DataAccessException - if a database access error occurs

setSchemaName

public void setSchemaName(int columnIndex,
                          java.lang.String schemaName)
                   throws DataAccessException

Sets the name of the designated column's table's schema, if any, to the given String.

Parameters:

schemaName - the schema name

Throws:

DataAccessException - if a database access error occurs

setTableName

public void setTableName(int columnIndex,
                         java.lang.String tableName)
                  throws DataAccessException

Sets the designated column's table name, if any, to the given String.

Parameters:

tableName - the column's table name

Throws:

DataAccessException - if a database access error occurs

setColumnClassName

public void setColumnClassName(int columnIndex,
                               java.lang.String columnClassName)

getTables

public java.util.Map<java.lang.String,java.lang.String[]> getTables()

setTables

public void setTables(java.util.Map<java.lang.String,java.lang.String[]> tables)

getFullColumnName

public java.lang.String getFullColumnName(int columnIndex)
                                   throws DataAccessException

Throws:

DataAccessException

setFullColumnName

public void setFullColumnName(int columnIndex,
                              java.lang.String columnName)
                       throws DataAccessException

Throws:

DataAccessException

populate

public void populate(java.util.Map<java.lang.String,java.lang.String> mapping,
                     java.lang.Class domainClass)
              throws DataAccessException

Throws:

DataAccessException

getColumnIndexByColumnName

public int getColumnIndexByColumnName(java.lang.String columnName)

getColumnIndexByFullColumnName

public int getColumnIndexByFullColumnName(java.lang.String fullColumnNameParam)

getPrimaryKeyMap

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getPrimaryKeyMap()

getUniqueIdWriteMethods

public java.util.Map<java.lang.String,java.lang.reflect.Method> getUniqueIdWriteMethods()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object