org.jminor.framework.domain

Class Domain

java.lang.Object

org.jminor.framework.domain.Domain

All Implemented Interfaces:

java.io.Serializable

public class Domain
extends java.lang.Object
implements java.io.Serializable

A repository specifying the Entity.Definitions for a given domain. Used to instantiate Entity and Entity.Key instances.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Domain.StringProvider Provides String representations of Entity instances. Given a Entity instance named entity containing the following mappings:
static class	Domain.Validator A default Entity.Validator implementation providing null validation for properties marked as not null, range validation for numerical properties with max and/or min values specified and string length validation based on the specified max length.

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyValue<java.lang.Boolean>	ALLOW_REDEFINE_ENTITY Specifies whether or not to allow entities to be re-defined, that is, allow a new definition to replace an old one.
static PropertyValue<java.lang.String>	ENTITY_SERIALIZER_CLASS Specifies the class used for serializing and deserializing entity instances. Value type: String, the name of the class implementing org.jminor.common.Serializer<Entity> Default value: none

Constructor Summary

Constructors

Constructor and Description
Domain() Instantiates a new Domain with the simple name of the class as domain id
Domain(Domain domain) Instantiates a new domain and copies all the entity definitions and database operations from domain
Domain(java.lang.String domainId) Instantiates a new Domain

Method Summary

Modifier and Type	Method and Description
void	addOperation(DatabaseConnection.Operation operation) Adds the given Operation to this domain
Entity.KeyGenerator	automaticKeyGenerator(java.lang.String valueSource) Instantiates a primary key generator which fetches automatically incremented primary key values after insert.
Entity	createToStringEntity(java.lang.String entityId, java.lang.String toStringValue) Creates an empty Entity instance returning the given string on a call to toString(), all other method calls are routed to an empty Entity instance.
Entity	defaultEntity(java.lang.String entityId, ValueProvider<Property,java.lang.Object> valueProvider) Instantiates a new Entity of the given type using the values provided by valueProvider.
Entity.Definition.Builder	define(java.lang.String entityId, Property.Builder... propertyBuilders) Adds a new Entity.Definition to this domain model, using the entityId as table name.
Entity.Definition.Builder	define(java.lang.String entityId, java.lang.String tableName, Property.Builder... propertyBuilders) Adds a new Entity.Definition to this domain model.
Entity	entity(Entity.Key key) Creates a new Entity instance with the given primary key
Entity	entity(java.lang.String entityId) Creates a new Entity instance with the given entityId
Entity	entity(java.lang.String entityId, java.util.Map<Property,java.lang.Object> values, java.util.Map<Property,java.lang.Object> originalValues) Instantiates a new Entity instance using the given maps for the values and original values respectively.
boolean	entitySerializerAvailable()
<V> Entity	fromBean(V bean) Creates a Entity from the given bean object.
java.util.List<Entity>	fromBeans(java.util.List beans) Transforms the given beans into a entities according to the information found in this Domain model
Entity.Definition	getDefinition(java.lang.String entityId)
static Domain	getDomain(java.lang.String domainId)
java.lang.String	getDomainId()
java.util.Collection<Entity.Definition>	getEntityDefinitions()
Serializer<Entity>	getEntitySerializer()
<C> DatabaseConnection.Function<C>	getFunction(java.lang.String functionId)
<C> DatabaseConnection.Procedure<C>	getProcedure(java.lang.String procedureId)
static java.util.Collection<Domain>	getRegisteredDomains()
Entity.KeyGenerator	incrementKeyGenerator(java.lang.String tableName, java.lang.String columnName) Instantiates a primary key generator which fetches the current maximum primary key value and increments it by one prior to insert.
boolean	isDefined(java.lang.String entityId)
Entity.Key	key(java.lang.String entityId) Creates a new Entity.Key instance with the given entityId
static Entity.OrderBy	orderBy()
Entity.KeyGenerator	queriedKeyGenerator(java.lang.String query) Instantiates a primary key generator which fetches primary key values using the given query prior to insert.
Domain	registerDomain() Registers this instance for lookup via getDomain(String), required for serialization of domain objects, entities and related classes.
Entity.KeyGenerator	sequenceKeyGenerator(java.lang.String sequenceName) Instantiates a primary key generator which fetches primary key values from a sequence prior to insert.
<V> V	toBean(Entity entity) Transforms the given entity into a bean according to the information found in this Domain model
java.util.List<java.lang.Object>	toBeans(java.util.List<Entity> entities) Transforms the given entities into beans according to the information found in this Domain model

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALLOW_REDEFINE_ENTITY

