com.haulmont.cuba.core

Class PersistenceTools

java.lang.Object

com.haulmont.cuba.core.PersistenceTools

@Component(value="cuba_PersistenceTools")
public class PersistenceTools
extends java.lang.Object

Utility class to provide common functionality related to persistence.
Implemented as Spring bean to allow extension in application projects.
A reference to this class can be obtained either via DI or by Persistence.getTools() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersistenceTools.RefId A wrapper for the reference ID value returned by getReferenceId(BaseGenericIdEntity, String) method.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
PersistenceTools()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getDirtyFields(Entity entity) Returns the set of dirty attributes (changed since the last load from the database).
java.lang.Object	getOldValue(Entity entity, java.lang.String attribute) Returns an old value of an attribute changed in the current transaction.
PersistenceTools.RefId	getReferenceId(BaseGenericIdEntity entity, java.lang.String property) Returns an ID of directly referenced entity without loading it from DB.
boolean	isDirty(Entity entity) Returns true if the given entity has dirty attributes (changed since the last load from the database).
boolean	isDirty(Entity entity, java.lang.String... attributes) Returns true if at least one of the given attributes is dirty (i.e.
boolean	isLoaded(java.lang.Object entity, java.lang.String property) Checks if the property is loaded from DB.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

PersistenceTools

public PersistenceTools()

Method Detail

getDirtyFields

public java.util.Set<java.lang.String> getDirtyFields(Entity entity)

Returns the set of dirty attributes (changed since the last load from the database).

If the entity is new, returns all its attributes.

If the entity is not persistent or not in the Managed state, returns empty set.

Parameters:

entity - entity instance

Returns:

dirty attribute names

See Also:

isDirty(Entity, String...)

isDirty

public boolean isDirty(Entity entity)

Returns true if the given entity has dirty attributes (changed since the last load from the database).
If the entity is new, returns true.
If the entity is not persistent or not in the Managed state, returns false.

Parameters:

entity - entity instance

See Also:

getDirtyFields(Entity), isDirty(Entity, String...)

isDirty

public boolean isDirty(Entity entity,
                       java.lang.String... attributes)

Returns true if at least one of the given attributes is dirty (i.e. changed since the last load from the database).

If the entity is new, always returns true.

If the entity is not persistent or not in the Managed state, always returns false.

Parameters:

entity - entity instance

attributes - attributes to check

See Also:

getDirtyFields(Entity)

getOldValue

@Nullable
public java.lang.Object getOldValue(Entity entity,
                                              java.lang.String attribute)

Returns an old value of an attribute changed in the current transaction. The entity must be in the Managed state.

Parameters:

entity - entity instance

attribute - attribute name

Returns:

an old value stored in the database. For a new entity returns null.

Throws:

java.lang.IllegalArgumentException - if the entity is not persistent or not in the Managed state

isLoaded

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

Checks if the property is loaded from DB.

Parameters:

entity - entity

property - name of the property

Returns:

true if loaded

getReferenceId

public PersistenceTools.RefId getReferenceId(BaseGenericIdEntity entity,
                                             java.lang.String property)

Returns an ID of directly referenced entity without loading it from DB. If the view does not contain the reference and View.loadPartialEntities() is true, the returned PersistenceTools.RefId will have PersistenceTools.RefId.isLoaded() = false.

Usage example:

   PersistenceTools.RefId refId = persistenceTools.getReferenceId(doc, "currency");
   if (refId.isLoaded()) {
       String currencyCode = (String) refId.getValue();
   }
 

Parameters:

entity - entity instance in managed state

property - name of reference property

Returns:

PersistenceTools.RefId instance which contains the referenced entity ID

Throws:

java.lang.IllegalArgumentException - if the specified property is not a reference

java.lang.IllegalStateException - if the entity is not in Managed state

java.lang.RuntimeException - if anything goes wrong when retrieving the ID