io.jmix.core.entity

Class EntityValues

java.lang.Object

io.jmix.core.entity.EntityValues

public class EntityValues
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
EntityValues()

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	getCreatedBy(java.lang.Object entity)
static java.lang.Object	getCreatedDate(java.lang.Object entity)
static java.lang.Object	getDeletedBy(java.lang.Object entity)
static java.lang.Object	getDeletedDate(java.lang.Object entity)
static java.lang.Object	getGeneratedId(java.lang.Object entity)
static java.lang.Object	getId(java.lang.Object entity)
static java.lang.Object	getIdOrEntity(java.lang.Object entity)
static java.lang.Object	getLastModifiedBy(java.lang.Object entity)
static java.lang.Object	getLastModifiedDate(java.lang.Object entity)
static java.util.UUID	getUuid(java.lang.Object entity)
static <T> T	getValue(java.lang.Object entity, java.lang.String name) Get an attribute value.
static <T> T	getValueEx(java.lang.Object entity, PropertyPath propertyPath) Get an attribute value.
static <T> T	getValueEx(java.lang.Object entity, java.lang.String propertyPath) Get an attribute value.
static <T> T	getValueEx(java.lang.Object entity, java.lang.String[] properties) Get value of an attribute according to the rules described in getValueEx(Object, String).
static java.lang.Object	getVersion(java.lang.Object entity)
static boolean	isAuditSupported(java.lang.Object entity)
static boolean	isEntity(java.lang.Object entity)
static boolean	isSoftDeleted(java.lang.Object entity)
static boolean	isSoftDeletionSupported(java.lang.Object entity)
static boolean	isUuidSupported(java.lang.Object entity)
static boolean	isVersionSupported(java.lang.Object entity)
static boolean	propertyValueEquals(java.lang.Object a, java.lang.Object b) Used by to check whether a property value has been changed.
static void	setCreatedBy(java.lang.Object entity, java.lang.Object value)
static void	setCreatedDate(java.lang.Object entity, java.lang.Object value)
static void	setDeletedBy(java.lang.Object entity, java.lang.Object value)
static void	setDeletedDate(java.lang.Object entity, java.lang.Object value)
static void	setGeneratedId(java.lang.Object entity, java.lang.Object id)
static void	setId(java.lang.Object entity, java.lang.Object key)
static void	setLastModifiedBy(java.lang.Object entity, java.lang.Object value)
static void	setLastModifiedDate(java.lang.Object entity, java.lang.Object value)
static void	setUuid(java.lang.Object entity, java.util.UUID uuid)
static void	setValue(java.lang.Object entity, java.lang.String name, java.lang.Object value) Set an attribute value.
static void	setValue(java.lang.Object entity, java.lang.String name, java.lang.Object value, boolean checkEquals) Set an attribute value.
static void	setValueEx(java.lang.Object entity, PropertyPath propertyPath, java.lang.Object value) Set an attribute value.
static void	setValueEx(java.lang.Object entity, java.lang.String[] properties, java.lang.Object value) Set value of an attribute according to the rules described in setValueEx(Object, String, Object).
static void	setValueEx(java.lang.Object entity, java.lang.String propertyPath, java.lang.Object value) Set an attribute value.
static void	setVersion(java.lang.Object entity, java.lang.Object version)

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityValues

public EntityValues()

Method Detail

isEntity

public static boolean isEntity(java.lang.Object entity)

getId

@Nullable
public static java.lang.Object getId(java.lang.Object entity)

setId

public static void setId(java.lang.Object entity,
                         java.lang.Object key)

getIdOrEntity

public static java.lang.Object getIdOrEntity(java.lang.Object entity)

getGeneratedId

public static java.lang.Object getGeneratedId(java.lang.Object entity)

setGeneratedId

public static void setGeneratedId(java.lang.Object entity,
                                  java.lang.Object id)

setValue

public static void setValue(java.lang.Object entity,
                            java.lang.String name,
                            java.lang.Object value)

Set an attribute value.
An implementor should first read a current value of the attribute, and then call an appropriate setter method only if the new value differs. This ensures triggering of EntityPropertyChangeListeners only if the attribute was actually changed.

Parameters:

name - attribute name according to JavaBeans notation

value - attribute value

setValue

public static void setValue(java.lang.Object entity,
                            java.lang.String name,
                            java.lang.Object value,
                            boolean checkEquals)

Set an attribute value.
An implementor should first read a current value of the attribute, and then call an appropriate setter method only if the new value differs. This ensures triggering of EntityPropertyChangeListeners only if the attribute was actually changed.

Parameters:

name - attribute name according to JavaBeans notation

value - attribute value

checkEquals - check equals for previous and new value. If flag is true and objects equals, then setter will not be invoked

getValue

@Nullable
public static <T> T getValue(java.lang.Object entity,
                                       java.lang.String name)

Get an attribute value.

Parameters:

name - attribute name according to JavaBeans notation

Returns:

attribute value

getValueEx

@Nullable
public static <T> T getValueEx(java.lang.Object entity,
                                         java.lang.String propertyPath)

