Module is.codion.framework.domain

Package is.codion.framework.domain.entity

Interface EntityDefinition.Builder

Enclosing interface:

EntityDefinition

public static sealed interface EntityDefinition.Builder

Builds a EntityDefinition

See Also:

• EntityType.define(AttributeDefinition.Builder[])
• EntityType.define(List)

Method Summary

Modifier and Type	Method	Description
EntityDefinition	build()
EntityDefinition.Builder	cacheToString(boolean cacheToString)	Default true.
EntityDefinition.Builder	caption(String caption)	Sets the caption for this entity type
EntityDefinition.Builder	captionResourceKey(String captionResourceKey)	Specifies the resource bundle key associated with the caption.
EntityDefinition.Builder	comparator(Comparator<Entity> comparator)	Sets the comparator to use when comparing entities of this type
EntityDefinition.Builder	condition(ConditionType conditionType, ConditionString conditionString)	Adds a ConditionString which provides a dynamic query condition string.
EntityDefinition.Builder	description(String description)	Specifies a description for this entity.
EntityDefinition.Builder	descriptionResourceKey(String descriptionResourceKey)	Specifies the resource bundle key associated with the description.
EntityDefinition.Builder	exists(Predicate<Entity> exists)	Sets the predicate to use when checking if an entity of this type exists in the database.
EntityDefinition.Builder	formatter(Attribute<?> attribute)	Sets the formatter, based the value of the given attribute.
EntityDefinition.Builder	formatter(Function<Entity,String> formatter)	Sets the formatter, that is, the function responsible for creating toString() values for this entity type.
EntityDefinition.Builder	optimisticLocking(boolean optimisticLocking)	Use this to disable optimistic locking for this entity type
EntityDefinition.Builder	orderBy(OrderBy orderBy)	Sets the order by clause for this entity type.
EntityDefinition.Builder	readOnly(boolean readOnly)	Specifies whether this entity should be read-only, that it should not be possible to insert, update or delete entities of this type
EntityDefinition.Builder	selectQuery(EntitySelectQuery selectQuery)	Sets the select query to use when selecting entities of this type, use with care.
EntityDefinition.Builder	selectTable(String selectTable)	Sets the name of the table to use when selecting entities of this type, when it differs from the one used to update/insert, such as a view.
EntityDefinition.Builder	smallDataset(boolean smallDataset)	Specifies whether this entity should be regarded as being based on a small dataset, which primarily means that combo box models can be based on this entity.
EntityDefinition.Builder	table(String table)
EntityDefinition.Builder	validator(EntityValidator validator)

Method Details

table

EntityDefinition.Builder table(String table)

Parameters:

table - the table name

Returns:

this EntityDefinition.Builder instance

validator

EntityDefinition.Builder validator(EntityValidator validator)

Parameters:

validator - the validator for this entity type

Returns:

this EntityDefinition.Builder instance

condition

EntityDefinition.Builder condition(ConditionType conditionType,
 ConditionString conditionString)

Adds a ConditionString which provides a dynamic query condition string. The condition string should not include the WHERE keyword and use the ? substitution character where values should be inserted.

Parameters:

conditionType - the condition type

conditionString - the condition string provider

Returns:

this EntityDefinition.Builder instance

caption

EntityDefinition.Builder caption(String caption)

Sets the caption for this entity type

Parameters:

caption - the caption

Returns:

this EntityDefinition.Builder instance

captionResourceKey

EntityDefinition.Builder captionResourceKey(String captionResourceKey)

Specifies the resource bundle key associated with the caption. Defaults to entityType.name()

Parameters:

captionResourceKey - the name of the resource bundle key associated with the caption for this entity

Returns:

this EntityDefinition.Builder instance

See Also:

• EntityType.resourceBundleName()

descriptionResourceKey

EntityDefinition.Builder descriptionResourceKey(String descriptionResourceKey)

Specifies the resource bundle key associated with the description. Defaults to entityType.name() + ".description"

Parameters:

descriptionResourceKey - the name of the resource bundle key associated with the description for this entity

Returns:

this EntityDefinition.Builder instance

See Also:

• EntityType.resourceBundleName()

description

EntityDefinition.Builder description(String description)

Specifies a description for this entity.

Parameters:

description - the description

Returns:

this EntityDefinition.Builder instance

smallDataset

EntityDefinition.Builder smallDataset(boolean smallDataset)

Specifies whether this entity should be regarded as being based on a small dataset, which primarily means that combo box models can be based on this entity.

Parameters:

smallDataset - true if this entity is based on a small dataset

Returns:

this EntityDefinition.Builder instance

readOnly

EntityDefinition.Builder readOnly(boolean readOnly)

Specifies whether this entity should be read-only, that it should not be possible to insert, update or delete entities of this type

Parameters:

readOnly - true if this entity is read-only

Returns:

this EntityDefinition.Builder instance

optimisticLocking

EntityDefinition.Builder optimisticLocking(boolean optimisticLocking)

Use this to disable optimistic locking for this entity type

Parameters:

optimisticLocking - true if optimistic locking should be used during updates, false to disable

Returns:

this EntityDefinition.Builder instance

See Also:

• EntityDefinition.OPTIMISTIC_LOCKING

orderBy

EntityDefinition.Builder orderBy(OrderBy orderBy)

Sets the order by clause for this entity type.

Parameters:

orderBy - the order by clause

Returns:

this EntityDefinition.Builder instance

selectTable

EntityDefinition.Builder selectTable(String selectTable)

Sets the name of the table to use when selecting entities of this type, when it differs from the one used to update/insert, such as a view.

Parameters:

selectTable - the name of the table

Returns:

this EntityDefinition.Builder instance

selectQuery

EntityDefinition.Builder selectQuery(EntitySelectQuery selectQuery)

Sets the select query to use when selecting entities of this type, use with care.

Parameters:

selectQuery - the select query to use for this entity type

Returns:

this EntityDefinition.Builder instance

formatter

EntityDefinition.Builder formatter(Attribute<?> attribute)

Sets the formatter, based the value of the given attribute. Shortcut for:

 formatter(EntityFormatter.builder()
           .value(attribute)
           .build())

Parameters:

attribute - the attribute which value to use when formatting

Returns:

this EntityDefinition.Builder instance

formatter

EntityDefinition.Builder formatter(Function<Entity,String> formatter)

Sets the formatter, that is, the function responsible for creating toString() values for this entity type. Note that if for some reason this formatter returns null, the default formatter is used as fallback, which simply returns the entity type name and primary key value.

Parameters:

formatter - the formatter

Returns:

this EntityDefinition.Builder instance

See Also:

• cacheToString(boolean)

cacheToString

EntityDefinition.Builder cacheToString(boolean cacheToString)

Default true.

Parameters:

cacheToString - true if the result of toString() should be cached

Returns:

this EntityDefinition.Builder instance

comparator

EntityDefinition.Builder comparator(Comparator<Entity> comparator)

Sets the comparator to use when comparing entities of this type

Parameters:

comparator - the comparator

Returns:

this EntityDefinition.Builder instance

exists

EntityDefinition.Builder exists(Predicate<Entity> exists)

Sets the predicate to use when checking if an entity of this type exists in the database. The default predicate returns true if the entity has a non-null original primary key, which is a best-guess about an entity existing in a database.

Parameters:

exists - the entity exists predicate

Returns:

this EntityDefinition.Builder instance

build

EntityDefinition build()

Returns:

a new EntityDefinition instance based on this builder