Module is.codion.framework.domain

Package is.codion.framework.domain.entity

Interface Entities

All Known Implementing Classes:

DefaultEntities

public interface Entities

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

Method Summary

Modifier and Type	Method	Description
Entity.Builder	builder(EntityType entityType)	Creates a new Entity.Builder instance.
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 available
DomainType	domainType()
Entity	entity(EntityType entityType)	Creates a new Entity instance with the given entityType
Key.Builder	keyBuilder(EntityType entityType)	Creates a new Key.Builder instance for the given entity type.
<T> Key	primaryKey(EntityType entityType, T value)	Creates a new Key instance with the given entityType, initialised with the given value
<T> List<Key>	primaryKeys(EntityType entityType, T... values)	Creates new Key instances with the given entityType, initialised with the given values

Method Detail

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 available

Returns:

all entity definitions

entity

Entity entity(EntityType entityType)

Creates a new Entity instance with the given entityType

Parameters:

entityType - the entityType

Returns:

a new Entity instance

builder

Entity.Builder builder(EntityType entityType)

Creates a new Entity.Builder instance.

Parameters:

entityType - the entityType

Returns:

a new Entity.Builder

primaryKey

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

Creates a new Key instance with 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 long key

Returns:

a new 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<Key> primaryKeys(EntityType entityType,
                          T... values)

Creates new Key instances with 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 integer key

Returns:

new 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

Key.Builder keyBuilder(EntityType entityType)

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

Parameters:

entityType - the entity type

Returns:

a new builder