org.dbflute.dbmeta.DBMeta Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dbflute-runtime Show documentation
Show all versions of dbflute-runtime Show documentation
The runtime library of DBFlute
/*
* Copyright 2014-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
package org.dbflute.dbmeta;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import org.dbflute.Entity;
import org.dbflute.dbmeta.info.ColumnInfo;
import org.dbflute.dbmeta.info.ForeignInfo;
import org.dbflute.dbmeta.info.PrimaryInfo;
import org.dbflute.dbmeta.info.ReferrerInfo;
import org.dbflute.dbmeta.info.RelationInfo;
import org.dbflute.dbmeta.info.UniqueInfo;
import org.dbflute.dbmeta.name.TableSqlName;
import org.dbflute.dbmeta.property.PropertyGateway;
import org.dbflute.dbway.DBDef;
import org.dbflute.optional.OptionalObject;
/**
* The interface of DB meta for one table.
* @author jflute
*/
public interface DBMeta {
// ===================================================================================
// DBDef
// =====
/**
* Get project name of the database (DBFlute client) for the table.
* @return The name string, lower case in many cases. e.g. maihamadb (NotNull)
*/
String getProjectName();
/**
* Get project prefix of the database for the table, used as class name. (normally empty)
* @return The prefix string, camel case in many cases. e.g. Resola (ResolaStationCB) (NotNull, EmptyAllowed)
*/
String getProjectPrefix();
/**
* Get base prefix of the database for generation gap. (normally 'Bs')
* @return The prefix string, camel case in many cases. e.g. Bs (BsMemberCB) (NotNull, EmptyAllowed)
*/
String getGenerationGapBasePrefix();
/**
* Get the current DB definition.
* @return The current DB definition. (NotNull)
*/
DBDef getCurrentDBDef();
// ===================================================================================
// Property Gateway
// ================
// these fields and methods should be defined before definitions of column info at implementation classes
/**
* Find the property gateway of the entity for the column.
* @param propertyName The property name of the column as case insensitive for performance. (NotNull)
* @return The instance of the property gateway. (NullAllowed: if not found, returns null)
*/
PropertyGateway findPropertyGateway(String propertyName);
/**
* Find the foreign property gateway of the entity for the relation.
* @param foreignPropertyName The property name of the relation as case insensitive for performance. (NotNull)
* @return The instance of the property gateway. (NullAllowed: if not found, returns null)
*/
PropertyGateway findForeignPropertyGateway(String foreignPropertyName);
// ===================================================================================
// Table Info
// ==========
/**
* Get the DB name of the table, can be identity of table.
* @return The DB name of the table. (NotNull)
*/
String getTableDbName();
/**
* Get the display name of the table for human viewing.
* @return The display name of the table. (NotNull)
*/
String getTableDispName();
/**
* Get the property name (JavaBeansRule) of table.
* @return The property name(JavaBeansRule) of table. (NotNull)
*/
String getTablePropertyName();
/**
* Get the SQL name of table.
* @return The SQL name of table. (NotNull)
*/
TableSqlName getTableSqlName();
/**
* Get the alias of the table.
* @return The alias of the table. (NullAllowed: when it cannot get an alias from meta)
*/
String getTableAlias();
/**
* Get the comment of the table.
* If the real comment contains the alias,
* this result does NOT contain it and its delimiter.
* @return The comment of the table. (NullAllowed: when it cannot get a comment from meta)
*/
String getTableComment();
// ===================================================================================
// Column Info
// ===========
/**
* Does this table have the corresponding column?
* @param columnFlexibleName The flexible name of the column. (NotNull)
* @return The determination, true or false.
*/
boolean hasColumn(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'
*
* @param columnFlexibleName The flexible name of the column. (NotNull)
* @return The information of the column. (NotNull)
* @throws org.dbflute.exception.DBMetaNotFoundException When the corresponding column is not found.
*/
ColumnInfo findColumnInfo(String columnFlexibleName);
/**
* Get the list of column information.
* @return The list of column information. (NotNull, NotEmpty)
*/
List getColumnInfoList();
// ===================================================================================
// Unique Info
// ===========
// -----------------------------------------------------
// Primary Key
// -----------
/**
* Get primary info that means unique info for primary key.
* @return The primary info of this table's primary key. (NotNull)
* @throws UnsupportedOperationException When the table does not have primary key.
*/
PrimaryInfo getPrimaryInfo();
/**
* Get primary unique info that means unique info for primary key.
* @return The unique info as primary key. (NotNull)
* @throws UnsupportedOperationException When the table does not have primary key.
* @deprecated use getPrimaryInfo()
*/
UniqueInfo getPrimaryUniqueInfo(); // old style
/**
* Does this table have primary-key?
* @return The determination, true or false.
*/
boolean hasPrimaryKey();
/**
* Does this table have compound primary-key?
* If this table does not have primary-key in the first place,
* this method returns false.
* @return The determination, true or false.
*/
boolean hasCompoundPrimaryKey();
/**
* Search primary info by the specified columns.
* It returns the found info if the specified columns contain all primary key columns.
* @param columnInfoList The list of column info as search key. (NotNull)
* @return The optional object for the found primary info. (NotNull, EmptyAllowed: when not found)
* @throws UnsupportedOperationException When the table does not have primary key.
*/
OptionalObject searchPrimaryInfo(Collection columnInfoList);
// -----------------------------------------------------
// Natural Unique
// --------------
/**
* Get the read-only list of unique info as natural unique (not contain primary key's unique).
* @return The read-only list of unique info. (NotNull)
*/
List getUniqueInfoList();
/**
* Search unique info by the specified columns.
* It returns the found info if the specified columns contain all unique key columns.
* @param columnInfoList The list of column info as search key. (NotNull)
* @return The read-only list of the found unique info. (NotNull, EmptyAllowed: when not found)
*/
List searchUniqueInfoList(Collection columnInfoList);
// ===================================================================================
// Relation Info
// =============
// -----------------------------------------------------
// Relation Element
// ----------------
/**
* Find the information of relation.
* @param relationPropertyName The flexible name of the relation property. (NotNull)
* @return The information object of relation. (NotNull)
* @throws org.dbflute.exception.DBMetaNotFoundException When the corresponding relation info is not found.
*/
RelationInfo findRelationInfo(String relationPropertyName);
// -----------------------------------------------------
// Foreign Element
// ---------------
/**
* Does this table have the corresponding foreign relation?
* @param foreignPropertyName The flexible name of the foreign property. (NotNull)
* @return The determination, true or false. (NotNull)
*/
boolean hasForeign(String foreignPropertyName);
/**
* Find the DB meta of foreign relation.
* @param foreignPropertyName The flexible name of the foreign property. (NotNull)
* @return The DB meta of foreign relation. (NotNull)
* @throws org.dbflute.exception.DBMetaNotFoundException When the corresponding foreign info is not found.
*/
DBMeta findForeignDBMeta(String foreignPropertyName);
/**
* Find the information of foreign relation by property name.
* @param foreignPropertyName The flexible name of the foreign property. (NotNull)
* @return The information object of foreign relation. (NotNull)
* @throws org.dbflute.exception.DBMetaNotFoundException When the corresponding foreign info is not found.
*/
ForeignInfo findForeignInfo(String foreignPropertyName);
/**
* Find the information of foreign relation by relation number.
* @param relationNo The relation number of the foreign property. (NotNull)
* @return The information object of foreign relation. (NotNull)
* @throws org.dbflute.exception.DBMetaNotFoundException When the corresponding foreign info is not found.
*/
ForeignInfo findForeignInfo(int relationNo);
/**
* Get the read-only list of foreign info.
* @return The read-only list of foreign info. (NotNull)
*/
List getForeignInfoList();
/**
* Search foreign info by the specified columns.
* It returns the found info if the specified columns contain all foreign key columns.
* @param columnInfoList The list of column info as search key. (NotNull)
* @return The read-only list of the found foreign info. (NotNull, EmptyAllowed: when not found)
*/
List searchForeignInfoList(Collection columnInfoList);
// -----------------------------------------------------
// Referrer Element
// ----------------
/**
* Does this table have the corresponding referrer relation?
* @param referrerPropertyName The flexible name of the referrer property. (NotNull)
* @return The determination, true or false. (NotNull)
*/
boolean hasReferrer(String referrerPropertyName);
/**
* Find the DB meta of referrer relation.
* @param referrerPropertyName The flexible name of the referrer property. (NotNull)
* @return The DB meta of referrer relation. (NotNull)
*/
DBMeta findReferrerDBMeta(String referrerPropertyName);
/**
* Find the information of referrer relation.
* @param referrerPropertyName The flexible name of the referrer property. (NotNull)
* @return The information object of referrer relation. (NotNull)
* @throws org.dbflute.exception.DBMetaNotFoundException When the corresponding referrer info is not found.
*/
ReferrerInfo findReferrerInfo(String referrerPropertyName);
/**
* Get the read-only list of referrer info.
* @return The read-only list of referrer info. (NotNull)
*/
List getReferrerInfoList();
/**
* Search referrer info by the specified columns.
* It returns the found info if the specified columns contain all referrer columns.
* @param columnInfoList The list of column info as search key. (NotNull)
* @return The read-only list of the found referrer info. (NotNull, EmptyAllowed: when not found)
*/
List searchReferrerInfoList(Collection columnInfoList);
// ===================================================================================
// Identity Info
// =============
/**
* Does this table have identity?
* @return The determination, true or false.
*/
boolean hasIdentity();
// ===================================================================================
// Sequence Info
// =============
/**
* Does this table have sequence?
* @return The determination, true or false.
*/
boolean hasSequence();
/**
* Get the sequence name.
* @return The sequence name. (NullAllowed: if no sequence, returns null.)
*/
String getSequenceName();
/**
* Get the SQL for next value of sequence.
* @return The SQL for next value of sequence. (NullAllowed: if no sequence, returns null.)
*/
String getSequenceNextValSql();
/**
* Get the increment size of sequence.
* @return The increment size of sequence. (NullAllowed: if unknown, returns null.)
*/
Integer getSequenceIncrementSize();
/**
* Get the cache size of sequence. (The cache means sequence cache on DBFlute)
* @return The cache size of sequence. (NullAllowed: if no cache, returns null.)
*/
Integer getSequenceCacheSize();
// ===================================================================================
// OptimisticLock Info
// ===================
/**
* Does the table have optimistic lock? (basically has version no or update date?)
* @return The determination, true or false.
*/
boolean hasOptimisticLock();
/**
* Does the table have a column for version no?
* @return The determination, true or false.
*/
boolean hasVersionNo();
/**
* Get the column information of version no.
* @return The column information of version no. (NullAllowed: if no column, return null)
*/
ColumnInfo getVersionNoColumnInfo();
/**
* Does the table have a column for update date?
* @return The determination, true or false.
*/
boolean hasUpdateDate();
/**
* Get the column information of update date.
* @return The column information of update date. (NullAllowed: if no column, return null)
*/
ColumnInfo getUpdateDateColumnInfo();
// ===================================================================================
// CommonColumn Info
// =================
/**
* Does the table have common columns?
* @return The determination, true or false.
*/
boolean hasCommonColumn();
/**
* Get the list of common column.
* @return The list of column info. (NotNull)
*/
List getCommonColumnInfoList();
/**
* Get the list of common column auto-setup before insert.
* @return The list of column info. (NotNull)
*/
List getCommonColumnInfoBeforeInsertList();
/**
* Get the list of common column auto-setup before update.
* @return The list of column info. (NotNull)
*/
List getCommonColumnInfoBeforeUpdateList();
// ===================================================================================
// Type Name
// =========
/**
* Get the type name of entity.
* @return The type name of entity. (NotNull)
*/
String getEntityTypeName();
/**
* Get the type name of condition-bean.
* @return The type name of condition-bean. (NullAllowed: if the condition-bean does not exist)
*/
String getConditionBeanTypeName();
/**
* Get the type name of behavior.
* @return The type name of behavior. (NullAllowed: if the behavior does not exist)
*/
String getBehaviorTypeName();
// ===================================================================================
// Object Type
// ===========
/**
* Get the type of entity.
* @return The type of entity. (NotNull)
*/
Class getEntityType();
// ===================================================================================
// Object Instance
// ===============
/**
* New the instance of entity.
* @return The instance of entity. (NotNull)
*/
Entity newEntity();
// ===================================================================================
// Map Communication
// =================
// -----------------------------------------------------
// Accept
// ------
/**
* Accept the map of primary-keys. map:{[column-name] = [value]}
* @param entity The instance of entity to accept the map data. (NotNull)
* @param primaryKeyMap The value map of primary-keys. (NotNull, NotEmpty)
*/
void acceptPrimaryKeyMap(Entity entity, Map primaryKeyMap);
/**
* Accept the map of all columns. map:{[column-name] = [value]}
* Derived columns are not accepted, physical columns only.
* @param entity The instance of entity to accept the map data. (NotNull)
* @param allColumnMap The value map of all columns. (NotNull, NotEmpty)
*/
void acceptAllColumnMap(Entity entity, Map allColumnMap);
// -----------------------------------------------------
// Extract
// -------
/**
* Extract the map of primary-keys. map:{[column-name] = [value]}
* @param entity The instance of entity to extract the data. (NotNull)
* @return The value map of primary-keys. (NotNull)
*/
Map extractPrimaryKeyMap(Entity entity);
/**
* Extract The map of all columns. map:{[column-name] = [value]}
* Derived columns are not extracted, physical columns only.
* @param entity The instance of entity to extract the data. (NotNull)
* @return The map of all columns. (NotNull)
*/
Map extractAllColumnMap(Entity entity);
// ===================================================================================
// Optimistic Lock Type
// ====================
public static enum OptimisticLockType {
NONE, VERSION_NO, UPDATE_DATE
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy