io.jmix.core

Class EntityStates

java.lang.Object

io.jmix.core.EntityStates

@Component(value="core_EntityStates")
public class EntityStates
extends java.lang.Object

Provides information about entities states.

Field Summary

Fields

Modifier and Type	Field and Description
protected PersistentAttributesLoadChecker	checker
protected FetchPlanRepository	fetchPlanRepository
protected FetchPlans	fetchPlans
protected Metadata	metadata
protected MetadataTools	metadataTools

Constructor Summary

Constructors

Constructor and Description
EntityStates()

Method Summary

Modifier and Type	Method and Description
void	checkLoaded(java.lang.Object entity, java.lang.String... properties) Check that entity has all specified properties loaded from DB.
void	checkLoadedWithFetchPlan(java.lang.Object entity, FetchPlan fetchPlan) Check that all properties of the fetch plan are loaded from DB for the passed entity.
protected void	checkLoadedWithFetchPlan(java.lang.Object entity, FetchPlan fetchPlan, java.util.Set visited)
void	checkLoadedWithFetchPlan(java.lang.Object entity, java.lang.String fetchPlanName) Check that all properties of the fetch plan are loaded from DB for the passed entity.
FetchPlan	getCurrentFetchPlan(java.lang.Object entity) Returns a fetch plan that corresponds to the loaded attributes of the given entity instance.
boolean	isDeleted(java.lang.Object entity) Determines whether the entity instance was deleted.
boolean	isDetached(java.lang.Object entity) Determines whether the instance is Detached, i.e.
boolean	isLoaded(java.lang.Object entity, java.lang.String property) Checks if the property is loaded from DB.
boolean	isLoadedWithFetchPlan(java.lang.Object entity, FetchPlan fetchPlan) Check that all properties of the fetch plan are loaded from DB for the passed entity.
protected boolean	isLoadedWithFetchPlan(java.lang.Object entity, FetchPlan fetchPlan, java.util.Set visited)
boolean	isLoadedWithFetchPlan(java.lang.Object entity, java.lang.String fetchPlanName) Check that all properties of the fetch plan are loaded from DB for the passed entity.
boolean	isManaged(java.lang.Object entity) Determines whether the instance is Managed, i.e.
boolean	isNew(java.lang.Object entity) Determines whether the instance is New, i.e.
void	makeDetached(java.lang.Object entity) Makes a newly constructed object detached.
void	makePatch(java.lang.Object entity) Makes a newly constructed object a patch object.
protected void	recursivelyConstructCurrentFetchPlan(Entity entity, FetchPlanBuilder builder, java.util.HashSet<java.lang.Object> visited)

Methods inherited from class java.lang.Object

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

Field Detail

checker

@Autowired
protected PersistentAttributesLoadChecker checker

fetchPlanRepository

@Autowired
protected FetchPlanRepository fetchPlanRepository

metadataTools

@Autowired
protected MetadataTools metadataTools

metadata

@Autowired
protected Metadata metadata

fetchPlans

@Autowired
protected FetchPlans fetchPlans

Constructor Detail

EntityStates

public EntityStates()

Method Detail

isNew

public boolean isNew(java.lang.Object entity)

Determines whether the instance is New, i.e. just created and not stored in database yet.

Parameters:

entity - entity instance

Returns:

- true if the instance is a new persistent entity, or if it is actually in Managed state but newly-persisted in this transaction
- true if the instance is a new non-persistent entity never returned from DataManager
- false otherwise

Throws:

java.lang.IllegalArgumentException - if entity instance is null

isManaged

public boolean isManaged(java.lang.Object entity)

Determines whether the instance is Managed, i.e. attached to a persistence context.

Parameters:

entity - entity instance

Returns:

- true if the instance is managed,
- false if it is New (and not yet persisted) or Detached, or if it is not a persistent entity

Throws:

java.lang.IllegalArgumentException - if entity instance is null

isDetached

public boolean isDetached(java.lang.Object entity)

Determines whether the instance is Detached, i.e. stored in database but not attached to a persistence context at the moment.

Parameters:

entity - entity instance

Returns:

- true if the instance is detached,
- false if it is New or Managed, or if it is not a persistent entity

Throws:

java.lang.IllegalArgumentException - if entity instance is null

isLoaded

public boolean isLoaded(java.lang.Object entity,
                        java.lang.String property)

