AbstractEntity (DBFlute Runtime 1.1.0-sp2-RC1 API)

java.lang.Object
- org.dbflute.dbmeta.AbstractEntity

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

Serializable, Cloneable, DerivedMappable, Entity
```
public abstract class AbstractEntity
extends Object
implements Entity, DerivedMappable, Serializable, Cloneable
```
The abstract class of entity.

導入されたバージョン:

1.1.0 (2014/10/19 Sunday)

作成者:

jflute

関連項目:

直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected boolean`	`__createdBySelect` Is the entity created by DBFlute select process?
`protected EntityDerivedMap`	`__derivedMap` The map of derived value, key is alias name.
`protected EntityModifiedProperties`	`__modifiedProperties` The modified properties for this entity.
`protected EntityModifiedProperties`	`__specifiedProperties` The modified properties for this entity.
`protected EntityUniqueDrivenProperties`	`__uniqueDrivenProperties` The unique-driven properties for this entity.
`protected boolean`	`_undefinedClassificationSelectAllowed` Does it allow selecting undefined classification code?

インタフェースから継承されたフィールド org.dbflute.dbmeta.accessory.DerivedMappable
MAPPING_ALIAS_PREFIX

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

コンストラクタ
コンストラクタと説明

AbstractEntity()

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

メソッドのサマリー

All Methods Instance Methods Abstract Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`String`	`buildDisplayString(String name, boolean column, boolean relation)` Build display string flexibly.
`protected void`	`checkClassificationCode(String columnDbName, ClassificationMeta meta, Object value)`
`protected void`	`checkSpecifiedProperty(String propertyName)`
`void`	`clearModifiedInfo()` Clear the information of modified properties.
`void`	`clearSpecifiedInfo()` Clear the information of specified properties.
`void`	`clearUniqueDrivenInfo()` Clear the information of unique-driven properties.
`Entity`	`clone()` Clone entity instance using super.clone().
`protected String`	`convertEmptyToNull(String value)`
`boolean`	`createdBySelect()` Is the entity created by DBFlute select process?
`<VALUE> OptionalScalar<VALUE>`	`derived(String aliasName, Class<VALUE> propertyType)` Find the derived value from derived map by alias name (starts with '$').
`protected abstract String`	`doBuildColumnString(String dm)`
`protected abstract String`	`doBuildRelationString(String dm)`
`protected abstract String`	`doBuildStringWithRelation(String li)`
`protected abstract boolean`	`doEquals(Object obj)`
`protected abstract int`	`doHashCode(int initial)`
`boolean`	`equals(Object obj)` Determine the object is equal with this.
`int`	`hashCode()` Calculate the hash-code from primary-keys or columns.
`boolean`	`hasModification()` Does it have modifications of property names.
`int`	`instanceHash()` Calculate the hash-code, which is a default hash code, to identify the instance.
`void`	`markAsSelect()` Mark as select that means the entity is created by DBFlute select process.
`void`	`modifiedToSpecified()` Copy to modified properties to specified properties.
`protected String`	`mycutLargeStringForToString(String filteredStr)`
`protected int`	`mylargeStringForToStringLimit()`
`Set<String>`	`mymodifiedProperties()` Get the set of modified properties.
`void`	`mymodifyProperty(String propertyName)` Modify the property without setting value.
`void`	`mymodifyPropertyCancel(String propertyName)` Cancel the modified the property without resetting value.
`protected String`	`myremoveLineSepForToString(String filteredStr)`
`Set<String>`	`myspecifiedProperties()` Get the set of specified properties.
`void`	`myspecifyProperty(String propertyName)` Specify the property without setting value.
`void`	`myspecifyPropertyCancel(String propertyName)` Cancel the specified the property without resetting value.
`protected TimeZone`	`mytimeZone()`
`boolean`	`myundefinedClassificationAccessAllowed()` Does the access to undefined classification allowed?
`void`	`myuniqueByProperty(String propertyName)` Treat the property as unique driven without setting value.
`void`	`myuniqueByPropertyCancel(String propertyName)` Cancel the property as unique driven without resetting value.
`Set<String>`	`myuniqueDrivenProperties()` Get the properties of unique-driven columns as unique-driven.
`void`	`myunlockUndefinedClassificationAccess()` Unlock the access to undefined classification code.
`protected String`	`myutilDatePattern()`
`protected EntityDerivedMap`	`newDerivedMap()`
`protected EntityModifiedProperties`	`newModifiedProperties()`
`protected <ELEMENT> List<ELEMENT>`	`newReferrerList()`
`protected EntityUniqueDrivenProperties`	`newUniqueDrivenProperties()`
`void`	`registerDerivedValue(String aliasName, Object selectedValue)` Register value derived by (Specify)DerivedReferrer.
`protected void`	`registerModifiedProperty(String propertyName)`
`protected void`	`registerSpecifiedProperty(String propertyName)`
`protected Boolean`	`toBoolean(Object obj)`
`protected <NUMBER extends Number> NUMBER`	`toNumber(Object obj, Class<NUMBER> type)`
`String`	`toString()` Convert to display string of entity's data.
`String`	`toStringWithRelation()` Convert the entity to display string with relation information.
`protected String`	`xbRDS(Entity et, String name)`
`protected int`	`xCH(int hs, Object vl)`
`protected String`	`xfBA(byte[] bytes)`
`protected Object`	`xfND(Object obj)`
`protected String`	`xfUD(Date date)`
`protected boolean`	`xSV(Object v1, Object v2)`

クラスから継承されたメソッド java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

インタフェースから継承されたメソッド org.dbflute.Entity
asDBMeta, asTableDbName, hasPrimaryKeyValue

- フィールドの詳細
  - __uniqueDrivenProperties
```
protected final EntityUniqueDrivenProperties __uniqueDrivenProperties
```
    The unique-driven properties for this entity. (NotNull)
  - __modifiedProperties
```
protected final EntityModifiedProperties __modifiedProperties
```
    The modified properties for this entity. (NotNull)
  - __specifiedProperties
```
protected EntityModifiedProperties __specifiedProperties
```
    The modified properties for this entity. (NullAllowed: normally null, created when specified-check)
  - __derivedMap
```
protected EntityDerivedMap __derivedMap
```
    The map of derived value, key is alias name. (NullAllowed: lazy-loaded)
  - _undefinedClassificationSelectAllowed
```
protected boolean _undefinedClassificationSelectAllowed
```
    Does it allow selecting undefined classification code? {Internal}
  - __createdBySelect
```
protected boolean __createdBySelect
```
    Is the entity created by DBFlute select process?
- コンストラクタの詳細
  - AbstractEntity
```
public AbstractEntity()
```
- メソッドの詳細
  - registerDerivedValue
```
public void registerDerivedValue(String aliasName,
                                 Object selectedValue)
