Package ch.tocco.nice2.persist.core.api.exec.tasks2

Class EntityTasks

java.lang.Object

ch.tocco.nice2.persist.core.api.exec.tasks2.EntityTasks

public final class EntityTasks
extends Object

Utility tasks usually working on Entitys.

Method Summary

Modifier and Type	Method	Description
static OptionalTask<Entity,Entity>	addToRelation(Relation relation)	Sets the task entity to the relation.
static OptionalTask<String,Entity>	createEntity()	Creates a new entity using the entity model given as argument.
static NoArgPersistTask<Entity>	createEntity(String entityName)	creates a entity of the given type
static OptionalTask<Entity,Void>	deleteEntity()	Deletes the given Entity
static OptionalTask<Entity,Entity>	fillEmptyValues()	Fill all required but null values with an empty value.
static OptionalTask<Entity,EntityId>	getEntityId()	Return the entity-id of a given entity.
static NoArgPersistTask<EntityModel>	getEntityModel(String entityName)	get the EntityModel for an entity name
static <V> OptionalTask<Entity,V>	getFieldValue(String name, Class<V> type)	Return the value of a field from an entity.
static OptionalTask<Entity,Boolean>	hasRelation(String relationName)	Return `true` if the given entity has a relation with name `relationName`.
static PersistTask<Entity,Boolean>	isEntityDeleted()	checks if the entity has the state Entity.State.PHANTOM
static <V> PersistTask<Entity,Boolean>	isFieldNull(String name, Class<V> type)	checks if the value of the field with the given name is null
static OptionalTask<Entity,Boolean>	isRelationEmpty(String relationName)	Resolves and returns true if it is empty, false otherwise
static OptionalTask<Entity,Boolean>	isStatus(Entity.State state)	Checks if the given entity has state `state`.
static OptionalTask<EntityEvent,Entity>	loadByEvent()
static <E extends EntityFacadeEvent> OptionalTask<E,Entity>	loadByFacadeEvent()
static OptionalTask<EntityId,Entity>	loadById()
static PersistTask<Long,Entity>	loadByLongPk(String entityModel)
static OptionalTask<PrimaryKey,Entity>	loadByPk(String model)
static PersistTaskIterable<Iterable<PrimaryKey>,Entity>	loadByPks(String model)	load all entities from a given list of primary keys in a single query
static OptionalTask<SimpleEntityId,Entity>	loadBySimpleId()
static PersistTask<String,Entity>	loadByStringPk(String entityModel)
static OptionalTask<String,Entity>	loadByUniqueId(String entityModel)
static OptionalTask<Long,PrimaryKey>	pkFromLong()
static OptionalTask<String,PrimaryKey>	pkFromString(String entityModel)
static OptionalTask<Entity,Entity>	removeFromRelation(Relation relation)	removes the task entity from a relation
static OptionalTask<Relation,Relation>	removeRelation(Entity target)	removes the target entity from a relation
static OptionalTask<Entity,Entity>	resolveAndRemoveRelation(String relationName, Entity entityToSet)	Resolves and removes the given entity from the relation
static OptionalTask<Entity,Entity>	resolveAndSetLookup(String lookupName, String uniqueId)	Resolves and sets the lookup relation to a unique id.
static OptionalTask<Entity,Entity>	resolveAndSetRelation(String relationName, Entity entityToSet)	Resolves and sets the relation to given entity
static <T> OptionalTask<Entity,Entity>	resolveAndSetRelation(String relationName, PersistTask<T,Entity> task, T argument)	Resolves and sets the relation to the task result.
static PersistTaskIterable<Entity,Entity>	resolveQuery(Path relationPath)	Resolves a path against the given entity.
static PersistTaskIterable<Entity,Entity>	resolveQuery(String relationPath)	Resolves a path against the given entity.
static OptionalTask<Entity,EntityList>	resolveQueryToList(Path relationPath)	Resolve a path against a given entity and return the result as a list of entities.
static OptionalTask<Entity,EntityList>	resolveQueryToList(String relationPath)	Resolve a relation path against the given entity.
static OptionalTask<Entity,Relation>	resolveRelation(String relation)	Resolves from the entity to a relation.
static <V> OptionalTask<Entity,Entity>	setFieldValue(String name, V value)	Set the value on the entity and return the entity.
static <V> OptionalTask<Entity,Entity>	setFieldValueByTask(String fieldName, PersistTask<Entity,V> task)	Executes a task and sets the result in the given field if the given task returns null the field won't get touched.
static OptionalTask<Relation,Entity>	setLookupRelation(String model, String uniqueId)	Loads the entity with the given unique_id and sets it using setRelation(Entity).
static OptionalTask<Relation,Relation>	setRelation(Entity target)	Sets the target entity to the relation.

Methods inherited from class java.lang.Object

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

Method Details

createEntity

public static OptionalTask<String,Entity> createEntity()

Creates a new entity using the entity model given as argument.

loadById

public static OptionalTask<EntityId,Entity> loadById()

loadBySimpleId

public static OptionalTask<SimpleEntityId,Entity> loadBySimpleId()

loadByUniqueId

public static OptionalTask<String,Entity> loadByUniqueId(String entityModel)

loadByPk

public static OptionalTask<PrimaryKey,Entity> loadByPk(String model)

loadByPks

public static PersistTaskIterable<Iterable<PrimaryKey>,Entity> loadByPks(String model)

load all entities from a given list of primary keys in a single query

Parameters:

model - the model to load

Returns:

an iterable task that returns entitites

pkFromString

public static OptionalTask<String,PrimaryKey> pkFromString(String entityModel)

pkFromLong

public static OptionalTask<Long,PrimaryKey> pkFromLong()

loadByEvent

public static OptionalTask<EntityEvent,Entity> loadByEvent()

