ColumnInfo (DBFlute Runtime 1.1.0-sp2-RC1 API)

java.lang.Object
- org.dbflute.dbmeta.info.ColumnInfo

```
public class ColumnInfo
extends Object
```
The information of column.

作成者:

jflute

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected boolean`	`_autoIncrement`
`protected boolean`	`_canBeNullObject`
`protected ClassificationMeta`	`_classificationMeta`
`protected String`	`_columnAlias`
`protected String`	`_columnComment`
`protected String`	`_columnDbName`
`protected String`	`_columnDbType`
`protected Integer`	`_columnSize`
`protected ColumnSqlName`	`_columnSqlName`
`protected String`	`_columnSynonym`
`protected boolean`	`_commonColumn`
`protected DBMeta`	`_dbmeta`
`protected Integer`	`_decimalDigits`
`protected String`	`_defaultValue`
`protected boolean`	`_foreignKey`
`protected List<String>`	`_foreignPropList`
`protected boolean`	`_notNull`
`protected Class<?>`	`_objectNativeType`
`protected DBMeta.OptimisticLockType`	`_optimisticLockType`
`protected boolean`	`_primary`
`protected Class<?>`	`_propertyAccessType`
`protected PropertyGateway`	`_propertyGateway`
`protected PropertyMethodFinder`	`_propertyMethodFinder`
`protected String`	`_propertyName`
`protected Method`	`_readMethod`
`protected List<String>`	`_referrerPropList`
`protected Method`	`_writeMethod`
`protected static List<String>`	`EMPTY_LIST` The empty read-only list for empty property.
`protected static Set<String>`	`JAVA8_DATE_TYPE_SET` The set of type name for Java8Time judgment.
`protected static String`	`JAVA8_JUST_DATE_TYPE` The type name of Java8Time's just date.
`protected static String`	`JAVA8_JUST_TIME_TYPE` The type name of Java8Time's just time.
`protected static String`	`JAVA8_JUST_TIMESTAMP_TYPE` The type name of Java8Time's just time-stamp.

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
ColumnInfo(DBMeta dbmeta, String columnDbName, String columnSqlName, String columnSynonym, String columnAlias, Class<?> objectNativeType, String propertyName, Class<?> propertyAccessType, boolean primary, boolean autoIncrement, boolean notNull, String columnDbType, Integer columnSize, Integer decimalDigits, String defaultValue, boolean commonColumn, DBMeta.OptimisticLockType optimisticLockType, String columnComment, List<String> foreignPropList, List<String> referrerPropList, ClassificationMeta classificationMeta, boolean canBeNullObject, PropertyMethodFinder propertyMethodFinder)

メソッドのサマリー

All Methods Static Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`protected void`	`assertObjectNotNull(String variableName, Object value)`
`protected boolean`	`assignableObjectNativeTypeJava8Date()`
`protected boolean`	`assignableObjectNativeTypeUtilDate()`
`boolean`	`canBeNullObject()` Can the column be null object?
`<VALUE> VALUE`	`convertToObjectNativeType(Object value)` Convert the value to object native type.
`void`	`diveIntoFlexibleMap(Map<String,ColumnInfo> flexibleMap)` Dive into flexible map by flexible keys.
`protected <VALUE> VALUE`	`doConvertToObjectNativeType(Object value)`
`boolean`	`equals(Object obj)`
`protected PropertyGateway`	`findPropertyGateway()`
`protected Method`	`findReadMethod()`
`protected Method`	`findWriteMethod()`
`static List<String>`	`generateFlexibleKeyList(String columnDbName, String columnSynonym, String propertyName)` Generate the list of flexible keys.
`ClassificationMeta`	`getClassificationMeta()` Get the meta of classification related to the column.
`String`	`getColumnAlias()` Get the alias of the column.
`String`	`getColumnComment()` Get the comment of the column.
`String`	`getColumnDbName()` Get the DB name of the column.
`String`	`getColumnDbType()` Get the DB type of the column.
`Integer`	`getColumnSize()` Get the size of the column.
`ColumnSqlName`	`getColumnSqlName()` Get the SQL name of the column.
`String`	`getColumnSynonym()` Get the synonym of the column.
`DBMeta`	`getDBMeta()` Get the DB meta of the column's table.
`Integer`	`getDecimalDigits()` Get the decimal digits of the column.
`String`	`getDefaultValue()` Get the default value of the column.
`protected List<String>`	`getFlexibleKeyList()` Get the list of flexible keys for this column.
`List<ForeignInfo>`	`getForeignInfoList()` Get the read-only list of the foreign info related to this column.
`Class<?>`	`getGenericType()` Get the generic type of property type for list property.
`Class<?>`	`getObjectNativeType()` Get the native type mapped to object for the column.
`Class<?>`	`getPropertyAccessType()` Get the type of property access for the column.
`PropertyGateway`	`getPropertyGateway()` Get the property gateway for the column.
`String`	`getPropertyName()` Get the name of property for the column.
`Method`	`getReadMethod()` Get the read method for entity reflection.
`List<ReferrerInfo>`	`getReferrerInfoList()` Get the read-only list of the referrer info related to this column.
`Method`	`getWriteMethod()` Get the write method for entity reflection.
`int`	`hashCode()`
`protected String`	`initCap(String name)`
`boolean`	`isAutoIncrement()` Is the column auto increment?
`boolean`	`isCommonColumn()` Is the column a part of common columns?
`boolean`	`isForeignKey()` Is the column a part of any foreign key?
`boolean`	`isNotNull()` Is the column not null?
`boolean`	`isObjectNativeTypeDate()` Is the object native type Date?
`boolean`	`isObjectNativeTypeJustDate()` Is the object native type just (equals) date?
`boolean`	`isObjectNativeTypeJustTime()` Is the object native type just (equals) time?
`boolean`	`isObjectNativeTypeJustTimestamp()` Is the object native type just (equals) time-stamp?
`boolean`	`isObjectNativeTypeNumber()` Is the object native type Number?
`boolean`	`isObjectNativeTypeString()` Is the object native type String?
`boolean`	`isOptimisticLock()` Is the column for optimistic lock?
`boolean`	`isPrimary()` Is the column a part of primary keys?
`boolean`	`isUpdateDate()` Is the column update-date for optimistic lock?
`boolean`	`isVersionNo()` Is the column version-no for optimistic lock?
`protected boolean`	`justObjectNativeJava8Date()`
`protected boolean`	`justObjectNativeJava8Time()`
`protected boolean`	`justObjectNativeJava8Timestamp()`
`protected boolean`	`justObjectNativeTypeUtilDate()`
`protected boolean`	`justObjectNativeTypeUtilTime()`
`protected boolean`	`justObjectNativeTypeUtilTimestamp()`
`<PROPERTY> PROPERTY`	`read(Entity entity)` Read the value from the entity by its gateway (means no reflection).
`String`	`toString()`
`void`	`write(Entity entity, Object value)` Write the value to the entity by its gateway (means no reflection).

クラスから継承されたメソッド java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - EMPTY_LIST
```
protected static final List<String> EMPTY_LIST
```
    The empty read-only list for empty property.
  - JAVA8_JUST_DATE_TYPE
```
protected static final String JAVA8_JUST_DATE_TYPE
```
    The type name of Java8Time's just date.
  - JAVA8_JUST_TIMESTAMP_TYPE
```
protected static final String JAVA8_JUST_TIMESTAMP_TYPE
```
    The type name of Java8Time's just time-stamp.
  - JAVA8_JUST_TIME_TYPE
```
protected static final String JAVA8_JUST_TIME_TYPE
```
    The type name of Java8Time's just time.
  - JAVA8_DATE_TYPE_SET
```
protected static final Set<String> JAVA8_DATE_TYPE_SET
```
    The set of type name for Java8Time judgment.
  - _dbmeta
```
protected final DBMeta _dbmeta
```
  - _columnDbName
```
protected final String _columnDbName
```
  - _columnSqlName
```
protected final ColumnSqlName _columnSqlName
```
  - _columnSynonym
```
protected final String _columnSynonym
```
  - _columnAlias
```
protected final String _columnAlias
```
  - _propertyName
```
protected final String _propertyName
```
  - _objectNativeType
```
protected final Class<?> _objectNativeType
```
  - _propertyAccessType
```
protected final Class<?> _propertyAccessType
```
  - _primary
```
protected final boolean _primary
```
  - _autoIncrement
```
protected final boolean _autoIncrement
```
  - _notNull
```
protected final boolean _notNull
```
  - _columnDbType
```
protected final String _columnDbType
```
  - _columnSize
```
protected final Integer _columnSize
```
  - _decimalDigits
```
protected final Integer _decimalDigits
```
  - _defaultValue
```
protected final String _defaultValue
```
  - _commonColumn
```
protected final boolean _commonColumn
```
  - _optimisticLockType
```
protected final DBMeta.OptimisticLockType _optimisticLockType
```
  - _columnComment
```
protected final String _columnComment
```
  - _foreignPropList
```
protected final List<String> _foreignPropList
```
  - _referrerPropList
```
protected final List<String> _referrerPropList
```
  - _foreignKey
```
protected final boolean _foreignKey
```
  - _classificationMeta
```
protected final ClassificationMeta _classificationMeta
```
  - _canBeNullObject
```
protected final boolean _canBeNullObject
```
  - _propertyGateway
```
protected final PropertyGateway _propertyGateway
```
  - _propertyMethodFinder
```
protected final PropertyMethodFinder _propertyMethodFinder
```
  - _readMethod
```
protected final Method _readMethod
```
  - _writeMethod
```
protected final Method _writeMethod
```
- コンストラクタの詳細
  - ColumnInfo
```
public ColumnInfo(DBMeta dbmeta,
                  String columnDbName,
                  String columnSqlName,
                  String columnSynonym,
                  String columnAlias,
                  Class<?> objectNativeType,
                  String propertyName,
                  Class<?> propertyAccessType,
                  boolean primary,
                  boolean autoIncrement,
                  boolean notNull,
                  String columnDbType,
                  Integer columnSize,
                  Integer decimalDigits,
                  String defaultValue,
                  boolean commonColumn,
                  DBMeta.OptimisticLockType optimisticLockType,
                  String columnComment,
                  List<String> foreignPropList,
                  List<String> referrerPropList,
                  ClassificationMeta classificationMeta,
                  boolean canBeNullObject,
                  PropertyMethodFinder propertyMethodFinder)
