org.dbflute.s2dao.metadata

インタフェース TnRelationPropertyType

すべてのスーパーインタフェース:

TnPropertyMapping, TnPropertyType

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

TnRelationPropertyTypeImpl

public interface TnRelationPropertyType
extends TnPropertyType

The property type for relation.
This interface provides relation meta info.

作成者:

modified by jflute (originated in S2Dao)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
int	getKeySize() Get the size of key, which means how many relation keys exist.
TnBeanMetaData	getMyBeanMetaData() Get the my bean meta data, which is for base point of the relation (local entity).
String	getMyKey(int index) Get the my key, which is local column DB name as relation key, by the key index.
int	getRelationNo() Get the relation No, which indicates number in the base table's relations.
String	getRelationNoSuffixPart() Get the suffix part of relation No for relation path that indicates unique location.
TnPropertyType	getSimpleUniquePropertyType() Get the property type of simple unique key.
List<TnPropertyType>	getUniquePropertyTypeList() Get the list of property type of unique key (basically primary key).
TnBeanMetaData	getYourBeanMetaData() Get the your bean meta data, which is for the relation (foreign entity).
String	getYourKey(int index) Get the your key, which is foreign column DB name as relation key, by the key index.
boolean	hasCompoundUniqueKey() Does it have compound unique key?
boolean	hasSimpleUniqueKey() Does it have simple unique key?
boolean	isYourKey(String columnName) Is the column in foreign columns?

インタフェースから継承されたメソッド org.dbflute.s2dao.metadata.TnPropertyType

getPropertyDesc, isPersistent, isPrimaryKey, setPersistent, setPrimaryKey

インタフェースから継承されたメソッド org.dbflute.s2dao.metadata.TnPropertyMapping

getColumnDbName, getColumnSqlName, getEntityColumnInfo, getPropertyAccessor, getPropertyName, getValueType

メソッドの詳細

getRelationNo

int getRelationNo()

Get the relation No, which indicates number in the base table's relations.

戻り値:

The value of Integer. (NotMinus)

getRelationNoSuffixPart

String getRelationNoSuffixPart()

Get the suffix part of relation No for relation path that indicates unique location.
This suffix is added to selected column label.

戻り値:

The suffix string. e.g. _0 (NotNull)

getKeySize

int getKeySize()

Get the size of key, which means how many relation keys exist.

戻り値:

The value of Integer. (NotMinus, NotZero: no-key, no-relation)

getMyKey

String getMyKey(int index)

Get the my key, which is local column DB name as relation key, by the key index.

パラメータ:

index - The index to find the corresponding relation key.

戻り値:

The found DB name of local column. (NotNull)

getYourKey

String getYourKey(int index)

Get the your key, which is foreign column DB name as relation key, by the key index.

パラメータ:

index - The index to find the corresponding relation key.

戻り値:

The found DB name of foreign column. (NotNull)

isYourKey

boolean isYourKey(String columnName)

Is the column in foreign columns?

パラメータ:

columnName - The DB name of column. (NotNull)

戻り値:

The determination, true or false.

getMyBeanMetaData

TnBeanMetaData getMyBeanMetaData()

Get the my bean meta data, which is for base point of the relation (local entity).

戻り値:

The instance of bean meta data. (NotNull)

getYourBeanMetaData

TnBeanMetaData getYourBeanMetaData()

Get the your bean meta data, which is for the relation (foreign entity).

戻り値:

The instance of bean meta data. (NotNull)

getUniquePropertyTypeList

List<TnPropertyType> getUniquePropertyTypeList()

Get the list of property type of unique key (basically primary key).

戻り値:

The list of property type. (NotNull)

hasSimpleUniqueKey

boolean hasSimpleUniqueKey()

Does it have simple unique key? (not compound?)
Derived method for performance.

戻り値:

The determination, true or false.

hasCompoundUniqueKey

boolean hasCompoundUniqueKey()

Does it have compound unique key?
Derived method for performance.

戻り値:

The determination, true or false.

getSimpleUniquePropertyType

TnPropertyType getSimpleUniquePropertyType()

Get the property type of simple unique key.

戻り値:

The property type of simple unique key. (NullAllowed: when not simple)