org.hps.conditions.api

Class TableMetaData

java.lang.Object

org.hps.conditions.api.TableMetaData

public final class TableMetaData
extends Object

This class provides meta data about a conditions table, including a list of fields. A row ID field called id is assumed to exist and be a primary key for the table. (Problems will occur if this is not the case!)

The class also has references to the implementation classes which are used for mapping database operations to the ConditionsObject and ConditionsObjectCollection API.

Author:

Jeremy McCormick, SLAC

See Also:

ConditionsObject, BaseConditionsObjectCollection

Field Summary

Fields

Modifier and Type	Field and Description
private Class<? extends BaseConditionsObjectCollection<?>>	collectionClass The collection class.
private Set<String>	fieldNames The set of field names.
private Map<String,Class<?>>	fieldTypes The map of field names to their types.
private String	key The conditions key named (unused???).
private Class<? extends ConditionsObject>	objectClass The object class.
private String	tableName The table name.

Constructor Summary

Constructors

Constructor and Description
TableMetaData() Class constructor.
TableMetaData(String key, String tableName, Class<? extends ConditionsObject> objectClass, Class<? extends BaseConditionsObjectCollection<?>> collectionClass, Set<String> fieldNames, Map<String,Class<?>> fieldTypes) Fully qualified constructor.

Method Summary

Modifier and Type	Method and Description
static List<TableMetaData>	findByObjectType(List<TableMetaData> tableMetaDataList, Class<? extends ConditionsObject> objectType) Find table meta data by object type.
Class<? extends ConditionsObjectCollection<?>>	getCollectionClass() Get the type of collection this table maps onto.
Set<String>	getFieldNames() Get the field names.
Class<?>	getFieldType(String fieldName) Get the type of the field called fieldName.
String	getKey() Get the key of this conditions type.
Class<? extends ConditionsObject>	getObjectClass() Get the type of object this table maps onto.
String	getTableName() Get the name of the table.
(package private) ConditionsObjectCollection<?>	newCollection() Create a new collection instance from the table meta data's collection type.
(package private) ConditionsObject	newObject() Create a new object instance from the table meta data's object type.
(package private) void	removeField(String fieldName) Method for removing a field that was found using the automatic introspection methods.
(package private) void	setFieldNames(String[] fieldNames) Set all the field names from an array of strings.
(package private) void	setFieldType(String fieldName, Class<?> fieldType) Set the type of a field.
(package private) void	setObjectClass(Class<? extends ConditionsObject> objectClass) Set the class that maps to the database.
(package private) void	setTableName(String tableName) Set the table name.
String	toString() Convert to a string.

Methods inherited from class java.lang.Object

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

Field Detail

collectionClass

private Class<? extends BaseConditionsObjectCollection<?>> collectionClass

The collection class.

fieldNames

private Set<String> fieldNames

The set of field names.

fieldTypes

private Map<String,Class<?>> fieldTypes

The map of field names to their types.

key

private String key

The conditions key named (unused???).

objectClass

private Class<? extends ConditionsObject> objectClass

The object class.

tableName

private String tableName

The table name.

Constructor Detail

TableMetaData

public TableMetaData()

Class constructor.

Creates an empty object.

TableMetaData

public TableMetaData(String key,
                     String tableName,
                     Class<? extends ConditionsObject> objectClass,
                     Class<? extends BaseConditionsObjectCollection<?>> collectionClass,
                     Set<String> fieldNames,
                     Map<String,Class<?>> fieldTypes)

Fully qualified constructor.

Parameters:

key - the conditions key

tableName - the table name

objectClass - the object class

collectionClass - the collection class

fieldNames - the field names

fieldTypes - the field types

Method Detail

findByObjectType

public static List<TableMetaData> findByObjectType(List<TableMetaData> tableMetaDataList,
                                                   Class<? extends ConditionsObject> objectType)

Find table meta data by object type.

Parameters:

tableMetaDataList - the list of table meta data e.g. from the registry

objectType - the type of the object

Returns:

the list of table meta data that have that object type

getCollectionClass

public Class<? extends ConditionsObjectCollection<?>> getCollectionClass()

Get the type of collection this table maps onto.

Returns:

the collection class

getFieldNames

public Set<String> getFieldNames()

Get the field names.

Returns:

the set of field names

getFieldType

public Class<?> getFieldType(String fieldName)

Get the type of the field called fieldName.

Returns:

the type of the field

getKey

public String getKey()

Get the key of this conditions type. May be different from table name but is usually the same.

Returns:

the key name of the conditions type

getObjectClass

public Class<? extends ConditionsObject> getObjectClass()

Get the type of object this table maps onto.

Returns:

the type of object

getTableName

public String getTableName()

Get the name of the table.

Returns:

the name of the table

newCollection

ConditionsObjectCollection<?> newCollection()
                                     throws ConditionsObjectException

Create a new collection instance from the table meta data's collection type.

Returns:

the new object collection

Throws:

ConditionsObjectException - if there is an error creating a new collection

newObject

ConditionsObject newObject()
                    throws ConditionsObjectException

Create a new object instance from the table meta data's object type.

Returns:

the new conditions object

Throws:

ConditionsObjectException - if there is an error creating a new object

setFieldNames

void setFieldNames(String[] fieldNames)

Set all the field names from an array of strings.

Parameters:

fieldNames - the names of the fields

setFieldType

void setFieldType(String fieldName,
                  Class<?> fieldType)

Set the type of a field.

Parameters:

fieldName - the field name

fieldType - the field's type (class)

setObjectClass

void setObjectClass(Class<? extends ConditionsObject> objectClass)

Set the class that maps to the database.

Parameters:

objectClass - the class that maps to the database

setTableName

void setTableName(String tableName)

Set the table name.

Parameters:

tableName - the table name

toString

public String toString()

Convert to a string.

Overrides:

toString in class Object

Returns:

This object converted to a string.

removeField

void removeField(String fieldName)

Method for removing a field that was found using the automatic introspection methods.