org.dbflute.dbmeta.accessory

クラス EntityDerivedMap

java.lang.Object

org.dbflute.dbmeta.accessory.EntityDerivedMap

すべての実装されたインタフェース:

Serializable

public class EntityDerivedMap
extends Object
implements Serializable

The derived map of entity. (basically for Framework)

導入されたバージョン:

1.1.0 (2014/10/29 Monday)

作成者:

jflute

関連項目:

直列化された形式

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected Map<String,Object>	_derivedMap The map of derived value. map:{alias-name = value} (NullAllowed: lazy-loaded)

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

コンストラクタ

コンストラクタと説明
EntityDerivedMap()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	buildExceptionExistingDerivedMapInfo(ExceptionMessageBuilder br, Map<String,Object> derivedMap)
protected void	buildExceptionTableInfo(ExceptionMessageBuilder br, Entity entity)
void	clear() Clear the derived map.
<VALUE> OptionalScalar<VALUE>	findDerivedValue(Entity entity, String aliasName, Class<VALUE> propertyType) Find the derived value in the map.
protected Map<String,Object>	getDerivedMap()
boolean	isEmpty() Is the derived map empty?
void	registerDerivedValue(String aliasName, Object selectedValue) Register the derived value to the map.
void	remove(String aliasName) Remove the derived value from the map.
protected void	throwDerivedPropertyValueNotFoundException(String tableDbName, String aliasName)
protected void	throwInvalidDerivedAliasNameException(Entity entity, String aliasName)
protected void	throwUnknownDerivedAliasNameException(Entity entity, String aliasName, Map<String,Object> derivedMap)
protected void	throwUnmatchDerivedPropertyTypeException(Entity entity, String aliasName, Class<?> propertyType, ClassCastException cause)
String	toString()

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

_derivedMap

protected Map<String,Object> _derivedMap

The map of derived value. map:{alias-name = value} (NullAllowed: lazy-loaded)

コンストラクタの詳細

EntityDerivedMap

public EntityDerivedMap()

メソッドの詳細

registerDerivedValue

public void registerDerivedValue(String aliasName,
                                 Object selectedValue)

Register the derived value to the map.

パラメータ:

aliasName - The alias name of derived-referrer. (NotNull)

selectedValue - The derived value selected from database. (NullAllowed: when null selected)

findDerivedValue

public <VALUE> OptionalScalar<VALUE> findDerivedValue(Entity entity,
                                                      String aliasName,
                                                      Class<VALUE> propertyType)

Find the derived value in the map.

型パラメータ:

VALUE - The type of derived value.

パラメータ:

entity - The entity that has the derived value, basically for logging. (NotNull)

aliasName - The alias name of derived-referrer. (NotNull)

propertyType - The type of the derived property, should match as rule. (NotNull)

戻り値:

The optional scalar for derived value found in the map. (NotNull, EmptyAllowed: when null selected)

例外:

SpecifyDerivedReferrerInvalidAliasNameException - When the alias name does not start with '$'.

SpecifyDerivedReferrerUnknownAliasNameException - When the alias name is unknown, no derived.

SpecifyDerivedReferrerUnmatchedPropertyTypeException - When the property type is unmatched with actual type.

isEmpty

public boolean isEmpty()

Is the derived map empty?

戻り値:

The determination, true or false.

clear

public void clear()

Clear the derived map.

remove

public void remove(String aliasName)

Remove the derived value from the map.

パラメータ:

aliasName - The alias name of derived-referrer. (NotNull)

getDerivedMap

protected Map<String,Object> getDerivedMap()

throwInvalidDerivedAliasNameException

protected void throwInvalidDerivedAliasNameException(Entity entity,
                                                     String aliasName)

throwUnknownDerivedAliasNameException

protected void throwUnknownDerivedAliasNameException(Entity entity,
                                                     String aliasName,
                                                     Map<String,Object> derivedMap)

throwUnmatchDerivedPropertyTypeException

protected void throwUnmatchDerivedPropertyTypeException(Entity entity,
                                                        String aliasName,
                                                        Class<?> propertyType,
                                                        ClassCastException cause)

buildExceptionTableInfo

protected void buildExceptionTableInfo(ExceptionMessageBuilder br,
                                       Entity entity)

buildExceptionExistingDerivedMapInfo

protected void buildExceptionExistingDerivedMapInfo(ExceptionMessageBuilder br,
                                                    Map<String,Object> derivedMap)

throwDerivedPropertyValueNotFoundException

protected void throwDerivedPropertyValueNotFoundException(String tableDbName,
                                                          String aliasName)

toString

public String toString()

オーバーライド:

toString クラス内 Object