loadByFacadeEvent

public static <E extends EntityFacadeEvent>
OptionalTask<E,Entity> loadByFacadeEvent()

loadByLongPk

public static PersistTask<Long,Entity> loadByLongPk(String entityModel)

loadByStringPk

public static PersistTask<String,Entity> loadByStringPk(String entityModel)

getFieldValue

public static <V> OptionalTask<Entity,V> getFieldValue(String name,
 Class<V> type)

Return the value of a field from an entity.

setFieldValue

public static <V> OptionalTask<Entity,Entity> setFieldValue(String name,
 @Nullable
 V value)

Set the value on the entity and return the entity.

Parameters:

name - the field to set the value in

value - the value to set

Returns:

the entity the value was set on

setFieldValueByTask

public static <V> OptionalTask<Entity,Entity> setFieldValueByTask(String fieldName,
 PersistTask<Entity,V> task)

Executes a task and sets the result in the given field if the given task returns null the field won't get touched.

Returns:

the input Entity

isFieldNull

public static <V> PersistTask<Entity,Boolean> isFieldNull(String name,
 Class<V> type)

checks if the value of the field with the given name is null

Parameters:

name - the name of the field

type - the type of the field

Returns:

true if the field is null, false otherwise

isStatus

public static OptionalTask<Entity,Boolean> isStatus(Entity.State state)

Checks if the given entity has state `state`.

isEntityDeleted

public static PersistTask<Entity,Boolean> isEntityDeleted()

checks if the entity has the state Entity.State.PHANTOM

Returns:

true if the entity is in state Entity.State.PHANTOM

fillEmptyValues

public static OptionalTask<Entity,Entity> fillEmptyValues()

Fill all required but null values with an empty value.

hasRelation

public static OptionalTask<Entity,Boolean> hasRelation(String relationName)

Return `true` if the given entity has a relation with name `relationName`.

isRelationEmpty

public static OptionalTask<Entity,Boolean> isRelationEmpty(String relationName)

Resolves and returns true if it is empty, false otherwise

resolveRelation

public static OptionalTask<Entity,Relation> resolveRelation(String relation)

Resolves from the entity to a relation.

resolveQueryToList

public static OptionalTask<Entity,EntityList> resolveQueryToList(String relationPath)

Resolve a relation path against the given entity. Note, unlike Entity.resolve(String) this also works with paths like "relA.relB" (the path must end in a relation).

resolveQueryToList

public static OptionalTask<Entity,EntityList> resolveQueryToList(Path relationPath)

Resolve a path against a given entity and return the result as a list of entities.

resolveQuery

public static PersistTaskIterable<Entity,Entity> resolveQuery(Path relationPath)

Resolves a path against the given entity. The result is converted into a iterable of entities. Note, unlike Entity.resolve(String) this also works with paths like "relA.relB" (the path must end in a relation).

resolveQuery

public static PersistTaskIterable<Entity,Entity> resolveQuery(String relationPath)

Resolves a path against the given entity. The result is converted into a iterable of entities. Note, unlike Entity.resolve(String) this also works with paths like "relA.relB" (the path must end in a relation).

setRelation

public static OptionalTask<Relation,Relation> setRelation(Entity target)

Sets the target entity to the relation. If the relation is to-1 `set` is used, and if it is to-many `add` is used.

addToRelation

public static OptionalTask<Entity,Entity> addToRelation(Relation relation)

Sets the task entity to the relation. If the relation is to-1 `set` is used, and if it is to-many `add` is used.

Parameters:

relation - relation to add to

removeRelation

public static OptionalTask<Relation,Relation> removeRelation(Entity target)

removes the target entity from a relation

Parameters:

target - the entity to remove

removeFromRelation

public static OptionalTask<Entity,Entity> removeFromRelation(Relation relation)

removes the task entity from a relation

Parameters:

relation - the relation to remove from

resolveAndSetRelation

public static <T> OptionalTask<Entity,Entity> resolveAndSetRelation(String relationName,
 PersistTask<T,Entity> task,
 T argument)

Resolves and sets the relation to the task result. if the given task returns null the relation won't get touched.

Returns:

the input Entity

resolveAndSetLookup

public static OptionalTask<Entity,Entity> resolveAndSetLookup(String lookupName,
 String uniqueId)

Resolves and sets the lookup relation to a unique id.

Returns:

the input Entity

resolveAndSetRelation

public static OptionalTask<Entity,Entity> resolveAndSetRelation(String relationName,
 Entity entityToSet)

Resolves and sets the relation to given entity

Returns:

the input Entity

resolveAndRemoveRelation

public static OptionalTask<Entity,Entity> resolveAndRemoveRelation(String relationName,
 Entity entityToSet)

Resolves and removes the given entity from the relation

Returns:

the input Entity

setLookupRelation

public static OptionalTask<Relation,Entity> setLookupRelation(String model,
 String uniqueId)

Loads the entity with the given unique_id and sets it using setRelation(Entity). An IllegalStateException will be thrown if no entity with the given unique_id exists.

Parameters:

model - the model of the lookup entity

uniqueId - the unique_id of the entity to set

Returns:

the source entity of the relation

getEntityId

public static OptionalTask<Entity,EntityId> getEntityId()

Return the entity-id of a given entity. The primary must exist.

deleteEntity

public static OptionalTask<Entity,Void> deleteEntity()

Deletes the given Entity

createEntity

public static NoArgPersistTask<Entity> createEntity(String entityName)

creates a entity of the given type

Parameters:

entityName - the entity name to create

Returns:

the created entity

getEntityModel

public static NoArgPersistTask<EntityModel> getEntityModel(String entityName)

get the EntityModel for an entity name

Parameters:

entityName - the entity name to get the model for

Returns:

the entity model