org.dbflute

インタフェース Entity

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

AbstractEntity, InstanceKeyEntity

public interface Entity

The interface of entity.
And it's the landmark class for DBFlute.

作成者:

jflute

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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	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	toStringWithRelation() Convert the entity to display string with relation information.

メソッドの詳細

asDBMeta

DBMeta asDBMeta()

Handle the meta as DBMeta, that has all info of the table.

戻り値:

The (singleton) instance of DB meta for the table. (NotNull)

asTableDbName

String asTableDbName()

Handle the meta as table DB name, that can be identity of table.

戻り値:

The (fixed) DB name of the table. (NotNull)

mymodifiedProperties

Set<String> mymodifiedProperties()

Get the set of modified properties. (basically for Framework)
The properties needs to be according to Java Beans rule.

戻り値:

The set of property name for modified columns, read-only. (NotNull)

mymodifyProperty

void mymodifyProperty(String propertyName)

Modify the property without setting value. (basically for Framework)
The property name needs to be according to Java Beans rule.

パラメータ:

propertyName - The property name of modified column. (NotNull)

mymodifyPropertyCancel

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.

パラメータ:

propertyName - The property name of specified column. (NotNull)

clearModifiedInfo

void clearModifiedInfo()

Clear the information of modified properties. (basically for Framework)

hasModification

boolean hasModification()

Does it have modifications of property names. (basically for Framework)

戻り値:

The determination, true or false.

modifiedToSpecified

void modifiedToSpecified()

Copy to modified properties to specified properties.
It means non-specified columns are checked

myspecifiedProperties

Set<String> myspecifiedProperties()

Get the set of specified properties. (basically for Framework)
The properties needs to be according to Java Beans rule.

戻り値:

The set of property name for specified columns, read-only. (NotNull: if empty, no check)

myspecifyProperty

void myspecifyProperty(String propertyName)

Specify the property without setting value. (basically for Framework)
The property name needs to be according to Java Beans rule.

パラメータ:

propertyName - The property name of specified column. (NotNull)

myspecifyPropertyCancel

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.

パラメータ:

propertyName - The property name of specified column. (NotNull)

clearSpecifiedInfo

void clearSpecifiedInfo()

Clear the information of specified properties. (basically for Framework)
It means no check of access to non-specified columns.

hasPrimaryKeyValue

boolean hasPrimaryKeyValue()

Does it have the value of primary keys?

戻り値:

The determination, true or false. (if all PK values are not null, returns true)

myuniqueDrivenProperties

Set<String> myuniqueDrivenProperties()

Get the properties of unique-driven columns as unique-driven.

戻り値:

The set of property name for unique-driven columns, read-only. (NotNull)

myuniqueByProperty

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.

パラメータ:

propertyName - The property name of unique-driven column. (NotNull)

myuniqueByPropertyCancel

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.

パラメータ:

propertyName - The property name of unique-driven column. (NotNull)

clearUniqueDrivenInfo

void clearUniqueDrivenInfo()

Clear the information of unique-driven properties. (basically for Framework)

myunlockUndefinedClassificationAccess

void myunlockUndefinedClassificationAccess()

Unlock the access to undefined classification code. (default is locked) You can select undefined classification code from database. (and can update...)

myundefinedClassificationAccessAllowed

boolean myundefinedClassificationAccessAllowed()

Does the access to undefined classification allowed?

戻り値:

The determination, true or false. (basically false)

markAsSelect

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

createdBySelect

boolean createdBySelect()

Is the entity created by DBFlute select process? (basically for Framework)

戻り値:

The determination, true or false.

instanceHash

int instanceHash()

Calculate the hash-code, which is a default hash code, to identify the instance.

戻り値:

The hash-code from super.hashCode().

toStringWithRelation

String toStringWithRelation()

Convert the entity to display string with relation information.

戻り値:

The display string of basic informations with one-nested relation values. (NotNull)

buildDisplayString

String buildDisplayString(String name,
                          boolean column,
                          boolean relation)

Build display string flexibly.

パラメータ:

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)