com.j256.ormlite.field
Class DatabaseFieldConfig

java.lang.Object
  extended by com.j256.ormlite.field.DatabaseFieldConfig

public class DatabaseFieldConfig
extends Object

Database field configuration information either supplied by a DatabaseField annotation or by direct Java or Spring wiring.

Author:
graywatson

Constructor Summary
DatabaseFieldConfig()
           
DatabaseFieldConfig(String fieldName)
           
DatabaseFieldConfig(String fieldName, String columnName, DataPersister dataPersister, String defaultValue, int width, boolean canBeNull, boolean id, boolean generatedId, String generatedIdSequence, boolean foreign, DatabaseTableConfig<?> foreignTableConfig, boolean useGetSet, Enum<?> unknownEnumValue, boolean throwIfNull, String format, boolean unique, String indexName, String uniqueIndexName, boolean autoRefresh, int maxForeignAutoRefreshLevel, int maxForeignCollectionLevel)
           
DatabaseFieldConfig(String fieldName, String columnName, DataType dataType, String defaultValue, int width, boolean canBeNull, boolean id, boolean generatedId, String generatedIdSequence, boolean foreign, DatabaseTableConfig<?> foreignTableConfig, boolean useGetSet, Enum<?> unknownEnumValue, boolean throwIfNull, String format, boolean unique, String indexName, String uniqueIndexName, boolean autoRefresh, int maxForeignAutoRefreshLevel, int maxForeignCollectionLevel)
           
 
Method Summary
static Method findGetMethod(Field field, boolean throwExceptions)
          Find and return the appropriate getter method for field.
static Method findSetMethod(Field field, boolean throwExceptions)
          Find and return the appropriate setter method for field.
static DatabaseFieldConfig fromDatabaseField(DatabaseType databaseType, String tableName, Field field, DatabaseField databaseField)
           
static DatabaseFieldConfig fromDatabaseFieldAnnotations(DatabaseType databaseType, String tableName, Field field, DatabaseFieldSimple simpleAnno, DatabaseFieldId idAnno, DatabaseFieldForeign foreignAnno, DatabaseFieldIndex indexAnno, DatabaseFieldOther otherAnno)
           
static DatabaseFieldConfig fromField(DatabaseType databaseType, String tableName, Field field)
          Create and return a config converted from a Field that may have one of the following annotations: DatabaseField, DatabaseFieldSimple, ForeignCollectionField, or javax.persistence...
 String getColumnDefinition()
           
 String getColumnName()
           
 DataPersister getDataPersister()
          The name is historical.
 String getDefaultValue()
           
 String getFieldName()
          Return the name of the field in the class.
 String getForeignCollectionOrderColumn()
           
 DatabaseTableConfig<?> getForeignTableConfig()
          For a foreign class which does not use the DatabaseField annotations, you need to inject the table configuration.
 String getFormat()
           
 String getGeneratedIdSequence()
           
 String getIndexName()
           
 int getMaxEagerForeignCollectionLevel()
           
 int getMaxForeignAutoRefreshLevel()
           
 Class<? extends DataPersister> getPersisterClass()
           
 String getUniqueIndexName()
           
 Enum<?> getUnknownEnumvalue()
          Deprecated. Switch to getUnknownEnumValue().
 Enum<?> getUnknownEnumValue()
           
 int getWidth()
           
 boolean isAllowGeneratedIdInsert()
           
 boolean isCanBeNull()
           
 boolean isForeign()
           
 boolean isForeignAutoCreate()
           
 boolean isForeignAutoRefresh()
           
 boolean isForeignCollection()
           
 boolean isForeignCollectionEager()
           
 boolean isGeneratedId()
           
 boolean isId()
           
 boolean isThrowIfNull()
           
 boolean isUnique()
           
 boolean isUniqueCombo()
           
 boolean isUseGetSet()
           
 boolean isVersion()
           
 void setAllowGeneratedIdInsert(boolean allowGeneratedIdInsert)
           
 void setCanBeNull(boolean canBeNull)
           
 void setColumnDefinition(String columnDefinition)
           
 void setColumnName(String columnName)
           
 void setDataPersister(DataPersister dataPersister)
          The name is historical.
 void setDataType(DataType dataType)
          The name is historical.
 void setDefaultValue(String defaultValue)
           
 void setFieldName(String fieldName)
           
 void setForeign(boolean foreign)
           
 void setForeignAutoCreate(boolean foreignAutoCreate)
           
 void setForeignAutoRefresh(boolean foreignAutoRefresh)
           
 void setForeignCollection(boolean foreignCollection)
           
 void setForeignCollectionEager(boolean foreignCollectionEager)
           
 void setForeignCollectionOrderColumn(String foreignCollectionOrderColumn)
           
 void setForeignTableConfig(DatabaseTableConfig<?> foreignTableConfig)
           
 void setFormat(String format)
           
 void setGeneratedId(boolean generatedId)
           
 void setGeneratedIdSequence(String generatedIdSequence)
           
 void setId(boolean id)
           
 void setIndexName(String indexName)
           
 void setMaxEagerForeignCollectionLevel(int maxEagerForeignCollectionLevel)
           
 void setMaxForeignAutoRefreshLevel(int maxForeignLevel)
           
 void setPersisterClass(Class<? extends DataPersister> persisterClass)
           
 void setThrowIfNull(boolean throwIfNull)
           
 void setUnique(boolean unique)
           
 void setUniqueCombo(boolean uniqueCombo)
           
 void setUniqueIndexName(String uniqueIndexName)
           
 void setUnknownEnumValue(Enum<?> unknownEnumValue)
           
 void setUseGetSet(boolean useGetSet)
           
 void setVersion(boolean version)
           
 void setWidth(int width)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DatabaseFieldConfig