```
- メソッドの詳細
  - getPropertyGateway
```
public PropertyGateway getPropertyGateway()
```
    Get the property gateway for the column.
    
    戻り値:
    
    The property gateway for the column, cached in this instance. (NotNull)
  - read
```
public <PROPERTY> PROPERTY read(Entity entity)
```
    Read the value from the entity by its gateway (means no reflection).
    It returns plain value in entity as property access type.
    
    型パラメータ:
    
    PROPERTY - The type of the property.
    
    パラメータ:
    
    entity - The target entity of this column to read. (NotNull)
    
    戻り値:
    
    The read value. (NullAllowed)
  - getReadMethod
```
public Method getReadMethod()
```
    Get the read method for entity reflection.
    
    戻り値:
    
    The read method, cached in this instance. (NotNull)
  - write
```
public void write(Entity entity,
                  Object value)
```
    Write the value to the entity by its gateway (means no reflection).
    It contains the basic conversion, but no converting to optional so check the property access type.
    
    パラメータ:
    
    entity - The target entity of this column to write. (NotNull)
    
    value - The written value. (NullAllowed: if null, null value is written)
  - getWriteMethod
```
public Method getWriteMethod()
```
    Get the write method for entity reflection.
    
    戻り値:
    
    The writer method, cached in this instance. (NotNull)
  - getGenericType
```
public Class<?> getGenericType()
```
    Get the generic type of property type for list property.
    
    戻り値:
    
    The type instance. (NullAllowed: when not list type)
  - findPropertyGateway
```
protected PropertyGateway findPropertyGateway()
```
  - findReadMethod
```
protected Method findReadMethod()
```
  - findWriteMethod
```
protected Method findWriteMethod()
```
  - convertToObjectNativeType
```
public <VALUE> VALUE convertToObjectNativeType(Object value)
```
    Convert the value to object native type.
    
    型パラメータ:
    
    VALUE - The type of column value.
    
    パラメータ:
    
    value - The conversion target value. (NullAllowed: if null, returns null)
    
    戻り値:
    
    The converted value as object native type. (NullAllowed: when the value is null)
  - doConvertToObjectNativeType
```
protected <VALUE> VALUE doConvertToObjectNativeType(Object value)
```
  - diveIntoFlexibleMap
```
public void diveIntoFlexibleMap(Map<String,ColumnInfo> flexibleMap)
```
    Dive into flexible map by flexible keys.
    
    パラメータ:
    
    flexibleMap - The flexible map for column. (NotNull)
  - getFlexibleKeyList
```
protected List<String> getFlexibleKeyList()
```
    Get the list of flexible keys for this column.
    
    戻り値:
    
    The list of flexible keys. (NotNull)
  - generateFlexibleKeyList
```
public static List<String> generateFlexibleKeyList(String columnDbName,
                                                   String columnSynonym,
                                                   String propertyName)