public static final PropertyValue<java.lang.Boolean> ALLOW_REDEFINE_ENTITY

Specifies whether or not to allow entities to be re-defined, that is, allow a new definition to replace an old one. Value type: Boolean
Default value: false

ENTITY_SERIALIZER_CLASS

public static final PropertyValue<java.lang.String> ENTITY_SERIALIZER_CLASS

Specifies the class used for serializing and deserializing entity instances.
Value type: String, the name of the class implementing org.jminor.common.Serializer<Entity>
Default value: none

Constructor Detail

Domain

public Domain()

Instantiates a new Domain with the simple name of the class as domain id

See Also:

Class.getSimpleName()

Domain

public Domain(java.lang.String domainId)

Instantiates a new Domain

Parameters:

domainId - the domain identifier

Domain

public Domain(Domain domain)

Instantiates a new domain and copies all the entity definitions and database operations from domain

Parameters:

domain - the domain to copy

Method Detail

getDomainId

public final java.lang.String getDomainId()

Returns:

the domain Id

entity

public final Entity entity(java.lang.String entityId)

Creates a new Entity instance with the given entityId

Parameters:

entityId - the entity id

Returns:

a new Entity instance

entity

public final Entity entity(Entity.Key key)

Creates a new Entity instance with the given primary key

Parameters:

key - the primary key

Returns:

a new Entity instance

entity

public final Entity entity(java.lang.String entityId,
                           java.util.Map<Property,java.lang.Object> values,
                           java.util.Map<Property,java.lang.Object> originalValues)

Instantiates a new Entity instance using the given maps for the values and original values respectively. Note that the given map instances are used internally, modifying the contents of those maps outside the Entity instance will definitely result in some unexpected and unpleasant behaviour.

Parameters:

entityId - the entity id

values - the values

originalValues - the original values

Returns:

a new Entity instance

defaultEntity

public final Entity defaultEntity(java.lang.String entityId,
                                  ValueProvider<Property,java.lang.Object> valueProvider)

Instantiates a new Entity of the given type using the values provided by valueProvider. Values are fetched for ColumnProperty and its descendants, ForeignKeyProperty and TransientProperty (excluding its descendants). If a ColumnPropertys underlying column has a default value the property is skipped unless the property itself has a default value, which then overrides the columns default value.

Parameters:

entityId - the entity id

valueProvider - the value provider

Returns:

the populated entity

See Also:

ColumnProperty.Builder#setColumnHasDefaultValue(boolean), ColumnProperty.Builder#setDefaultValue(Object)

toBeans

public final java.util.List<java.lang.Object> toBeans(java.util.List<Entity> entities)

Transforms the given entities into beans according to the information found in this Domain model

Parameters:

entities - the entities to transform

Returns:

a List containing the beans derived from the given entities, an empty List if entities is null or empty

toBean

public <V> V toBean(Entity entity)

Transforms the given entity into a bean according to the information found in this Domain model

Type Parameters:

V - the bean type

Parameters:

entity - the entity to transform

Returns:

a bean derived from the given entity

fromBeans

public final java.util.List<Entity> fromBeans(java.util.List beans)

Transforms the given beans into a entities according to the information found in this Domain model

Parameters:

beans - the beans to transform

Returns:

a List containing the entities derived from the given beans, an empty List if beans is null or empty

fromBean

public <V> Entity fromBean(V bean)

Creates a Entity from the given bean object.

Type Parameters:

V - the bean type

Parameters:

bean - the bean to convert to an Entity

Returns:

a Entity based on the given bean

See Also:

Entity.Definition.Builder.setBeanClass(Class)

key

public final Entity.Key key(java.lang.String entityId)

Creates a new Entity.Key instance with the given entityId

Parameters:

entityId - the entity id

Returns:

a new Entity.Key instance

define

public final Entity.Definition.Builder define(java.lang.String entityId,
                                              Property.Builder... propertyBuilders)

Adds a new Entity.Definition to this domain model, using the entityId as table name. Returns the Entity.Definition instance for further configuration.

Parameters:

entityId - the id uniquely identifying the entity type

propertyBuilders - the Property.Builder objects to base this entity on. In case a select query is specified for this entity, the property order must match the select column order.

Returns:

a Entity.Definition.Builder

Throws:

java.lang.IllegalArgumentException - in case the entityId has already been used to define an entity type or if no primary key property is specified

define

public final Entity.Definition.Builder define(java.lang.String entityId,
                                              java.lang.String tableName,
                                              Property.Builder... propertyBuilders)

Adds a new Entity.Definition to this domain model. Returns the Entity.Definition instance for further configuration.

Parameters:

entityId - the id uniquely identifying the entity type