public DatabaseFieldConfig()

DatabaseFieldConfig

public DatabaseFieldConfig(String fieldName)

DatabaseFieldConfig

public DatabaseFieldConfig(String fieldName,
                           String columnName,
                           DataType dataType,
                           String defaultValue,
                           int width,
                           boolean canBeNull,
                           boolean id,
                           boolean generatedId,
                           String generatedIdSequence,
                           boolean foreign,
                           DatabaseTableConfig<?> foreignTableConfig,
                           boolean useGetSet,
                           Enum<?> unknownEnumValue,
                           boolean throwIfNull,
                           String format,
                           boolean unique,
                           String indexName,
                           String uniqueIndexName,
                           boolean autoRefresh,
                           int maxForeignAutoRefreshLevel,
                           int maxForeignCollectionLevel)

DatabaseFieldConfig

public DatabaseFieldConfig(String fieldName,
                           String columnName,
                           DataPersister dataPersister,
                           String defaultValue,
                           int width,
                           boolean canBeNull,
                           boolean id,
                           boolean generatedId,
                           String generatedIdSequence,
                           boolean foreign,
                           DatabaseTableConfig<?> foreignTableConfig,
                           boolean useGetSet,
                           Enum<?> unknownEnumValue,
                           boolean throwIfNull,
                           String format,
                           boolean unique,
                           String indexName,
                           String uniqueIndexName,
                           boolean autoRefresh,
                           int maxForeignAutoRefreshLevel,
                           int maxForeignCollectionLevel)
Method Detail

getFieldName

public String getFieldName()
Return the name of the field in the class.


setFieldName

public void setFieldName(String fieldName)

getColumnName

public String getColumnName()
See Also:
DatabaseField.columnName()

setColumnName

public void setColumnName(String columnName)

setDataType

public void setDataType(DataType dataType)
The name is historical.


getDataPersister

public DataPersister getDataPersister()
The name is historical.

See Also:
DatabaseField.dataType()

setDataPersister

public void setDataPersister(DataPersister dataPersister)
The name is historical.


getDefaultValue

public String getDefaultValue()
See Also:
DatabaseField.defaultValue()

setDefaultValue

public void setDefaultValue(String defaultValue)

getWidth

public int getWidth()
See Also:
DatabaseField.width()

setWidth

public void setWidth(int width)

isCanBeNull

public boolean isCanBeNull()
See Also:
DatabaseField.canBeNull()

setCanBeNull

public void setCanBeNull(boolean canBeNull)

isId

public boolean isId()
See Also:
DatabaseField.id()

setId

public void setId(boolean id)

isGeneratedId

public boolean isGeneratedId()
See Also:
DatabaseField.generatedId()

setGeneratedId

public void setGeneratedId(boolean generatedId)

getGeneratedIdSequence

public String getGeneratedIdSequence()
See Also:
DatabaseField.generatedIdSequence()

setGeneratedIdSequence

public void setGeneratedIdSequence(String generatedIdSequence)

isForeign

public boolean isForeign()
See Also:
DatabaseField.foreign()

setForeign

public void setForeign(boolean foreign)

getForeignTableConfig

public DatabaseTableConfig<?> getForeignTableConfig()
For a foreign class which does not use the DatabaseField annotations, you need to inject the table configuration.


setForeignTableConfig

