DBMeta (DBFlute Runtime 1.1.0-sp2-RC1 API)

既知の実装クラスのリスト:

AbstractDBMeta
```
public interface DBMeta
```
The interface of DB meta for one table.

作成者:

jflute

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプインタフェースと説明

static class DBMeta.OptimisticLockType

ネストされたクラス
修飾子とタイプ	インタフェースと説明
`static class`	`DBMeta.OptimisticLockType`

メソッドのサマリー

All Methods Instance Methods Abstract Methods Deprecated Methods
修飾子とタイプ	メソッドと説明
`void`	`acceptAllColumnMap(Entity entity, Map<String,? extends Object> allColumnMap)` Accept the map of all columns. map:{[column-name] = [value]} Derived columns are not accepted, physical columns only.
`void`	`acceptPrimaryKeyMap(Entity entity, Map<String,? extends Object> primaryKeyMap)` Accept the map of primary-keys. map:{[column-name] = [value]}
`Map<String,Object>`	`extractAllColumnMap(Entity entity)` Extract The map of all columns. map:{[column-name] = [value]} Derived columns are not extracted, physical columns only.
`Map<String,Object>`	`extractPrimaryKeyMap(Entity entity)` Extract the map of primary-keys. map:{[column-name] = [value]}
`ColumnInfo`	`findColumnInfo(String columnFlexibleName)` Find the information of the column by the flexible name of the column.
`String`	`findDbName(String flexibleName)` Find DB name by flexible name.
`DBMeta`	`findForeignDBMeta(String foreignPropertyName)` Find the DB meta of foreign relation.
`ForeignInfo`	`findForeignInfo(int relationNo)` Find the information of foreign relation by relation number.
`ForeignInfo`	`findForeignInfo(String foreignPropertyName)` Find the information of foreign relation by property name.
`PropertyGateway`	`findForeignPropertyGateway(String foreignPropertyName)` Find the foreign property gateway of the entity for the relation.
`PropertyGateway`	`findPropertyGateway(String propertyName)` Find the property gateway of the entity for the column.
`String`	`findPropertyName(String flexibleName)` Find property name(JavaBeansRule) by flexible name.
`DBMeta`	`findReferrerDBMeta(String referrerPropertyName)` Find the DB meta of referrer relation.
`ReferrerInfo`	`findReferrerInfo(String referrerPropertyName)` Find the information of referrer relation.
`RelationInfo`	`findRelationInfo(String relationPropertyName)` Find the information of relation.
`String`	`getBehaviorTypeName()` Get the type name of behavior.
`List<ColumnInfo>`	`getColumnInfoList()` Get the list of column information.
`List<ColumnInfo>`	`getCommonColumnInfoBeforeInsertList()` Get the list of common column auto-setup before insert.
`List<ColumnInfo>`	`getCommonColumnInfoBeforeUpdateList()` Get the list of common column auto-setup before update.
`List<ColumnInfo>`	`getCommonColumnInfoList()` Get the list of common column.
`String`	`getConditionBeanTypeName()` Get the type name of condition-bean.
`DBDef`	`getCurrentDBDef()` Get the current DB definition.
`Class<? extends Entity>`	`getEntityType()` Get the type of entity.
`String`	`getEntityTypeName()` Get the type name of entity.
`List<ForeignInfo>`	`getForeignInfoList()` Get the read-only list of foreign info.
`String`	`getGenerationGapBasePrefix()` Get base prefix of the database for generation gap.
`PrimaryInfo`	`getPrimaryInfo()` Get primary info that means unique info for primary key.
`UniqueInfo`	`getPrimaryUniqueInfo()` 非推奨です。 use getPrimaryInfo()
`String`	`getProjectName()` Get project name of the database (DBFlute client) for the table.
`String`	`getProjectPrefix()` Get project prefix of the database for the table, used as class name.
`List<ReferrerInfo>`	`getReferrerInfoList()` Get the read-only list of referrer info.
`Integer`	`getSequenceCacheSize()` Get the cache size of sequence.
`Integer`	`getSequenceIncrementSize()` Get the increment size of sequence.
`String`	`getSequenceName()` Get the sequence name.
`String`	`getSequenceNextValSql()` Get the SQL for next value of sequence.
`String`	`getTableAlias()` Get the alias of the table.
`String`	`getTableComment()` Get the comment of the table.
`String`	`getTableDbName()` Get the DB name of the table, can be identity of table.
`String`	`getTableDispName()` Get the display name of the table for human viewing.
`String`	`getTablePropertyName()` Get the property name (JavaBeansRule) of table.
`TableSqlName`	`getTableSqlName()` Get the SQL name of table.
`List<UniqueInfo>`	`getUniqueInfoList()` Get the read-only list of unique info as natural unique (not contain primary key's unique).
`ColumnInfo`	`getUpdateDateColumnInfo()` Get the column information of update date.
`ColumnInfo`	`getVersionNoColumnInfo()` Get the column information of version no.
`boolean`	`hasColumn(String columnFlexibleName)` Does this table have the corresponding column?
`boolean`	`hasCommonColumn()` Does the table have common columns?
`boolean`	`hasCompoundPrimaryKey()` Does this table have compound primary-key?
`boolean`	`hasFlexibleName(String flexibleName)` Does the table have an object for the flexible name?
`boolean`	`hasForeign(String foreignPropertyName)` Does this table have the corresponding foreign relation?
`boolean`	`hasIdentity()` Does this table have identity?
`boolean`	`hasOptimisticLock()` Does the table have optimistic lock?
`boolean`	`hasPrimaryKey()` Does this table have primary-key?
`boolean`	`hasReferrer(String referrerPropertyName)` Does this table have the corresponding referrer relation?
`boolean`	`hasSequence()` Does this table have sequence?
`boolean`	`hasUpdateDate()` Does the table have a column for update date?
`boolean`	`hasVersionNo()` Does the table have a column for version no?
`Entity`	`newEntity()` New the instance of entity.
`List<ForeignInfo>`	`searchForeignInfoList(Collection<ColumnInfo> columnInfoList)` Search foreign info by the specified columns.
`OptionalObject<PrimaryInfo>`	`searchPrimaryInfo(Collection<ColumnInfo> columnInfoList)` Search primary info by the specified columns.
`List<ReferrerInfo>`	`searchReferrerInfoList(Collection<ColumnInfo> columnInfoList)` Search referrer info by the specified columns.
`List<UniqueInfo>`	`searchUniqueInfoList(Collection<ColumnInfo> columnInfoList)` Search unique info by the specified columns.

- メソッドの詳細
  - getProjectName
```
String getProjectName()
```
    Get project name of the database (DBFlute client) for the table.
    
    戻り値:
    
    The name string, lower case in many cases. e.g. maihamadb (NotNull)
  - getProjectPrefix
```
String getProjectPrefix()
```
    Get project prefix of the database for the table, used as class name. (normally empty)
    
    戻り値:
    
    The prefix string, camel case in many cases. e.g. Resola (ResolaStationCB) (NotNull, EmptyAllowed)
  - getGenerationGapBasePrefix
```
String getGenerationGapBasePrefix()
```
    Get base prefix of the database for generation gap. (normally 'Bs')
    
    戻り値:
    
    The prefix string, camel case in many cases. e.g. Bs (BsMemberCB) (NotNull, EmptyAllowed)
  - getCurrentDBDef
```
DBDef getCurrentDBDef()
```
    Get the current DB definition.
    
    戻り値:
    
    The current DB definition. (NotNull)
  - findPropertyGateway
```
PropertyGateway findPropertyGateway(String propertyName)
```
    Find the property gateway of the entity for the column.
    
    パラメータ:
    
    propertyName - The property name of the column as case insensitive for performance. (NotNull)
    
    戻り値:
    
    The instance of the property gateway. (NullAllowed: if not found, returns null)
  - findForeignPropertyGateway
```
PropertyGateway findForeignPropertyGateway(String foreignPropertyName)
```
    Find the foreign property gateway of the entity for the relation.
    
    パラメータ:
    
    foreignPropertyName - The property name of the relation as case insensitive for performance. (NotNull)
    
    戻り値:
    
    The instance of the property gateway. (NullAllowed: if not found, returns null)
  - getTableDbName
```
String getTableDbName()
```
    Get the DB name of the table, can be identity of table.
    
    戻り値:
    
    The DB name of the table. (NotNull)
  - getTableDispName
```
String getTableDispName()
```
    Get the display name of the table for human viewing.
    
    戻り値:
    
    The display name of the table. (NotNull)
  - getTablePropertyName
```
String getTablePropertyName()
```
    Get the property name (JavaBeansRule) of table.
    
    戻り値:
    
    The property name(JavaBeansRule) of table. (NotNull)
  - getTableSqlName
```
TableSqlName getTableSqlName()
```
    Get the SQL name of table.
    
    戻り値:
    
    The SQL name of table. (NotNull)
  - getTableAlias
```
String getTableAlias()
```
    Get the alias of the table.
    
    戻り値:
    
    The alias of the table. (NullAllowed: when it cannot get an alias from meta)
  - getTableComment
```
String getTableComment()
```
    Get the comment of the table.
    If the real comment contains the alias, this result does NOT contain it and its delimiter.
    
    戻り値:
    
    The comment of the table. (NullAllowed: when it cannot get a comment from meta)
  - hasColumn
```
boolean hasColumn(String columnFlexibleName)
```
    Does this table have the corresponding column?
    
    パラメータ:
    
    columnFlexibleName - The flexible name of the column. (NotNull)
    
    戻り値:
    
    The determination, true or false.
  - findColumnInfo
```
ColumnInfo findColumnInfo(String columnFlexibleName)
```
    Find the information of the column by the flexible name of the column.
```
 If the table name is 'BOOK_ID', you can find the DB meta by ...(as follows)
     'BOOK_ID', 'BOok_iD', 'book_id'
     , 'BookId', 'bookid', 'bOoKiD'
 
```
    パラメータ:
    
    columnFlexibleName - The flexible name of the column. (NotNull)
    
    戻り値:
    
    The information of the column. (NotNull)
    
    例外:
    
    DBMetaNotFoundException - When the corresponding column is not found.
  - getColumnInfoList
```
List<ColumnInfo> getColumnInfoList()
```
    Get the list of column information.
    
    戻り値:
    
    The list of column information. (NotNull, NotEmpty)
  - getPrimaryInfo
```
PrimaryInfo getPrimaryInfo()
```
    Get primary info that means unique info for primary key.
    
    戻り値:
    
    The primary info of this table's primary key. (NotNull)
    
    例外:
    
    UnsupportedOperationException - When the table does not have primary key.
  - getPrimaryUniqueInfo
```
UniqueInfo getPrimaryUniqueInfo()
```
    非推奨です。 use getPrimaryInfo()
    
    Get primary unique info that means unique info for primary key.
    
    戻り値:
    
    The unique info as primary key. (NotNull)
    
    例外:
    
    UnsupportedOperationException - When the table does not have primary key.
  - hasPrimaryKey
```
boolean hasPrimaryKey()
```
    Does this table have primary-key?
    
    戻り値:
    
    The determination, true or false.
  - hasCompoundPrimaryKey
```
boolean hasCompoundPrimaryKey()
```
    Does this table have compound primary-key?
    If this table does not have primary-key in the first place, this method returns false.
    
    戻り値:
    
    The determination, true or false.
  - searchPrimaryInfo
```
OptionalObject<PrimaryInfo> searchPrimaryInfo(Collection<ColumnInfo> columnInfoList)
```
    Search primary info by the specified columns.
    It returns the found info if the specified columns contain all primary key columns.
    
    パラメータ:
    
    columnInfoList - The list of column info as search key. (NotNull)
    
    戻り値:
    
    The optional object for the found primary info. (NotNull, EmptyAllowed: when not found)
    
    例外:
    
    UnsupportedOperationException - When the table does not have primary key.
  - getUniqueInfoList
```
List<UniqueInfo> getUniqueInfoList()
```
    Get the read-only list of unique info as natural unique (not contain primary key's unique).
    
    戻り値:
    
    The read-only list of unique info. (NotNull)
  - searchUniqueInfoList
```
List<UniqueInfo> searchUniqueInfoList(Collection<ColumnInfo> columnInfoList)
```
    Search unique info by the specified columns.
    It returns the found info if the specified columns contain all unique key columns.
    
    パラメータ:
    
    columnInfoList - The list of column info as search key. (NotNull)
    
    戻り値:
    
    The read-only list of the found unique info. (NotNull, EmptyAllowed: when not found)
  - findRelationInfo
```
RelationInfo findRelationInfo(String relationPropertyName)
```
    Find the information of relation.
    
    パラメータ:
    
    relationPropertyName - The flexible name of the relation property. (NotNull)
    
    戻り値:
    
    The information object of relation. (NotNull)
    
    例外:
    
    DBMetaNotFoundException - When the corresponding relation info is not found.
  - hasForeign
```
boolean hasForeign(String foreignPropertyName)
```
    Does this table have the corresponding foreign relation?
    
    パラメータ:
    
    foreignPropertyName - The flexible name of the foreign property. (NotNull)
    
    戻り値:
    
    The determination, true or false. (NotNull)
  - findForeignDBMeta
```
DBMeta findForeignDBMeta(String foreignPropertyName)
```
    Find the DB meta of foreign relation.
    
    パラメータ:
    
    foreignPropertyName - The flexible name of the foreign property. (NotNull)
    
    戻り値:
    
    The DB meta of foreign relation. (NotNull)
    
    例外:
    
    DBMetaNotFoundException - When the corresponding foreign info is not found.
  - findForeignInfo
```
ForeignInfo findForeignInfo(String foreignPropertyName)
```
    Find the information of foreign relation by property name.
    
    パラメータ:
    
    foreignPropertyName - The flexible name of the foreign property. (NotNull)
    
    戻り値:
    
    The information object of foreign relation. (NotNull)
    
    例外:
    
    DBMetaNotFoundException - When the corresponding foreign info is not found.
  - findForeignInfo
```
ForeignInfo findForeignInfo(int relationNo)
```
    Find the information of foreign relation by relation number.
    
    パラメータ:
    
    relationNo - The relation number of the foreign property. (NotNull)
    
    戻り値:
    
    The information object of foreign relation. (NotNull)
    
    例外:
    
    DBMetaNotFoundException - When the corresponding foreign info is not found.
  - getForeignInfoList
```
List<ForeignInfo> getForeignInfoList()
```
    Get the read-only list of foreign info.
    
    戻り値:
    
    The read-only list of foreign info. (NotNull)
  - searchForeignInfoList
```
List<ForeignInfo> searchForeignInfoList(Collection<ColumnInfo> columnInfoList)
```
    Search foreign info by the specified columns.
    It returns the found info if the specified columns contain all foreign key columns.
    
    パラメータ:
    
    columnInfoList - The list of column info as search key. (NotNull)
    
    戻り値:
    
    The read-only list of the found foreign info. (NotNull, EmptyAllowed: when not found)
  - hasReferrer
```
boolean hasReferrer(String referrerPropertyName)
```
    Does this table have the corresponding referrer relation?
    
    パラメータ:
    
    referrerPropertyName - The flexible name of the referrer property. (NotNull)
    
    戻り値:
    
    The determination, true or false. (NotNull)
  - findReferrerDBMeta
```
DBMeta findReferrerDBMeta(String referrerPropertyName)
```
    Find the DB meta of referrer relation.
    
    パラメータ:
    
    referrerPropertyName - The flexible name of the referrer property. (NotNull)
    
    戻り値:
    
    The DB meta of referrer relation. (NotNull)
  - findReferrerInfo
```
ReferrerInfo findReferrerInfo(String referrerPropertyName)
```
    Find the information of referrer relation.
    
    パラメータ:
    
    referrerPropertyName - The flexible name of the referrer property. (NotNull)
    
    戻り値:
    
    The information object of referrer relation. (NotNull)
    
    例外:
    
    DBMetaNotFoundException - When the corresponding referrer info is not found.
  - getReferrerInfoList
```
List<ReferrerInfo> getReferrerInfoList()
```
    Get the read-only list of referrer info.
    
    戻り値:
    
    The read-only list of referrer info. (NotNull)
  - searchReferrerInfoList
```
List<ReferrerInfo> searchReferrerInfoList(Collection<ColumnInfo> columnInfoList)
```
    Search referrer info by the specified columns.
    It returns the found info if the specified columns contain all referrer columns.
    
    パラメータ:
    
    columnInfoList - The list of column info as search key. (NotNull)
    
    戻り値:
    
    The read-only list of the found referrer info. (NotNull, EmptyAllowed: when not found)
  - hasIdentity
```
boolean hasIdentity()
```
    Does this table have identity?
    
    戻り値:
    
    The determination, true or false.
  - hasSequence
```
boolean hasSequence()
```
    Does this table have sequence?
    
    戻り値:
    
    The determination, true or false.
  - getSequenceName
```
String getSequenceName()
```
    Get the sequence name.
    
    戻り値:
    
    The sequence name. (NullAllowed: if no sequence, returns null.)
  - getSequenceNextValSql
```
String getSequenceNextValSql()
```
    Get the SQL for next value of sequence.
    
    戻り値:
    
    The SQL for next value of sequence. (NullAllowed: if no sequence, returns null.)
  - getSequenceIncrementSize
```
Integer getSequenceIncrementSize()
```
    Get the increment size of sequence.
    
    戻り値:
    
    The increment size of sequence. (NullAllowed: if unknown, returns null.)
  - getSequenceCacheSize
```
Integer getSequenceCacheSize()
```
    Get the cache size of sequence. (The cache means sequence cache on DBFlute)
    
    戻り値:
    
    The cache size of sequence. (NullAllowed: if no cache, returns null.)
  - hasOptimisticLock
```
boolean hasOptimisticLock()
```
    Does the table have optimistic lock? (basically has version no or update date?)
    
    戻り値:
    
    The determination, true or false.
  - hasVersionNo
```
boolean hasVersionNo()
```
    Does the table have a column for version no?
    
    戻り値:
    
    The determination, true or false.
  - getVersionNoColumnInfo
```
ColumnInfo getVersionNoColumnInfo()
```
    Get the column information of version no.
    
    戻り値:
    
    The column information of version no. (NullAllowed: if no column, return null)
  - hasUpdateDate
```
boolean hasUpdateDate()
```
    Does the table have a column for update date?
    
    戻り値:
    
    The determination, true or false.
  - getUpdateDateColumnInfo
```
ColumnInfo getUpdateDateColumnInfo()
```
    Get the column information of update date.
    
    戻り値:
    
    The column information of update date. (NullAllowed: if no column, return null)
  - hasCommonColumn
```
boolean hasCommonColumn()
```
    Does the table have common columns?
    
    戻り値:
    
    The determination, true or false.
  - getCommonColumnInfoList
```
List<ColumnInfo> getCommonColumnInfoList()
```
    Get the list of common column.
    
    戻り値:
    
    The list of column info. (NotNull)
  - getCommonColumnInfoBeforeInsertList
```
List<ColumnInfo> getCommonColumnInfoBeforeInsertList()
```
    Get the list of common column auto-setup before insert.
    
    戻り値:
    
    The list of column info. (NotNull)
  - getCommonColumnInfoBeforeUpdateList
```
List<ColumnInfo> getCommonColumnInfoBeforeUpdateList()
```
    Get the list of common column auto-setup before update.
    
    戻り値:
    
    The list of column info. (NotNull)
  - hasFlexibleName
```
boolean hasFlexibleName(String flexibleName)
```
    Does the table have an object for the flexible name? {Target objects are TABLE and COLUMN}
    
    パラメータ:
    
    flexibleName - The flexible name of the object. (NotNull)
    
    戻り値:
    
    The determination, true or false.
  - findDbName
```
String findDbName(String flexibleName)
```
    Find DB name by flexible name. {Target objects are TABLE and COLUMN}
    
    パラメータ:
    
    flexibleName - The flexible name of the object. (NotNull)
    
    戻り値:
    
    The DB name of anything. (NotNull)
    
    例外:
    
    DBMetaNotFoundException - When the corresponding name was not found.
  - findPropertyName
```
String findPropertyName(String flexibleName)
```
    Find property name(JavaBeansRule) by flexible name. {Target objects are TABLE and COLUMN}
    
    パラメータ:
    
    flexibleName - The flexible name of the property. (NotNull)
    
    戻り値:
    
    The DB name of anything. (NotNull)
    
    例外:
    
    DBMetaNotFoundException - When the corresponding name was not found.
  - getEntityTypeName
```
String getEntityTypeName()
```
    Get the type name of entity.
    
    戻り値:
    
    The type name of entity. (NotNull)
  - getConditionBeanTypeName
```
String getConditionBeanTypeName()
```
    Get the type name of condition-bean.
    
    戻り値:
    
    The type name of condition-bean. (NullAllowed: if the condition-bean does not exist)
  - getBehaviorTypeName
```
String getBehaviorTypeName()
```
    Get the type name of behavior.
    
    戻り値:
    
    The type name of behavior. (NullAllowed: if the behavior does not exist)
  - getEntityType
```
Class<? extends Entity> getEntityType()
```
    Get the type of entity.
    
    戻り値:
    
    The type of entity. (NotNull)
  - newEntity
```
Entity newEntity()
```
    New the instance of entity.
    
    戻り値:
    
    The instance of entity. (NotNull)
  - acceptPrimaryKeyMap
```
void acceptPrimaryKeyMap(Entity entity,
                         Map<String,? extends Object> primaryKeyMap)
```
    Accept the map of primary-keys. map:{[column-name] = [value]}
    
    パラメータ:
    
    entity - The instance of entity to accept the map data. (NotNull)
    
    primaryKeyMap - The value map of primary-keys. (NotNull, NotEmpty)
  - acceptAllColumnMap
```
void acceptAllColumnMap(Entity entity,
                        Map<String,? extends Object> allColumnMap)
```
    Accept the map of all columns. map:{[column-name] = [value]}
    Derived columns are not accepted, physical columns only.
    
    パラメータ:
    
    entity - The instance of entity to accept the map data. (NotNull)
    
    allColumnMap - The value map of all columns. (NotNull, NotEmpty)
  - extractPrimaryKeyMap
```
Map<String,Object> extractPrimaryKeyMap(Entity entity)
```
    Extract the map of primary-keys. map:{[column-name] = [value]}
    
    パラメータ:
    
    entity - The instance of entity to extract the data. (NotNull)
    
    戻り値:
    
    The value map of primary-keys. (NotNull)
  - extractAllColumnMap
```
Map<String,Object> extractAllColumnMap(Entity entity)
```
    Extract The map of all columns. map:{[column-name] = [value]}
    Derived columns are not extracted, physical columns only.
    
    パラメータ:
    
    entity - The instance of entity to extract the data. (NotNull)
    
    戻り値:
    
    The map of all columns. (NotNull)

インタフェース DBMeta

ネストされたクラスのサマリー

メソッドのサマリー

メソッドの詳細

getProjectName

getProjectPrefix

getGenerationGapBasePrefix

getCurrentDBDef

findPropertyGateway

findForeignPropertyGateway

getTableDbName

getTableDispName

getTablePropertyName

getTableSqlName

getTableAlias

getTableComment

hasColumn

findColumnInfo

getColumnInfoList

getPrimaryInfo

getPrimaryUniqueInfo

hasPrimaryKey

hasCompoundPrimaryKey

searchPrimaryInfo

getUniqueInfoList

searchUniqueInfoList

findRelationInfo

hasForeign

findForeignDBMeta

findForeignInfo

findForeignInfo

getForeignInfoList

searchForeignInfoList

hasReferrer

findReferrerDBMeta

findReferrerInfo

getReferrerInfoList

searchReferrerInfoList

hasIdentity

hasSequence

getSequenceName

getSequenceNextValSql

getSequenceIncrementSize

getSequenceCacheSize

hasOptimisticLock

hasVersionNo

getVersionNoColumnInfo

hasUpdateDate

getUpdateDateColumnInfo

hasCommonColumn

getCommonColumnInfoList

getCommonColumnInfoBeforeInsertList

getCommonColumnInfoBeforeUpdateList

hasFlexibleName

findDbName

findPropertyName

getEntityTypeName

getConditionBeanTypeName

getBehaviorTypeName

getEntityType

newEntity

acceptPrimaryKeyMap

acceptAllColumnMap

extractPrimaryKeyMap

extractAllColumnMap