com.j256.ormlite.table

Class TableInfo<T,ID>

java.lang.Object

com.j256.ormlite.table.TableInfo<T,ID>

Type Parameters:

T - The class that the code will be operating on.

ID - The class of the ID column associated with the class. The T class does not require an ID field. The class needs an ID parameter however so you can use Void or Object to satisfy the compiler.

public class TableInfo<T,ID>
extends Object

Information about a database table including the associated tableName, class, constructor, and the included fields.

Author:

graywatson

Constructor Summary

Constructors

Constructor and Description
TableInfo(DatabaseType databaseType, Class<T> dataClass) Creates a holder of information about a table/class.
TableInfo(DatabaseType databaseType, DatabaseTableConfig<T> tableConfig) Creates a holder of information about a table/class.

Method Summary

Modifier and Type	Method and Description
Class<T>	getDataClass() Return the class associated with this object-info.
FieldType	getFieldTypeByColumnName(String columnName) Return the FieldType associated with the columnName.
FieldType[]	getFieldTypes() Return the array of field types associated with the object.
FieldType[]	getForeignCollections() Return an array with the fields that are ForeignCollections or a blank array if none.
FieldType	getIdField() Return the id-field associated with the object.
String	getSchemaName() Return the name of the schema or null if none.
String	getTableName() Return the name of the table associated with the object.
boolean	hasColumnName(String columnName) Return true if this table information has a field with this columnName as set by DatabaseField.columnName() or the field name if not set.
boolean	isForeignAutoCreate() Return true if one of the fields has DatabaseField.foreignAutoCreate() enabled.
boolean	isUpdatable() Return true if we can update this object via its ID.
String	objectToString(T object) Return a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableInfo

public TableInfo(DatabaseType databaseType,
                 Class<T> dataClass)
          throws SQLException

Creates a holder of information about a table/class.

Parameters:

databaseType - Database type we are storing the class in.

dataClass - Class that we are holding information about.

Throws:

SQLException

TableInfo

public TableInfo(DatabaseType databaseType,
                 DatabaseTableConfig<T> tableConfig)
          throws SQLException

Creates a holder of information about a table/class.

Parameters:

databaseType - Database type we are storing the class in.

tableConfig - Configuration for our table.

Throws:

SQLException

Method Detail

getDataClass

public Class<T> getDataClass()

Return the class associated with this object-info.

getTableName

public String getTableName()

Return the name of the table associated with the object.

getSchemaName

public String getSchemaName()

Return the name of the schema or null if none.

getFieldTypes

public FieldType[] getFieldTypes()

Return the array of field types associated with the object.

getFieldTypeByColumnName

public FieldType getFieldTypeByColumnName(String columnName)

Return the FieldType associated with the columnName.

getIdField

public FieldType getIdField()

Return the id-field associated with the object.

objectToString

public String objectToString(T object)

Return a string representation of the object.

isUpdatable

public boolean isUpdatable()

Return true if we can update this object via its ID.

isForeignAutoCreate

public boolean isForeignAutoCreate()

Return true if one of the fields has DatabaseField.foreignAutoCreate() enabled.

getForeignCollections

public FieldType[] getForeignCollections()

Return an array with the fields that are ForeignCollections or a blank array if none.

hasColumnName

public boolean hasColumnName(String columnName)

Return true if this table information has a field with this columnName as set by DatabaseField.columnName() or the field name if not set.