com.haulmont.chile.core.model.utils

Class InstanceUtils

java.lang.Object

com.haulmont.chile.core.model.utils.InstanceUtils

public final class InstanceUtils
extends java.lang.Object

Utility class to work with Instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InstanceUtils.NamePatternRec

Method Summary

Modifier and Type	Method and Description
static Instance	copy(Instance source) Deprecated.
static void	copy(Instance source, Instance dest) Deprecated.
static java.lang.String	formatValuePath(java.lang.String[] path) Converts an array of identifiers to a dot-separated string, enclosing identifiers, containing dots, in square brackets.
static java.lang.String	getInstanceName(Instance instance)
static <T> T	getValueEx(Instance instance, java.lang.String propertyPath) Get value of an attribute according to the rules described in Instance.getValueEx(String).
static <T> T	getValueEx(Instance instance, java.lang.String[] properties) Get value of an attribute according to the rules described in Instance.getValueEx(String).
static InstanceUtils.NamePatternRec	parseNamePattern(MetaClass metaClass) Parse a name pattern defined by NamePattern annotation.
static java.lang.String[]	parseValuePath(java.lang.String path) Converts a string of identifiers separated by dots to an array.
static boolean	propertyValueEquals(java.lang.Object a, java.lang.Object b) Used by AbstractInstance to check whether property value has been changed.
static void	setValueEx(Instance instance, java.lang.String[] properties, java.lang.Object value) Set value of an attribute according to the rules described in Instance.setValueEx(String, Object).
static void	setValueEx(Instance instance, java.lang.String propertyPath, java.lang.Object value) Set value of an attribute according to the rules described in Instance.setValueEx(String, Object).

Methods inherited from class java.lang.Object

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

Method Detail

parseValuePath

public static java.lang.String[] parseValuePath(@Nullable
                                                java.lang.String path)

Converts a string of identifiers separated by dots to an array. A part of the given string, enclosed in square brackets, treated as single identifier. For example:

     car.driver.name
     [car.field].driver.name
 

Parameters:

path - value path as string

Returns:

value path as array or empty array if the input is null

formatValuePath

public static java.lang.String formatValuePath(java.lang.String[] path)

Converts an array of identifiers to a dot-separated string, enclosing identifiers, containing dots, in square brackets.

Parameters:

path - value path as array

Returns:

value path as string or empty string if the input is null

getValueEx

public static <T> T getValueEx(Instance instance,
                               java.lang.String propertyPath)

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

Parameters:

instance - instance

propertyPath - attribute path

Returns:

attribute value

getValueEx

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

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

Parameters:

instance - instance

properties - path to the attribute

Returns:

attribute value

setValueEx

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

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

Parameters:

instance - instance

propertyPath - path to the attribute

value - attribute value

setValueEx

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

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

Parameters:

instance - instance

properties - path to the attribute

value - attribute value

copy

@Deprecated
public static Instance copy(Instance source)

Deprecated.

Use com.haulmont.cuba.core.global.MetadataTools#copy instead

copy

@Deprecated
public static void copy(Instance source,
                                    Instance dest)

Deprecated.

Use com.haulmont.cuba.core.global.MetadataTools#copy instead

getInstanceName

public static java.lang.String getInstanceName(Instance instance)

Parameters:

instance - instance

Returns:

Instance name as defined by NamePattern or toString().

parseNamePattern

@Nullable
public static InstanceUtils.NamePatternRec parseNamePattern(MetaClass metaClass)

Parse a name pattern defined by NamePattern annotation.

Parameters:

metaClass - entity meta-class

Returns:

record containing the name pattern properties, or null if the @NamePattern is not defined for the meta-class

propertyValueEquals

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

Used by AbstractInstance to check whether 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 AbstractInstance returns true only if a are the same instance as b