Checks if the property is loaded from DB.

Non-persistent attributes are considered loaded if they do not have related properties, or all related properties are loaded.

Parameters:

entity - entity

property - name of the property. Only immediate attributes of the entity are supported.

Returns:

true if loaded

checkLoaded

public void checkLoaded(java.lang.Object entity,
                        java.lang.String... properties)

Check that entity has all specified properties loaded from DB. Throw exception if property is not loaded.

Parameters:

entity - entity

properties - property names

Throws:

java.lang.IllegalArgumentException - if at least one of properties is not loaded

checkLoadedWithFetchPlan

protected void checkLoadedWithFetchPlan(java.lang.Object entity,
                                        FetchPlan fetchPlan,
                                        java.util.Set visited)

checkLoadedWithFetchPlan

public void checkLoadedWithFetchPlan(java.lang.Object entity,
                                     FetchPlan fetchPlan)

Check that all properties of the fetch plan are loaded from DB for the passed entity. Throws exception if some property is not loaded.

Parameters:

entity - entity

fetchPlan - fetch plan

Throws:

java.lang.IllegalArgumentException - if at least one of properties is not loaded

checkLoadedWithFetchPlan

public void checkLoadedWithFetchPlan(java.lang.Object entity,
                                     java.lang.String fetchPlanName)

Check that all properties of the fetch plan are loaded from DB for the passed entity. Throws exception if some property is not loaded.

Parameters:

entity - entity

fetchPlanName - fetch plan name

Throws:

java.lang.IllegalArgumentException - if at least one of properties is not loaded

isLoadedWithFetchPlan

protected boolean isLoadedWithFetchPlan(java.lang.Object entity,
                                        FetchPlan fetchPlan,
                                        java.util.Set visited)

isLoadedWithFetchPlan

public boolean isLoadedWithFetchPlan(java.lang.Object entity,
                                     FetchPlan fetchPlan)

Check that all properties of the fetch plan are loaded from DB for the passed entity.

Parameters:

entity - entity

fetchPlan - fetch plan

Returns:

false if at least one of properties is not loaded

isLoadedWithFetchPlan

public boolean isLoadedWithFetchPlan(java.lang.Object entity,
                                     java.lang.String fetchPlanName)

Check that all properties of the fetch plan are loaded from DB for the passed entity.

Parameters:

entity - entity

fetchPlanName - fetch plan name

Returns:

false if at least one of properties is not loaded

getCurrentFetchPlan

public FetchPlan getCurrentFetchPlan(java.lang.Object entity)

Returns a fetch plan that corresponds to the loaded attributes of the given entity instance.

Parameters:

entity - entity instance

Returns:

fetch plan

recursivelyConstructCurrentFetchPlan

protected void recursivelyConstructCurrentFetchPlan(Entity entity,
                                                    FetchPlanBuilder builder,
                                                    java.util.HashSet<java.lang.Object> visited)

isDeleted

public boolean isDeleted(java.lang.Object entity)

Determines whether the entity instance was deleted.

Parameters:

entity - entity instance

Returns:

- true if the instance was deleted - false otherwise

Throws:

java.lang.IllegalArgumentException - if entity instance is null

makeDetached

public void makeDetached(java.lang.Object entity)

Makes a newly constructed object detached. The detached object can be passed to DataManager.commit() or to EntityManager.merge() to save its state to the database.

If an object with such ID does not exist in the database, a new object will be inserted.

If the entity is Versioned, the version attribute should be equal to the latest version existing in the database, or null for a new object.

Parameters:

entity - entity in the New state

Throws:

java.lang.IllegalStateException - if the entity is Managed

See Also:

isDetached(Object), makePatch(Object)

makePatch

public void makePatch(java.lang.Object entity)

Makes a newly constructed object a patch object. The patch object is !isNew() && !isDetached() && !isManaged(). The patch object can be passed to DataManager.commit() or to EntityManager.merge() to save its state to the database. Only non-null values of attributes are updated.

If an object with such ID does not exist in the database, a new object will be inserted.

If the entity is Versioned, the version attribute should be null or equal to the latest version existing in the database.

Parameters:

entity - entity in the New or Detached state

Throws:

java.lang.IllegalStateException - if the entity is Managed

See Also:

isDetached(Object), makeDetached(Object)