Get an attribute value. Locates the attribute by the given path in object graph starting from this instance.
The path must consist of attribute names according to JavaBeans notation, separated by dots, e.g. car.driver.name.

Parameters:

propertyPath - path to an attribute

Returns:

attribute value. If any traversing attribute value is null or is not an Entity, this method stops here and returns this value.

getValueEx

@Nullable
public static <T> T getValueEx(java.lang.Object entity,
                                         PropertyPath propertyPath)

Get an attribute value. Locates the attribute by the given path in object graph starting from this instance.
The path must consist of attribute names according to JavaBeans notation, separated by dots, e.g. car.driver.name.

Parameters:

propertyPath - path to an attribute

Returns:

attribute value. If any traversing attribute value is null or is not an Entity, this method stops here and returns this value.

setValueEx

public static void setValueEx(java.lang.Object entity,
                              java.lang.String propertyPath,
                              java.lang.Object value)

Set an attribute value. Locates the attribute by the given path in object graph starting from this instance.
The path must consist of attribute names according to JavaBeans notation, separated by dots, e.g. car.driver.name.
In the example above this method first gets value of car.driver attribute, and if it is not null and is an Entity, sets value of name attribute in it.
An implementor should first read a current value of the attribute, and then call an appropriate setter method only if the new value differs. This ensures triggering of EntityPropertyChangeListeners only if the attribute was actually changed.

Parameters:

propertyPath - path to an attribute

value - attribute value

setValueEx

public static void setValueEx(java.lang.Object entity,
                              PropertyPath propertyPath,
                              java.lang.Object value)

Set an attribute value. Locates the attribute by the given path in object graph starting from this instance.
The path must consist of attribute names according to JavaBeans notation, separated by dots, e.g. car.driver.name.
In the example above this method first gets value of car.driver attribute, and if it is not null and is an Entity, sets value of name attribute in it.
An implementor should first read a current value of the attribute, and then call an appropriate setter method only if the new value differs. This ensures triggering of EntityPropertyChangeListeners only if the attribute was actually changed.

Parameters:

propertyPath - path to an attribute

value - attribute value

setValueEx

public static void setValueEx(java.lang.Object entity,
                              java.lang.String[] properties,
                              java.lang.Object value)

Set value of an attribute according to the rules described in setValueEx(Object, String, Object).

Parameters:

entity - instance

properties - path to the attribute

value - attribute value

getValueEx

public static <T> T getValueEx(java.lang.Object entity,
                               java.lang.String[] properties)

Get value of an attribute according to the rules described in getValueEx(Object, String).

Parameters:

entity - entity

properties - path to the attribute

Returns:

attribute value

propertyValueEquals

public static boolean propertyValueEquals(@Nullable
                                          java.lang.Object a,
                                          @Nullable
                                          java.lang.Object b)

Used by to check whether a property value has been changed.

Parameters:

a - an object

b - an object

Returns:

true if a equals to b, but in case of a is or Collection returns true only if a is the same instance as b

isUuidSupported

public static boolean isUuidSupported(java.lang.Object entity)

getUuid

@Nullable
public static java.util.UUID getUuid(java.lang.Object entity)

setUuid

public static void setUuid(java.lang.Object entity,
                           java.util.UUID uuid)

isVersionSupported

public static boolean isVersionSupported(java.lang.Object entity)

getVersion

@Nullable
public static java.lang.Object getVersion(java.lang.Object entity)

setVersion

public static void setVersion(java.lang.Object entity,
                              java.lang.Object version)

isSoftDeletionSupported

public static boolean isSoftDeletionSupported(java.lang.Object entity)

isSoftDeleted

public static boolean isSoftDeleted(java.lang.Object entity)

getDeletedDate

public static java.lang.Object getDeletedDate(java.lang.Object entity)

setDeletedDate

public static void setDeletedDate(java.lang.Object entity,
                                  java.lang.Object value)

getDeletedBy

public static java.lang.Object getDeletedBy(java.lang.Object entity)

setDeletedBy

public static void setDeletedBy(java.lang.Object entity,
                                java.lang.Object value)

isAuditSupported

public static boolean isAuditSupported(java.lang.Object entity)

getCreatedDate

public static java.lang.Object getCreatedDate(java.lang.Object entity)

setCreatedDate

public static void setCreatedDate(java.lang.Object entity,
                                  java.lang.Object value)

getCreatedBy

public static java.lang.Object getCreatedBy(java.lang.Object entity)

setCreatedBy

public static void setCreatedBy(java.lang.Object entity,
                                java.lang.Object value)

getLastModifiedDate

public static java.lang.Object getLastModifiedDate(java.lang.Object entity)

setLastModifiedDate

public static void setLastModifiedDate(java.lang.Object entity,
                                       java.lang.Object value)

getLastModifiedBy

public static java.lang.Object getLastModifiedBy(java.lang.Object entity)

setLastModifiedBy

public static void setLastModifiedBy(java.lang.Object entity,
                                     java.lang.Object value)