Package io.jmix.data.impl

Class BaseAttributeChangesProvider

java.lang.Object

io.jmix.data.impl.BaseAttributeChangesProvider

All Implemented Interfaces:

AttributeChangesProvider

Direct Known Subclasses:

EclipselinkAttributeChangesProvider

public abstract class BaseAttributeChangesProvider
extends Object
implements AttributeChangesProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected EntityStates	entityStates
protected Metadata	metadata
protected MetadataTools	metadataTools

Constructor Summary

Constructors

Constructor	Description
BaseAttributeChangesProvider()

Method Summary

Modifier and Type	Method	Description
protected abstract void	buildChangesByImplementation(AttributeChanges.Builder builder, Object entity, BiFunction<Object,MetaProperty,Object> transformer)
protected void	buildExtraChanges(AttributeChanges.Builder builder, Object entity)
protected void	checkEntityState(Object entity)
protected Object	convertValueIfNeeded(Object value, MetaProperty metaProperty)
AttributeChanges	getAttributeChanges(Object entity)	Returns an object describing changes in entity attributes.
Set<String>	getChangedAttributeNames(Object entity)	Returns the set of dirty attributes (changed since the last load from the database).
protected abstract Set<String>	getChangedAttributeNamesByImplementation(Object entity)
Object	getOldValue(Object entity, String attribute)	Returns an old value of an attribute changed in the current transaction.
protected abstract Object	getOldValueByImplementation(Object entity, String attribute)
boolean	isChanged(Object entity)	Returns true if the given entity has dirty attributes (changed since the last load from the database).
boolean	isChanged(Object entity, String... attributes)	Returns true if at least one of the given attributes is dirty (i.e.
protected abstract boolean	isSoftDeletionEnabled()
protected Collection<Object>	newCollectionForProperty(MetaProperty metaProperty)
void	setEntityStates(EntityStates entityStates)
void	setMetadata(Metadata metadata)
void	setMetadataTools(MetadataTools metadataTools)

Methods inherited from class java.lang.Object

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

Field Details

entityStates

protected EntityStates entityStates

metadata

protected Metadata metadata

metadataTools

protected MetadataTools metadataTools

Constructor Details

BaseAttributeChangesProvider

public BaseAttributeChangesProvider()

Method Details

setEntityStates

@Autowired
public void setEntityStates(EntityStates entityStates)

setMetadata

@Autowired
public void setMetadata(Metadata metadata)

setMetadataTools

@Autowired
public void setMetadataTools(MetadataTools metadataTools)

getAttributeChanges

public AttributeChanges getAttributeChanges(Object entity)

Description copied from interface: AttributeChangesProvider

Returns an object describing changes in entity attributes.

Specified by:

getAttributeChanges in interface AttributeChangesProvider

Parameters:

entity - entity instance

Returns:

dirty attribute names

buildChangesByImplementation

protected abstract void buildChangesByImplementation(AttributeChanges.Builder builder,
 Object entity,
 BiFunction<Object,MetaProperty,Object> transformer)

getChangedAttributeNames

public Set<String> getChangedAttributeNames(Object entity)

Description copied from interface: AttributeChangesProvider

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.

Specified by:

getChangedAttributeNames in interface AttributeChangesProvider

Parameters:

entity - entity instance

Returns:

dirty attribute names

See Also:

• AttributeChangesProvider.isChanged(Object, String...)

getChangedAttributeNamesByImplementation

protected abstract Set<String> getChangedAttributeNamesByImplementation(Object entity)

isChanged

public boolean isChanged(Object entity)

Description copied from interface: AttributeChangesProvider

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.

Specified by:

isChanged in interface AttributeChangesProvider

Parameters:

entity - entity instance

See Also:

• AttributeChangesProvider.getChangedAttributeNames(Object)
• AttributeChangesProvider.isChanged(Object, String...)

isChanged

public boolean isChanged(Object entity,
 String... attributes)

Description copied from interface: AttributeChangesProvider

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.

Specified by:

isChanged in interface AttributeChangesProvider

Parameters:

entity - entity instance

attributes - attributes to check

See Also:

• AttributeChangesProvider.getChangedAttributeNames(Object)

getOldValue

@Nullable
public Object getOldValue(Object entity,
 String attribute)

Description copied from interface: AttributeChangesProvider

Returns an old value of an attribute changed in the current transaction. The entity must be in the Managed state. For enum attributes returns enum value.
You can check if the value has been changed using AttributeChangesProvider.isChanged(Object, String...) method.

Specified by:

getOldValue in interface AttributeChangesProvider

Parameters:

entity - entity instance

attribute - attribute name

Returns:

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

See Also:

• AttributeChangesProvider.isChanged(Object, String...)
• AttributeChangesProvider.getChangedAttributeNames(Object)

getOldValueByImplementation

@Nullable
protected abstract Object getOldValueByImplementation(Object entity,
 String attribute)

convertValueIfNeeded

@Nullable
protected Object convertValueIfNeeded(@Nullable
 Object value,
 MetaProperty metaProperty)

isSoftDeletionEnabled

protected abstract boolean isSoftDeletionEnabled()

buildExtraChanges

protected void buildExtraChanges(AttributeChanges.Builder builder,
 Object entity)

newCollectionForProperty

protected Collection<Object> newCollectionForProperty(MetaProperty metaProperty)

checkEntityState

protected void checkEntityState(Object entity)