InstanceKeyEntity (DBFlute Runtime 1.1.0-sp2-RC1 API)

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

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

Entity
```
public class InstanceKeyEntity
extends Object
implements Entity
```
導入されたバージョン:

0.9.9.4B (2012/04/22 Saturday)

作成者:

jflute

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

protected Entity _actualEntity

フィールド
修飾子とタイプ	フィールドと説明
`protected Entity`	`_actualEntity`

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

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

InstanceKeyEntity(Entity actualEntity)

コンストラクタ
コンストラクタと説明
`InstanceKeyEntity(Entity actualEntity)`

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`DBMeta`	`asDBMeta()` Handle the meta as DBMeta, that has all info of the table.
`String`	`asTableDbName()` Handle the meta as table DB name, that can be identity of table.
`String`	`buildDisplayString(String name, boolean column, boolean relation)` Build display string flexibly.
`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.
`boolean`	`createdBySelect()` Is the entity created by DBFlute select process?
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`boolean`	`hasModification()` Does it have modifications of property names.
`boolean`	`hasPrimaryKeyValue()` Does it have the value of primary keys?
`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.
`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.
`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.
`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.
`String`	`toString()`
`String`	`toStringWithRelation()` Convert the entity to display string with relation information.

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

- フィールドの詳細
  - _actualEntity
```
protected final Entity _actualEntity
```
- コンストラクタの詳細
  - InstanceKeyEntity
```
public InstanceKeyEntity(Entity actualEntity)
```
- メソッドの詳細
  - asDBMeta
```
public DBMeta asDBMeta()
```
    インタフェースからコピーされた説明: Entity
    
    Handle the meta as DBMeta, that has all info of the table.
    
    定義:
    
    asDBMeta インタフェース内 Entity
    
    戻り値:
    
    The (singleton) instance of DB meta for the table. (NotNull)
  - asTableDbName
```
public String asTableDbName()
```
    インタフェースからコピーされた説明: Entity
    
    Handle the meta as table DB name, that can be identity of table.
    
    定義:
    
    asTableDbName インタフェース内 Entity
    
    戻り値:
    
    The (fixed) DB name of the table. (NotNull)
  - mymodifiedProperties
```
public Set<String> mymodifiedProperties()
```
    インタフェースからコピーされた説明: Entity
    
    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)
```
    インタフェースからコピーされた説明: Entity
    
    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)
```
    インタフェースからコピーされた説明: Entity
    
    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()
```
    インタフェースからコピーされた説明: Entity
    
    Clear the information of modified properties. (basically for Framework)
    
    定義:
    
    clearModifiedInfo インタフェース内 Entity
  - hasModification
```
public boolean hasModification()
```
    インタフェースからコピーされた説明: Entity
    
    Does it have modifications of property names. (basically for Framework)
    
    定義:
    
    hasModification インタフェース内 Entity
    
    戻り値:
    
    The determination, true or false.
  - modifiedToSpecified
```
public void modifiedToSpecified()
```
    インタフェースからコピーされた説明: Entity
    
    Copy to modified properties to specified properties.
    It means non-specified columns are checked
    
    定義:
    
    modifiedToSpecified インタフェース内 Entity
  - myspecifiedProperties
```
public Set<String> myspecifiedProperties()
```
    インタフェースからコピーされた説明: Entity
    
    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)
```
    インタフェースからコピーされた説明: Entity
    
    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)
```
    インタフェースからコピーされた説明: Entity
    
    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()
```
    インタフェースからコピーされた説明: Entity
    
    Clear the information of specified properties. (basically for Framework)
    It means no check of access to non-specified columns.
    
    定義:
    
    clearSpecifiedInfo インタフェース内 Entity
  - hasPrimaryKeyValue
```
public boolean hasPrimaryKeyValue()
```
    インタフェースからコピーされた説明: Entity
    
    Does it have the value of primary keys?
    
    定義:
    
    hasPrimaryKeyValue インタフェース内 Entity
    
    戻り値:
    
    The determination, true or false. (if all PK values are not null, returns true)
  - myuniqueDrivenProperties
```
public Set<String> myuniqueDrivenProperties()
```
    インタフェースからコピーされた説明: Entity
    
    Get the properties of unique-driven columns as unique-driven.
    
    定義:
    
    myuniqueDrivenProperties インタフェース内 Entity
    
    戻り値:
    
    The set of property name for unique-driven columns, read-only. (NotNull)
  - myuniqueByProperty
```
public void myuniqueByProperty(String propertyName)
```
    インタフェースからコピーされた説明: Entity
    
    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)
```
    インタフェースからコピーされた説明: Entity
    
    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()
```
    インタフェースからコピーされた説明: Entity
    
    Clear the information of unique-driven properties. (basically for Framework)
    
    定義:
    
    clearUniqueDrivenInfo インタフェース内 Entity
  - myunlockUndefinedClassificationAccess
```
public void myunlockUndefinedClassificationAccess()
```
    インタフェースからコピーされた説明: Entity
    
    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()
```
    インタフェースからコピーされた説明: Entity
    
    Does the access to undefined classification allowed?
    
    定義:
    
    myundefinedClassificationAccessAllowed インタフェース内 Entity
    
    戻り値:
    
    The determination, true or false. (basically false)
  - markAsSelect
```
public void markAsSelect()
```
    インタフェースからコピーされた説明: Entity
    
    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()
```
    インタフェースからコピーされた説明: Entity
    
    Is the entity created by DBFlute select process? (basically for Framework)
    
    定義:
    
    createdBySelect インタフェース内 Entity
    
    戻り値:
    
    The determination, true or false.
  - equals
```
public boolean equals(Object obj)
```
    オーバーライド:
    
    equals クラス内 Object
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    
    hashCode クラス内 Object
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object
  - instanceHash
```
public int instanceHash()
```
    インタフェースからコピーされた説明: Entity
    
    Calculate the hash-code, which is a default hash code, to identify the instance.
    
    定義:
    
    instanceHash インタフェース内 Entity
    
    戻り値:
    
    The hash-code from super.hashCode().
  - toStringWithRelation
```
public String toStringWithRelation()
```
    インタフェースからコピーされた説明: Entity
    
    Convert the entity to display string with relation information.
    
    定義:
    
    toStringWithRelation インタフェース内 Entity
    
    戻り値:
    
    The display string of basic informations with one-nested relation values. (NotNull)
  - buildDisplayString
```
public String buildDisplayString(String name,
                                 boolean column,
                                 boolean relation)
```
    インタフェースからコピーされた説明: Entity
    
    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)

クラス InstanceKeyEntity

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

_actualEntity

コンストラクタの詳細

InstanceKeyEntity

メソッドの詳細

asDBMeta

asTableDbName

mymodifiedProperties

mymodifyProperty

mymodifyPropertyCancel

clearModifiedInfo

hasModification

modifiedToSpecified

myspecifiedProperties

myspecifyProperty

myspecifyPropertyCancel

clearSpecifiedInfo

hasPrimaryKeyValue

myuniqueDrivenProperties

myuniqueByProperty

myuniqueByPropertyCancel

clearUniqueDrivenInfo

myunlockUndefinedClassificationAccess

myundefinedClassificationAccessAllowed

markAsSelect

createdBySelect

equals

hashCode

toString

instanceHash

toStringWithRelation

buildDisplayString