```
    Generate the list of flexible keys. (static utility)
    
    パラメータ:
    
    columnDbName - The DB name of column. (NotNull)
    
    columnSynonym - The DB synonym name of column. (NotNull)
    
    propertyName - The property name of column. (NotNull)
    
    戻り値:
    
    The list of flexible keys. (NotNull)
  - initCap
```
protected String initCap(String name)
```
  - assertObjectNotNull
```
protected void assertObjectNotNull(String variableName,
                                   Object value)
```
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    
    hashCode クラス内 Object
  - equals
```
public boolean equals(Object obj)
```
    オーバーライド:
    
    equals クラス内 Object
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object
  - getDBMeta
```
public DBMeta getDBMeta()
```
    Get the DB meta of the column's table.
    
    戻り値:
    
    The DB meta singleton instance. (NotNull)
  - getColumnDbName
```
public String getColumnDbName()
```
    Get the DB name of the column.
    This is for identity of column. (NOT for SQL)
    
    戻り値:
    
    The DB name of the column. (NotNull)
  - getColumnSqlName
```
public ColumnSqlName getColumnSqlName()
```
    Get the SQL name of the column.
    This is for SQL, which is resolved about schema prefix and quoted and so on...
    
    戻り値:
    
    The SQL-name object of the column. (NotNull)
  - getColumnSynonym
```
public String getColumnSynonym()
```
    Get the synonym of the column.
    This is for the synonym of DBFlute. (for example, PgReservColumn handling)
    
    戻り値:
    
    The synonym of the column. (NullAllowed: when the column does not have its synonym)
  - getColumnAlias
```
public String getColumnAlias()
```
    Get the alias of the column.
    
    戻り値:
    
    The alias of the column. (NullAllowed: when it cannot get an alias from meta)
  - getObjectNativeType
```
public Class<?> getObjectNativeType()
```
    Get the native type mapped to object for the column. (NOT property access type)
    e.g. String even if optional is defined at getter/setter in entity.
    Also there is the other method that returns property access type.
    
    戻り値:
    
    The class type of property for the column. (NotNull)
  - isObjectNativeTypeString
```
public boolean isObjectNativeTypeString()
```
    Is the object native type String? (assignable from)
    
    戻り値:
    
    The determination, true or false.
  - isObjectNativeTypeNumber
```
public boolean isObjectNativeTypeNumber()
```
    Is the object native type Number? (assignable from)
    
    戻り値:
    
    The determination, true or false.
  - isObjectNativeTypeDate
```
public boolean isObjectNativeTypeDate()
```
    Is the object native type Date? (assignable from)
    
    戻り値:
    
    The determination, true or false.
  - assignableObjectNativeTypeUtilDate
```
protected boolean assignableObjectNativeTypeUtilDate()
```
  - assignableObjectNativeTypeJava8Date
```
protected boolean assignableObjectNativeTypeJava8Date()
```
  - isObjectNativeTypeJustDate
```
public boolean isObjectNativeTypeJustDate()
```
    Is the object native type just (equals) date?
    
    戻り値:
    
    The determination, true or false.
  - justObjectNativeTypeUtilDate
```
protected boolean justObjectNativeTypeUtilDate()
```
  - justObjectNativeJava8Date
```
protected boolean justObjectNativeJava8Date()
```
  - isObjectNativeTypeJustTimestamp
```
public boolean isObjectNativeTypeJustTimestamp()
```
    Is the object native type just (equals) time-stamp?
    
    戻り値:
    
    The determination, true or false.
  - justObjectNativeTypeUtilTimestamp
```
protected boolean justObjectNativeTypeUtilTimestamp()
```
  - justObjectNativeJava8Timestamp
```
protected boolean justObjectNativeJava8Timestamp()
```
  - isObjectNativeTypeJustTime
```
public boolean isObjectNativeTypeJustTime()
```
    Is the object native type just (equals) time? (assignable from)
    
    戻り値:
    
    The determination, true or false.
  - justObjectNativeTypeUtilTime
```
protected boolean justObjectNativeTypeUtilTime()
```
  - justObjectNativeJava8Time
```
protected boolean justObjectNativeJava8Time()
```
  - getPropertyName
```
public String getPropertyName()
```
    Get the name of property for the column. (JavaBeansRule)
    
    戻り値:
    
    The name of property for the column. (NotNull)
  - getPropertyAccessType
```
public Class<?> getPropertyAccessType()
```
    Get the type of property access for the column.
    It is defined at getter/setter in entity. (e.g. String or Optional)
    Also there is the other method that always returns object native type.
    
    戻り値:
    
    The class type to access the property. (NotNull)
  - isPrimary
```
public boolean isPrimary()
```
    Is the column a part of primary keys?
    
    戻り値:
    
    The determination, true or false.
  - isAutoIncrement
```
public boolean isAutoIncrement()
```
    Is the column auto increment?
    
    戻り値:
    
    The determination, true or false.
  - isNotNull
```
public boolean isNotNull()
```
    Is the column not null?
    
    戻り値:
    
    The determination, true or false.
  - getColumnDbType
```
public String getColumnDbType()
```
    Get the DB type of the column.
    
    戻り値:
    
    The DB type of the column. (NotNull: If the type is unknown, it returns 'UnknownType'.)
  - getColumnSize
```
public Integer getColumnSize()
```
    Get the size of the column.
    
    戻り値:
    
    The size of the column. (NullAllowed: If the type does not have size, it returns null.)
  - getDecimalDigits
```
public Integer getDecimalDigits()
```
    Get the decimal digits of the column.
    
    戻り値:
    
    The decimal digits of the column. (NullAllowed: If the type does not have digits, it returns null.)
  - getDefaultValue
```
public String getDefaultValue()
```
    Get the default value of the column. (as string)
    
    戻り値:
    
    The default value of the column. (NullAllowed)
  - isCommonColumn
```
public boolean isCommonColumn()
```
    Is the column a part of common columns?
    
    戻り値:
    
    The determination, true or false.
  - isOptimisticLock
```
public boolean isOptimisticLock()
```
    Is the column for optimistic lock?
    
    戻り値:
    
    The determination, true or false.
  - isVersionNo
```
public boolean isVersionNo()
```
    Is the column version-no for optimistic lock?
    
    戻り値:
    
    The determination, true or false.
  - isUpdateDate
```
public boolean isUpdateDate()
```
    Is the column update-date for optimistic lock?
    
    戻り値:
    
    The determination, true or false.
  - getColumnComment
```
public String getColumnComment()
```
    Get the comment of the column.
    If the real comment contains the alias, this result does NOT contain it and its delimiter.
    
    戻り値:
    
    The comment of the column. (NullAllowed: when it cannot get an alias from meta)
  - getForeignInfoList
```
public List<ForeignInfo> getForeignInfoList()
```
    Get the read-only list of the foreign info related to this column.
    It contains one-to-one relations.
    
    戻り値:
    
    The read-only list. (NotNull: when no FK, returns empty list)
  - getReferrerInfoList
```
public List<ReferrerInfo> getReferrerInfoList()
```
    Get the read-only list of the referrer info related to this column.
    
    戻り値:
    
    The read-only list. (NotNull: when no reference, returns empty list)
  - isForeignKey
```
public boolean isForeignKey()
```
    Is the column a part of any foreign key?
    
    戻り値:
    
    The determination, true or false.
  - getClassificationMeta
```
public ClassificationMeta getClassificationMeta()
```
    Get the meta of classification related to the column.
    
    戻り値:
    
    The instance of classification meta. (NullAllowed)
  - canBeNullObject
```
public boolean canBeNullObject()
```
    Can the column be null object?
    
    戻り値:
    
    The determination, true or false.

クラス ColumnInfo

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

EMPTY_LIST

JAVA8_JUST_DATE_TYPE

JAVA8_JUST_TIMESTAMP_TYPE

JAVA8_JUST_TIME_TYPE

JAVA8_DATE_TYPE_SET

_dbmeta

_columnDbName

_columnSqlName

_columnSynonym

_columnAlias

_propertyName

_objectNativeType

_propertyAccessType

_primary

_autoIncrement

_notNull

_columnDbType

_columnSize

_decimalDigits

_defaultValue

_commonColumn

_optimisticLockType

_columnComment

_foreignPropList

_referrerPropList

_foreignKey

_classificationMeta

_canBeNullObject

_propertyGateway

_propertyMethodFinder

_readMethod

_writeMethod

コンストラクタの詳細

ColumnInfo

メソッドの詳細

getPropertyGateway

read

getReadMethod

write

getWriteMethod

getGenericType

findPropertyGateway

findReadMethod

findWriteMethod

convertToObjectNativeType

doConvertToObjectNativeType

diveIntoFlexibleMap

getFlexibleKeyList

generateFlexibleKeyList

initCap

assertObjectNotNull

hashCode

equals

toString

getDBMeta

getColumnDbName

getColumnSqlName

getColumnSynonym

getColumnAlias

getObjectNativeType

isObjectNativeTypeString

isObjectNativeTypeNumber

isObjectNativeTypeDate

assignableObjectNativeTypeUtilDate

assignableObjectNativeTypeJava8Date

isObjectNativeTypeJustDate

justObjectNativeTypeUtilDate

justObjectNativeJava8Date

isObjectNativeTypeJustTimestamp

justObjectNativeTypeUtilTimestamp

justObjectNativeJava8Timestamp

isObjectNativeTypeJustTime

justObjectNativeTypeUtilTime

justObjectNativeJava8Time