Package adams.db

Class MetaDataUtils

java.lang.Object

adams.db.MetaDataUtils

public class MetaDataUtils
extends Object

Utility class for database meta-data.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field	Description
static String[]	JDBC_VALUES
protected static Logger	LOGGER	for logging.

Constructor Summary

Constructors

Constructor	Description
MetaDataUtils()

Method Summary

Modifier and Type	Method	Description
protected static void	addRow(SpreadSheet sheet, String key, Object value)	Adds a row to the sheet with the given key and value.
protected static void	addRow(DatabaseMetaData metadata, SpreadSheet sheet, String key)	Adds a row to the sheet with the given key.
static SpreadSheet	getMetaData(AbstractDatabaseConnection conn, AbstractTypeMapper mapper, MetaDataType type, String table, MessageCollection errors)	Generates spreadsheet with the metadata.
static MetaDataType[]	typesRequireTable()	Returns the metadata types that require a table.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static Logger LOGGER

for logging.

JDBC_VALUES

public static String[] JDBC_VALUES

Constructor Detail

MetaDataUtils

public MetaDataUtils()

Method Detail

addRow

protected static void addRow(SpreadSheet sheet,
                             String key,
                             Object value)

Adds a row to the sheet with the given key and value.

Parameters:

sheet - the sheet to add the value to

key - the key of the value

value - the value to add

addRow

protected static void addRow(DatabaseMetaData metadata,
                             SpreadSheet sheet,
                             String key)

Adds a row to the sheet with the given key. Obtains the value using the associated method name in the meta-data

Parameters:

metadata - the meta-data to use

sheet - the sheet to add the value to

key - the key of the value

typesRequireTable

public static MetaDataType[] typesRequireTable()

Returns the metadata types that require a table.

Returns:

the types

getMetaData

public static SpreadSheet getMetaData(AbstractDatabaseConnection conn,
                                      AbstractTypeMapper mapper,
                                      MetaDataType type,
                                      String table,
                                      MessageCollection errors)

Generates spreadsheet with the metadata.

Parameters:

conn - the database connection to use

mapper - the mapper for types

type - the type of metadata to return

table - the table to use (only some metadata types, see @see)

errors - for collecting error messages

Returns:

the metadata, null if failed to generate

See Also:

typesRequireTable()