```
    Register value derived by (Specify)DerivedReferrer.
    
    定義:
    
    registerDerivedValue インタフェース内 DerivedMappable
    
    パラメータ:
    
    aliasName - The alias name of derived-referrer. (NotNull)
    
    selectedValue - The selected value from database. (NullAllowed)
  - derived
```
public <VALUE> OptionalScalar<VALUE> derived(String aliasName,
                                             Class<VALUE> propertyType)
```
    Find the derived value from derived map by alias name (starts with '$').
    It needs to downcast process for getting the value so don't mistake it.s
```
 mapping type:
  count()      : Integer
  max(), min() : (same as property type of the column)
  sum(), avg() : BigDecimal

 e.g. use count()
  member.derived("$LOGIN_COUNT", Integer.class).alwaysPresent(loginCount -> {
      log(loginCount.getClass()); // is Integer
      ...
  });

 e.g. use max()
  member.derived("$LATEST_PURCHASE_DATETIME", LocalDateTime.class).ifPresent(latestPurchaseDatetime -> {
      log(latestPurchaseDatetime.getClass()); // is LocalDateTime
      ...
  });

 e.g. overview
  String highestAlias = "$HIGHEST_PURCHASE_PRICE";
  memberBhv.selectEntity(cb -> {
      cb.specify().derivedPurchase().max(purchaseCB -> {
          purchaseCB.specify().columnPurchasePrice();
          purchaseCB.query()...
      }, highestAlias);
      cb.query().setMemberId_Equal(1);
      ...
  }).alwaysPresent(member -> {
      ... = member.getMemberName();
      member.derived(highestAlias, Integer.class).ifPresent(highestPurchasePrice -> {
          log(highestPurchasePrice);
          ...
      });
  });
 
