Module is.codion.framework.domain

Package is.codion.framework.domain.entity

Interface Entities

All Known Implementing Classes:

DefaultEntities

public interface Entities

A repository containing the EntityDefinitions for a given domain. Factory for Entity and Entity.Key instances.

See Also:

• entity(EntityType)
• builder(EntityType)
• primaryKey(EntityType, Object)
• primaryKeys(EntityType, Object[])
• keyBuilder(EntityType)

Field Summary

Fields

Modifier and Type	Field	Description
static final is.codion.common.property.PropertyValue<Boolean>	STRICT_DESERIALIZATION	Specifies whether strict deserialization should be used.
static final is.codion.common.property.PropertyValue<Boolean>	STRICT_FOREIGN_KEYS	Specifies whether it should be possible to define foreign keys referencing entities that have not been defined, this can be disabled in cases where entities have circular references. Value type: Boolean Default value: true

Method Summary

Modifier and Type	Method	Description
Entity.Builder	builder(EntityType entityType)	Creates a new Entity.Builder instance for the given entityType
boolean	contains(EntityType entityType)
EntityDefinition	definition(EntityType entityType)	Returns the EntityDefinition for the given entityType
EntityDefinition	definition(String entityTypeName)	Returns the EntityDefinition for the given entityType name
Collection<EntityDefinition>	definitions()	Returns all EntityDefinitions found in this Entities instance
DomainType	domainType()
Entity	entity(EntityType entityType)	Creates a new empty Entity instance of the given entityType
Entity.Key.Builder	keyBuilder(EntityType entityType)	Creates a new Entity.Key.Builder instance for the given entity type
<T> Entity.Key	primaryKey(EntityType entityType, T value)	Creates a new Entity.Key instance of the given entityType, initialised with the given value
<T> List<Entity.Key>	primaryKeys(EntityType entityType, T... values)	Creates new Entity.Key instances of the given entityType, initialised with the given values

Field Details

STRICT_FOREIGN_KEYS

static final is.codion.common.property.PropertyValue<Boolean> STRICT_FOREIGN_KEYS

Specifies whether it should be possible to define foreign keys referencing entities that have not been defined, this can be disabled in cases where entities have circular references.
Value type: Boolean
Default value: true

STRICT_DESERIALIZATION

static final is.codion.common.property.PropertyValue<Boolean> STRICT_DESERIALIZATION

Specifies whether strict deserialization should be used. This means that when an unknown attribute
is encountered during deserialization, an exception is thrown, instead of silently dropping the associated value.
Value type: Boolean
Default value: true

Method Details

domainType

DomainType domainType()

Returns:

the DomainType this Entities instance is associated with

definition

EntityDefinition definition(EntityType entityType)

Returns the EntityDefinition for the given entityType

Parameters:

entityType - the entityType

Returns:

the entity definition

Throws:

IllegalArgumentException - in case the definition is not found

definition

EntityDefinition definition(String entityTypeName)

Returns the EntityDefinition for the given entityType name

Parameters:

entityTypeName - the name of the entityType

Returns:

the entity definition

Throws:

IllegalArgumentException - in case the definition is not found

contains

boolean contains(EntityType entityType)

Parameters:

entityType - the entityType

Returns:

true if this domain contains a definition for the given type

definitions

Collection<EntityDefinition> definitions()

Returns all EntityDefinitions found in this Entities instance

Returns:

all entity definitions

entity

Entity entity(EntityType entityType)

Creates a new empty Entity instance of the given entityType

Parameters:

entityType - the entityType

Returns:

a new Entity instance

builder

Entity.Builder builder(EntityType entityType)

Creates a new Entity.Builder instance for the given entityType

Parameters:

entityType - the entityType

Returns:

a new Entity.Builder

primaryKey

<T> Entity.Key primaryKey(EntityType entityType,
 T value)

Creates a new Entity.Key instance of the given entityType, initialised with the given value

Type Parameters:

T - the key value type

Parameters:

entityType - the entityType

value - the key value, assumes a single value key

Returns:

a new Entity.Key instance

Throws:

IllegalStateException - in case the given primary key is a composite key

IllegalArgumentException - in case the value is not of the correct type

NullPointerException - in case entityType is null

primaryKeys

<T> List<Entity.Key> primaryKeys(EntityType entityType,
 T... values)

Creates new Entity.Key instances of the given entityType, initialised with the given values

Type Parameters:

T - the key value type

Parameters:

entityType - the entityType

values - the key values, assumes a single value key

Returns:

new Entity.Key instances

Throws:

IllegalStateException - in case the given primary key is a composite key

IllegalArgumentException - in case any of the values is not of the correct type

NullPointerException - in case entityType or values is null

keyBuilder

Entity.Key.Builder keyBuilder(EntityType entityType)

Creates a new Entity.Key.Builder instance for the given entity type

Parameters:

entityType - the entity type

Returns:

a new builder