public void setForeignTableConfig(DatabaseTableConfig<?> foreignTableConfig)

isUseGetSet

public boolean isUseGetSet()
See Also:
DatabaseField.useGetSet()

setUseGetSet

public void setUseGetSet(boolean useGetSet)

getUnknownEnumvalue

@Deprecated
public Enum<?> getUnknownEnumvalue()
Deprecated. Switch to getUnknownEnumValue().


getUnknownEnumValue

public Enum<?> getUnknownEnumValue()

setUnknownEnumValue

public void setUnknownEnumValue(Enum<?> unknownEnumValue)

isThrowIfNull

public boolean isThrowIfNull()

setThrowIfNull

public void setThrowIfNull(boolean throwIfNull)

getFormat

public String getFormat()

setFormat

public void setFormat(String format)

isUnique

public boolean isUnique()

setUnique

public void setUnique(boolean unique)

isUniqueCombo

public boolean isUniqueCombo()

setUniqueCombo

public void setUniqueCombo(boolean uniqueCombo)

getIndexName

public String getIndexName()

setIndexName

public void setIndexName(String indexName)

getUniqueIndexName

public String getUniqueIndexName()

setUniqueIndexName

public void setUniqueIndexName(String uniqueIndexName)

setForeignAutoRefresh

public void setForeignAutoRefresh(boolean foreignAutoRefresh)

isForeignAutoRefresh

public boolean isForeignAutoRefresh()

getMaxForeignAutoRefreshLevel

public int getMaxForeignAutoRefreshLevel()

setMaxForeignAutoRefreshLevel

public void setMaxForeignAutoRefreshLevel(int maxForeignLevel)

getMaxEagerForeignCollectionLevel

public int getMaxEagerForeignCollectionLevel()

setMaxEagerForeignCollectionLevel

public void setMaxEagerForeignCollectionLevel(int maxEagerForeignCollectionLevel)

setForeignCollection

public void setForeignCollection(boolean foreignCollection)

isForeignCollection

public boolean isForeignCollection()

setForeignCollectionEager

public void setForeignCollectionEager(boolean foreignCollectionEager)

isForeignCollectionEager

public boolean isForeignCollectionEager()

setForeignCollectionOrderColumn

public void setForeignCollectionOrderColumn(String foreignCollectionOrderColumn)

getForeignCollectionOrderColumn

public String getForeignCollectionOrderColumn()

getPersisterClass

public Class<? extends DataPersister> getPersisterClass()

setPersisterClass

public void setPersisterClass(Class<? extends DataPersister> persisterClass)

isAllowGeneratedIdInsert

public boolean isAllowGeneratedIdInsert()

setAllowGeneratedIdInsert

public void setAllowGeneratedIdInsert(boolean allowGeneratedIdInsert)

getColumnDefinition

public String getColumnDefinition()

setColumnDefinition

public void setColumnDefinition(String columnDefinition)

isForeignAutoCreate

public boolean isForeignAutoCreate()

setForeignAutoCreate

public void setForeignAutoCreate(boolean foreignAutoCreate)

isVersion

public boolean isVersion()

setVersion

public void setVersion(boolean version)

fromField

public static DatabaseFieldConfig fromField(DatabaseType databaseType,
                                            String tableName,
                                            Field field)
                                     throws SQLException
Create and return a config converted from a Field that may have one of the following annotations: DatabaseField, DatabaseFieldSimple, ForeignCollectionField, or javax.persistence...

Throws:
SQLException

findGetMethod

public static Method findGetMethod(Field field,
                                   boolean throwExceptions)
Find and return the appropriate getter method for field.

Returns:
Get method or null if none found.

findSetMethod

public static Method findSetMethod(Field field,
                                   boolean throwExceptions)
Find and return the appropriate setter method for field.

Returns:
Set method or null if none found.

fromDatabaseField

public static DatabaseFieldConfig fromDatabaseField(DatabaseType databaseType,
                                                    String tableName,
                                                    Field field,
                                                    DatabaseField databaseField)

fromDatabaseFieldAnnotations

public static DatabaseFieldConfig fromDatabaseFieldAnnotations(DatabaseType databaseType,
                                                               String tableName,
                                                               Field field,
                                                               DatabaseFieldSimple simpleAnno,
                                                               DatabaseFieldId idAnno,
                                                               DatabaseFieldForeign foreignAnno,
                                                               DatabaseFieldIndex indexAnno,
                                                               DatabaseFieldOther otherAnno)


This content is licensed by Gray Watson under the Creative Commons Attribution-Share Alike 3.0 License.