tableName - the name of the underlying table

propertyBuilders - the Property.Builder objects to base the entity on. In case a select query is specified for this entity, the property order must match the select column order.

Returns:

a Entity.Definition.Builder

Throws:

java.lang.IllegalArgumentException - in case the entityId has already been used to define an entity type or if no primary key property is specified

getEntityDefinitions

public final java.util.Collection<Entity.Definition> getEntityDefinitions()

Returns:

all Entity.Definitions found in this domain model

isDefined

public final boolean isDefined(java.lang.String entityId)

Parameters:

entityId - the entity id

Returns:

true if the entity is defined

createToStringEntity

public final Entity createToStringEntity(java.lang.String entityId,
                                         java.lang.String toStringValue)

Creates an empty Entity instance returning the given string on a call to toString(), all other method calls are routed to an empty Entity instance.

Parameters:

entityId - the entityId

toStringValue - the string to return by a call to toString() on the resulting entity

Returns:

an empty entity wrapping a string

getEntitySerializer

public final Serializer<Entity> getEntitySerializer()

Returns:

a Serializer, if one is available on the classpath

entitySerializerAvailable

public final boolean entitySerializerAvailable()

Returns:

true if a entity serializer is specified and available on the classpath

addOperation

public final void addOperation(DatabaseConnection.Operation operation)

Adds the given Operation to this domain

Parameters:

operation - the operation to add

Throws:

java.lang.IllegalArgumentException - in case an operation with the same id has already been added

getProcedure

public final <C> DatabaseConnection.Procedure<C> getProcedure(java.lang.String procedureId)

Type Parameters:

C - the type of the database connection this procedure requires

Parameters:

procedureId - the procedure id

Returns:

the procedure

Throws:

java.lang.IllegalArgumentException - in case the procedure is not found

getFunction

public final <C> DatabaseConnection.Function<C> getFunction(java.lang.String functionId)

Type Parameters:

C - the type of the database connection this function requires

Parameters:

functionId - the function id

Returns:

the function

Throws:

java.lang.IllegalArgumentException - in case the function is not found

registerDomain

public final Domain registerDomain()

Registers this instance for lookup via getDomain(String), required for serialization of domain objects, entities and related classes.

Returns:

this Domain instance

See Also:

getDomainId()

orderBy

public static final Entity.OrderBy orderBy()

Returns:

a new OrderBy instance

incrementKeyGenerator

public final Entity.KeyGenerator incrementKeyGenerator(java.lang.String tableName,
                                                       java.lang.String columnName)

Instantiates a primary key generator which fetches the current maximum primary key value and increments it by one prior to insert. Note that if the primary key value of the entity being inserted is already populated this key generator does nothing, that is, it does not overwrite a manually set primary key value.

Parameters:

tableName - the table name

columnName - the primary key column name

Returns:

a incrementing primary key generator

sequenceKeyGenerator

public final Entity.KeyGenerator sequenceKeyGenerator(java.lang.String sequenceName)

Instantiates a primary key generator which fetches primary key values from a sequence prior to insert. Note that if the primary key value of the entity being inserted is already populated this key generator does nothing, that is, it does not overwrite a manually set primary key value.

Parameters:

sequenceName - the sequence name

Returns:

a sequence based primary key generator

queriedKeyGenerator

public final Entity.KeyGenerator queriedKeyGenerator(java.lang.String query)

Instantiates a primary key generator which fetches primary key values using the given query prior to insert. Note that if the primary key value of the entity being inserted is already populated this key generator does nothing, that is, it does not overwrite a manually set primary key value.

Parameters:

query - a query for retrieving the primary key value

Returns:

a query based primary key generator

automaticKeyGenerator

public final Entity.KeyGenerator automaticKeyGenerator(java.lang.String valueSource)

Instantiates a primary key generator which fetches automatically incremented primary key values after insert.

Parameters:

valueSource - the value source, whether a sequence or a table name

Returns:

a auto-increment based primary key generator

getDomain

public static Domain getDomain(java.lang.String domainId)

Parameters:

domainId - the id of the domain for which to retrieve the entity definitions

Returns:

the domain instance registered for the given domainId

Throws:

java.lang.IllegalArgumentException - in case the domain has not been registered

See Also:

registerDomain()

getRegisteredDomains

public static java.util.Collection<Domain> getRegisteredDomains()

Returns:

all domains that have been registered via registerDomain()

getDefinition

public final Entity.Definition getDefinition(java.lang.String entityId)

Parameters:

entityId - the entity id

Returns:

the definition of the given entity

Throws:

java.lang.IllegalArgumentException - in case no entity with the given id has been defined