```
    定義:
    
    derived インタフェース内 DerivedMappable
    
    型パラメータ:
    
    VALUE - The type of the value.
    
    パラメータ:
    
    aliasName - The alias name of derived-referrer, should start with '$'. (NotNull)
    
    propertyType - The type of the derived property, should match as rule. (NotNull)
    
    戻り値:
    
    The optional property for derived value found in the map. (NotNull, EmptyAllowed: when null selected)
  - newDerivedMap
```
protected EntityDerivedMap newDerivedMap()
```
  - mymodifiedProperties
```
public Set<String> mymodifiedProperties()
```
    Get the set of modified properties. (basically for Framework)
    The properties needs to be according to Java Beans rule.
    
    定義:
    
    mymodifiedProperties インタフェース内 Entity
    
    戻り値:
    
    The set of property name for modified columns, read-only. (NotNull)
  - mymodifyProperty
```
public void mymodifyProperty(String propertyName)
```
    Modify the property without setting value. (basically for Framework)
    The property name needs to be according to Java Beans rule.
    
    定義:
    
    mymodifyProperty インタフェース内 Entity
    
    パラメータ:
    
    propertyName - The property name of modified column. (NotNull)
  - mymodifyPropertyCancel
```
public void mymodifyPropertyCancel(String propertyName)
```
    Cancel the modified the property without resetting value. (basically for Framework)
    The property name needs to be according to Java Beans rule.
    
    定義:
    
    mymodifyPropertyCancel インタフェース内 Entity
    
    パラメータ:
    
    propertyName - The property name of specified column. (NotNull)
  - clearModifiedInfo
```
public void clearModifiedInfo()
```
    Clear the information of modified properties. (basically for Framework)
    
    定義:
    
    clearModifiedInfo インタフェース内 Entity
  - hasModification
```
public boolean hasModification()
```
    Does it have modifications of property names. (basically for Framework)
    
    定義:
    
    hasModification インタフェース内 Entity
    
    戻り値:
    
    The determination, true or false.
  - newModifiedProperties
```
protected EntityModifiedProperties newModifiedProperties()
```
  - registerModifiedProperty
```
protected void registerModifiedProperty(String propertyName)
```
  - modifiedToSpecified
```
public void modifiedToSpecified()
```
    Copy to modified properties to specified properties.
    It means non-specified columns are checked
    
    定義:
    
    modifiedToSpecified インタフェース内 Entity
  - myspecifiedProperties
```
public Set<String> myspecifiedProperties()
```
    Get the set of specified properties. (basically for Framework)
    The properties needs to be according to Java Beans rule.
    
    定義:
    
    myspecifiedProperties インタフェース内 Entity
    
    戻り値:
    
    The set of property name for specified columns, read-only. (NotNull: if empty, no check)
  - myspecifyProperty
```
public void myspecifyProperty(String propertyName)
```
    Specify the property without setting value. (basically for Framework)
    The property name needs to be according to Java Beans rule.
    
    定義:
    
    myspecifyProperty インタフェース内 Entity
    
    パラメータ:
    
    propertyName - The property name of specified column. (NotNull)
  - myspecifyPropertyCancel
```
public void myspecifyPropertyCancel(String propertyName)
```
    Cancel the specified the property without resetting value. (basically for Framework)
    The property name needs to be according to Java Beans rule.
    
    定義:
    
    myspecifyPropertyCancel インタフェース内 Entity
    
    パラメータ:
    
    propertyName - The property name of specified column. (NotNull)
  - clearSpecifiedInfo
```
public void clearSpecifiedInfo()
```
    Clear the information of specified properties. (basically for Framework)
    It means no check of access to non-specified columns.
    
    定義:
    
    clearSpecifiedInfo インタフェース内 Entity
  - checkSpecifiedProperty
```
protected void checkSpecifiedProperty(String propertyName)
```
  - registerSpecifiedProperty
```
protected void registerSpecifiedProperty(String propertyName)
```
  - myuniqueDrivenProperties
```
public Set<String> myuniqueDrivenProperties()
```
    Get the properties of unique-driven columns as unique-driven.
    
    定義:
    
    myuniqueDrivenProperties インタフェース内 Entity
    
    戻り値:
    
    The set of property name for unique-driven columns, read-only. (NotNull)
  - newUniqueDrivenProperties
```
protected EntityUniqueDrivenProperties newUniqueDrivenProperties()
```
  - myuniqueByProperty
```
public void myuniqueByProperty(String propertyName)
```
    Treat the property as unique driven without setting value. (basically for Framework)
    The property name needs to be according to Java Beans rule.
    
    定義:
    
    myuniqueByProperty インタフェース内 Entity
    
    パラメータ:
    
    propertyName - The property name of unique-driven column. (NotNull)
  - myuniqueByPropertyCancel
```
public void myuniqueByPropertyCancel(String propertyName)
```
    Cancel the property as unique driven without resetting value. (basically for Framework)
    The property name needs to be according to Java Beans rule.
    
    定義:
    
    myuniqueByPropertyCancel インタフェース内 Entity
    
    パラメータ:
    
    propertyName - The property name of unique-driven column. (NotNull)
  - clearUniqueDrivenInfo
```
public void clearUniqueDrivenInfo()
```
    Clear the information of unique-driven properties. (basically for Framework)
    
    定義:
    
    clearUniqueDrivenInfo インタフェース内 Entity
  - toNumber
```
protected <NUMBER extends Number> NUMBER toNumber(Object obj,
                                                  Class<NUMBER> type)
