Package ch.tocco.nice2.persist.entity.spi.template

Class TemplateEntityManager

java.lang.Object

ch.tocco.nice2.persist.entity.spi.template.TemplateEntityManager

All Implemented Interfaces:

EntityManager

public class TemplateEntityManager
extends Object
implements EntityManager

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENTITY_TEMPLATE_MODEL

Constructor Summary

Constructors

Constructor	Description
TemplateEntityManager(TemplateEntityModel templateModel, EntityManager templateManager, CommandExecutor executor, PersistTask<Entity,TemplateEntity> mapper)

Method Summary

Modifier and Type	Method	Description
void	addEntityFacadeListener(EntityFacadeListener l)	Add an EntityFacadeListener.
void	addEntityListener(EntityListener l)	Add an EntityListener.
TemplateEntity	create()	Create a new entity (state Entity.State.CONCEPTION.
EntityList	createEntityList(PrimaryKey... entities)
EntityList	createEntityList(Entity... entities)	Creates an EntityList of persistent entities of the same EntityModel.
Query	createQuery(Collection<PrimaryKey> keys)	Create a query that returns objects with known primary keys.
Query	createQueryForAll()	Create a Query for all entities of that type.
List<Entity>	delete(Condition condition)	Deletes all entities of the current EntityModel on which the condition applies to in a single sql statement.
TemplateEntity	get(PrimaryKey key)	Get an entity by a known primary key.
TemplateEntity	get(String uniqueId)	Get an entity by unique_id field.
Context	getContext()	Get the persistence context of this entity manager.
TemplateEntityModel	getModel()	Get the entity type's model.
void	removeEntityFacadeListener(EntityFacadeListener l)	Remove an EntityFacadeListener.
void	removeEntityListener(EntityListener l)	Remove an EntityListener.
@Nullable TemplateEntity	retrieve(PrimaryKey key)	Retrieve an entity by a known primary key.
@Nullable TemplateEntity	retrieve(String uniqueId)	Retrieve an entity by unique_id field.

Methods inherited from class java.lang.Object

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

Field Details

ENTITY_TEMPLATE_MODEL

public static final String ENTITY_TEMPLATE_MODEL

See Also:

• Constant Field Values

Constructor Details

TemplateEntityManager

public TemplateEntityManager(TemplateEntityModel templateModel,
 EntityManager templateManager,
 CommandExecutor executor,
 PersistTask<Entity,TemplateEntity> mapper)

Method Details

get

public TemplateEntity get(PrimaryKey key)
                   throws PersistException

Description copied from interface: EntityManager

Get an entity by a known primary key. If the entity with the specified key isn't present, in the database, this method throws a NotFoundException. Use EntityManager.retrieve(PrimaryKey), if you prefer a `null` value, if the entity does not exist.

Specified by:

get in interface EntityManager

Parameters:

key - The primary key.

Returns:

An entity facade for the entity with the specified key

Throws:

PersistException

See Also:

• EntityManager.retrieve(PrimaryKey)

retrieve

@Nullable
public @Nullable TemplateEntity retrieve(PrimaryKey key)
                                  throws PersistException

Description copied from interface: EntityManager

Retrieve an entity by a known primary key. Unlike EntityManager.get(PrimaryKey), this method returns null if the entity does not exist in the database or the current user has no access to the entity.

Specified by:

retrieve in interface EntityManager

Parameters:

key - The PrimaryKey of the entity.

Returns:

The entity or null, if the entity does not exist or is not accessible.

Throws:

PersistException - If an error occurs.

See Also:

• EntityManager.get(PrimaryKey)

get

public TemplateEntity get(String uniqueId)
                   throws PersistException

Description copied from interface: EntityManager

Get an entity by unique_id field. Throws if entity cannot be found.

Specified by:

get in interface EntityManager

Parameters:

uniqueId - unique id value of entity.

Returns:

An entity facade for the entity with the specified unique_id

Throws:

PersistException

See Also:

• EntityManager.get(ch.tocco.nice2.model.entity.api.PrimaryKey)

retrieve

@Nullable
public @Nullable TemplateEntity retrieve(String uniqueId)
                                  throws PersistException

Description copied from interface: EntityManager

Retrieve an entity by unique_id field.

Specified by:

retrieve in interface EntityManager

Parameters:

uniqueId - unique id value of entity.

Returns:

The entity or null, if the entity does not exist or is not accessible.

Throws:

PersistException

See Also:

• EntityManager.retrieve(ch.tocco.nice2.model.entity.api.PrimaryKey)

create

public TemplateEntity create()
                      throws PersistException

Description copied from interface: EntityManager

Create a new entity (state Entity.State.CONCEPTION. The entity won't have any primary key yet and will be written into the storage when the transaction is committed.

Specified by:

create in interface EntityManager

Returns:

The newly created entity.

Throws:

PersistException

delete

public List<Entity> delete(Condition condition)

Description copied from interface: EntityManager

Deletes all entities of the current EntityModel on which the condition applies to in a single sql statement. Does not provide cascading delete.

Specified by:

delete in interface EntityManager

createQueryForAll

public Query createQueryForAll()
                        throws PersistException

Description copied from interface: EntityManager

Create a Query for all entities of that type.

Specified by:

createQueryForAll in interface EntityManager

Returns:

A query that queries all entities.

Throws:

PersistException

createQuery

public Query createQuery(Collection<PrimaryKey> keys)
                  throws PersistException

Description copied from interface: EntityManager

Create a query that returns objects with known primary keys. Note that the results will be returned in random order unless a sorting is applied. They will not be returned in the given keys order. Use EntityLists.orderedList(ch.tocco.nice2.persist.core.api.entity.EntityList, ch.tocco.nice2.model.entity.api.PrimaryKey[]).

Specified by:

createQuery in interface EntityManager

Parameters:

keys - A collection of known primary keys.

Returns:

The executable query.

Throws:

PersistException

createEntityList

public EntityList createEntityList(Entity... entities)

Description copied from interface: EntityManager

Creates an EntityList of persistent entities of the same EntityModel.

Specified by:

createEntityList in interface EntityManager

Parameters:

entities - Must be of same EntityModel, and persistent (not conception).

Returns:

new EntityList of given persistent entities.

createEntityList

public EntityList createEntityList(PrimaryKey... entities)

Specified by:

createEntityList in interface EntityManager

getModel

public TemplateEntityModel getModel()

Description copied from interface: EntityManager

Get the entity type's model.

Specified by:

getModel in interface EntityManager

Returns:

The entity type's model.

getContext

public Context getContext()

Description copied from interface: EntityManager

Get the persistence context of this entity manager.

Specified by:

getContext in interface EntityManager

Returns:

The persistence context of this entity manager.

addEntityListener

public void addEntityListener(EntityListener l)

Description copied from interface: EntityManager

Add an EntityListener.

Specified by:

addEntityListener in interface EntityManager

Parameters:

l - The EntityListener to be added.

removeEntityListener

public void removeEntityListener(EntityListener l)

Description copied from interface: EntityManager

Remove an EntityListener.

Specified by:

removeEntityListener in interface EntityManager

Parameters:

l - The EntityListener to be removed.

addEntityFacadeListener

public void addEntityFacadeListener(EntityFacadeListener l)

Description copied from interface: EntityManager

Add an EntityFacadeListener.

Specified by:

addEntityFacadeListener in interface EntityManager

Parameters:

l - The EntityFacadeListener to be added.

removeEntityFacadeListener

public void removeEntityFacadeListener(EntityFacadeListener l)

Description copied from interface: EntityManager

Remove an EntityFacadeListener.

Specified by:

removeEntityFacadeListener in interface EntityManager

Parameters:

l - The EntityFacadeListener to be removed.