public interface DBMeta
| 修飾子とタイプ | インタフェースと説明 |
|---|---|
static class |
DBMeta.OptimisticLockType |
| 修飾子とタイプ | メソッドと説明 |
|---|---|
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.
|
String getProjectName()
String getProjectPrefix()
String getGenerationGapBasePrefix()
DBDef getCurrentDBDef()
PropertyGateway findPropertyGateway(String propertyName)
propertyName - The property name of the column as case insensitive for performance. (NotNull)PropertyGateway findForeignPropertyGateway(String foreignPropertyName)
foreignPropertyName - The property name of the relation as case insensitive for performance. (NotNull)String getTableDbName()
String getTableDispName()
String getTablePropertyName()
TableSqlName getTableSqlName()
String getTableAlias()
String getTableComment()
boolean hasColumn(String columnFlexibleName)
columnFlexibleName - The flexible name of the column. (NotNull)ColumnInfo findColumnInfo(String columnFlexibleName)
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)DBMetaNotFoundException - When the corresponding column is not found.List<ColumnInfo> getColumnInfoList()
PrimaryInfo getPrimaryInfo()
UnsupportedOperationException - When the table does not have primary key.UniqueInfo getPrimaryUniqueInfo()
UnsupportedOperationException - When the table does not have primary key.boolean hasPrimaryKey()
boolean hasCompoundPrimaryKey()
OptionalObject<PrimaryInfo> searchPrimaryInfo(Collection<ColumnInfo> columnInfoList)
columnInfoList - The list of column info as search key. (NotNull)UnsupportedOperationException - When the table does not have primary key.List<UniqueInfo> getUniqueInfoList()
List<UniqueInfo> searchUniqueInfoList(Collection<ColumnInfo> columnInfoList)
columnInfoList - The list of column info as search key. (NotNull)RelationInfo findRelationInfo(String relationPropertyName)
relationPropertyName - The flexible name of the relation property. (NotNull)DBMetaNotFoundException - When the corresponding relation info is not found.boolean hasForeign(String foreignPropertyName)
foreignPropertyName - The flexible name of the foreign property. (NotNull)DBMeta findForeignDBMeta(String foreignPropertyName)
foreignPropertyName - The flexible name of the foreign property. (NotNull)DBMetaNotFoundException - When the corresponding foreign info is not found.ForeignInfo findForeignInfo(String foreignPropertyName)
foreignPropertyName - The flexible name of the foreign property. (NotNull)DBMetaNotFoundException - When the corresponding foreign info is not found.ForeignInfo findForeignInfo(int relationNo)
relationNo - The relation number of the foreign property. (NotNull)DBMetaNotFoundException - When the corresponding foreign info is not found.List<ForeignInfo> getForeignInfoList()
List<ForeignInfo> searchForeignInfoList(Collection<ColumnInfo> columnInfoList)
columnInfoList - The list of column info as search key. (NotNull)boolean hasReferrer(String referrerPropertyName)
referrerPropertyName - The flexible name of the referrer property. (NotNull)DBMeta findReferrerDBMeta(String referrerPropertyName)
referrerPropertyName - The flexible name of the referrer property. (NotNull)ReferrerInfo findReferrerInfo(String referrerPropertyName)
referrerPropertyName - The flexible name of the referrer property. (NotNull)DBMetaNotFoundException - When the corresponding referrer info is not found.List<ReferrerInfo> getReferrerInfoList()
List<ReferrerInfo> searchReferrerInfoList(Collection<ColumnInfo> columnInfoList)
columnInfoList - The list of column info as search key. (NotNull)boolean hasIdentity()
boolean hasSequence()
String getSequenceName()
String getSequenceNextValSql()
Integer getSequenceIncrementSize()
Integer getSequenceCacheSize()
boolean hasOptimisticLock()
boolean hasVersionNo()
ColumnInfo getVersionNoColumnInfo()
boolean hasUpdateDate()
ColumnInfo getUpdateDateColumnInfo()
boolean hasCommonColumn()
List<ColumnInfo> getCommonColumnInfoList()
List<ColumnInfo> getCommonColumnInfoBeforeInsertList()
List<ColumnInfo> getCommonColumnInfoBeforeUpdateList()
boolean hasFlexibleName(String flexibleName)
flexibleName - The flexible name of the object. (NotNull)String findDbName(String flexibleName)
flexibleName - The flexible name of the object. (NotNull)DBMetaNotFoundException - When the corresponding name was not found.String findPropertyName(String flexibleName)
flexibleName - The flexible name of the property. (NotNull)DBMetaNotFoundException - When the corresponding name was not found.String getEntityTypeName()
String getConditionBeanTypeName()
String getBehaviorTypeName()
Class<? extends Entity> getEntityType()
Entity newEntity()
void acceptPrimaryKeyMap(Entity entity, Map<String,? extends Object> primaryKeyMap)
entity - The instance of entity to accept the map data. (NotNull)primaryKeyMap - The value map of primary-keys. (NotNull, NotEmpty)void acceptAllColumnMap(Entity entity, Map<String,? extends Object> allColumnMap)
entity - The instance of entity to accept the map data. (NotNull)allColumnMap - The value map of all columns. (NotNull, NotEmpty)Map<String,Object> extractPrimaryKeyMap(Entity entity)
entity - The instance of entity to extract the data. (NotNull)Map<String,Object> extractAllColumnMap(Entity entity)
entity - The instance of entity to extract the data. (NotNull)Copyright © 2014–2015 The DBFlute Project. All rights reserved.