```
  - toBoolean
```
protected Boolean toBoolean(Object obj)
```
  - checkClassificationCode
```
protected void checkClassificationCode(String columnDbName,
                                       ClassificationMeta meta,
                                       Object value)
```
  - myunlockUndefinedClassificationAccess
```
public void myunlockUndefinedClassificationAccess()
```
    Unlock the access to undefined classification code. (default is locked) You can select undefined classification code from database. (and can update...)
    
    定義:
    
    myunlockUndefinedClassificationAccess インタフェース内 Entity
  - myundefinedClassificationAccessAllowed
```
public boolean myundefinedClassificationAccessAllowed()
```
    Does the access to undefined classification allowed?
    
    定義:
    
    myundefinedClassificationAccessAllowed インタフェース内 Entity
    
    戻り値:
    
    The determination, true or false. (basically false)
  - markAsSelect
```
public void markAsSelect()
```
    Mark as select that means the entity is created by DBFlute select process. (basically for Framework)
    e.g. determine columns of batch insert
    
    定義:
    
    markAsSelect インタフェース内 Entity
  - createdBySelect
```
public boolean createdBySelect()
```
    Is the entity created by DBFlute select process? (basically for Framework)
    
    定義:
    
    createdBySelect インタフェース内 Entity
    
    戻り値:
    
    The determination, true or false.
  - newReferrerList
```
protected <ELEMENT> List<ELEMENT> newReferrerList()
```
  - convertEmptyToNull
```
protected String convertEmptyToNull(String value)
```
  - equals
```
public boolean equals(Object obj)
```
    Determine the object is equal with this.
    If primary-keys or columns of the other are same as this one, returns true.
    
    オーバーライド:
    
    equals クラス内 Object
    
    パラメータ:
    
    obj - The object as other entity. (NullAllowed: if null, returns false fixedly)
    
    戻り値:
    
    Comparing result.
  - doEquals
```
protected abstract boolean doEquals(Object obj)
```
    パラメータ:
    
    obj - The object as other entity. (NotNull)
    
    戻り値:
    
    The determination, true or false.
  - xSV
```
protected boolean xSV(Object v1,
                      Object v2)
```
  - hashCode
```
public int hashCode()
```
    Calculate the hash-code from primary-keys or columns.
    
    オーバーライド:
    
    hashCode クラス内 Object
    
    戻り値:
    
    The hash-code from primary-key or columns.
  - doHashCode
```
protected abstract int doHashCode(int initial)
```
    パラメータ:
    
    initial - The initial value to calculate hash-code.
    
    戻り値:
    
    The calculated hash-code.
  - xCH
```
protected int xCH(int hs,
                  Object vl)
```
  - instanceHash
```
public int instanceHash()
```
    Calculate the hash-code, which is a default hash code, to identify the instance.
    
    定義:
    
    instanceHash インタフェース内 Entity
    
    戻り値:
    
    The hash-code from super.hashCode().
  - toString
```
public String toString()
```
    Convert to display string of entity's data. (no relation data)
    
    オーバーライド:
    
    toString クラス内 Object
    
    戻り値:
    
    The display string of all columns and relation existences. (NotNull)
  - xbRDS
```
protected String xbRDS(Entity et,
                       String name)
```
  - toStringWithRelation
```
public String toStringWithRelation()
```
    Convert the entity to display string with relation information.
    
    定義:
    
    toStringWithRelation インタフェース内 Entity
    
    戻り値:
    
    The display string of basic informations with one-nested relation values. (NotNull)
  - doBuildStringWithRelation
```
protected abstract String doBuildStringWithRelation(String li)
```
  - buildDisplayString
```
public String buildDisplayString(String name,
                                 boolean column,
                                 boolean relation)
```
    Build display string flexibly.
    
    定義:
    
    buildDisplayString インタフェース内 Entity
    
    パラメータ:
    
    name - The name for display. (NullAllowed: If it's null, it does not have a name)
    
    column - Does it contains column values or not?
    
    relation - Does it contains relation existences or not?
    
    戻り値:
    
    The display string for this entity. (NotNull)
  - doBuildColumnString
```
protected abstract String doBuildColumnString(String dm)
```
  - doBuildRelationString
```
protected abstract String doBuildRelationString(String dm)
```
  - xfUD
```
protected String xfUD(Date date)
```
  - myutilDatePattern
```
protected String myutilDatePattern()
```
  - mytimeZone
```
protected TimeZone mytimeZone()
```
  - xfBA
```
protected String xfBA(byte[] bytes)
```
  - xfND
```
protected Object xfND(Object obj)
```
  - mycutLargeStringForToString
```
protected String mycutLargeStringForToString(String filteredStr)
```
  - mylargeStringForToStringLimit
```
protected int mylargeStringForToStringLimit()
```
  - myremoveLineSepForToString
```
protected String myremoveLineSepForToString(String filteredStr)
```
  - clone
```
public Entity clone()
```
    Clone entity instance using super.clone(). (shallow copy)
    
    オーバーライド:
    
    clone クラス内 Object
    
    戻り値:
    
    The cloned instance of this entity. (NotNull)
    
    例外:
    
    IllegalStateException - When it fails to clone the entity.

クラス AbstractEntity

フィールドのサマリー

インタフェースから継承されたフィールド org.dbflute.dbmeta.accessory.DerivedMappable

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

メソッドのサマリー

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

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

フィールドの詳細

__uniqueDrivenProperties

__modifiedProperties

__specifiedProperties

__derivedMap

_undefinedClassificationSelectAllowed

__createdBySelect

コンストラクタの詳細

AbstractEntity

メソッドの詳細

registerDerivedValue

derived

newDerivedMap

mymodifiedProperties

mymodifyProperty

mymodifyPropertyCancel

clearModifiedInfo

hasModification

newModifiedProperties

registerModifiedProperty

modifiedToSpecified

myspecifiedProperties

myspecifyProperty

myspecifyPropertyCancel

clearSpecifiedInfo

checkSpecifiedProperty

registerSpecifiedProperty

myuniqueDrivenProperties

newUniqueDrivenProperties

myuniqueByProperty

myuniqueByPropertyCancel

clearUniqueDrivenInfo

toNumber

toBoolean

checkClassificationCode

myunlockUndefinedClassificationAccess

myundefinedClassificationAccessAllowed

markAsSelect

createdBySelect

newReferrerList

convertEmptyToNull

equals

doEquals

xSV

hashCode

doHashCode

xCH

instanceHash

toString

xbRDS

toStringWithRelation

doBuildStringWithRelation

buildDisplayString

doBuildColumnString

doBuildRelationString

xfUD

myutilDatePattern

mytimeZone

xfBA

xfND

mycutLargeStringForToString

mylargeStringForToStringLimit

myremoveLineSepForToString

clone