Package org.openremote.model.util

Class ValueUtil

java.lang.Object

org.openremote.model.util.ValueUtil

public class ValueUtil
extends Object

Utilities for working with values/JSON and asset model

Custom descriptors can be added by simply adding new Asset/Agent sub types and following the discovery rules described in StandardModelProvider; alternatively a custom AssetModelProvider implementation can be created and discovered with the ServiceLoader or manually added to this class via getModelProviders() collection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ValueUtil.ClassHierarchyComparator	Copied from: https://puredanger.github.io/tech.puredanger.com/2006/11/29/writing-a-class-hierarchy-comparator
static interface	ValueUtil.ConstraintViolationPathProvider	A FunctionalInterface for populating the ConstraintViolation.getPropertyPath() for the value being validated (e.g.

Field Summary

Fields

Modifier and Type	Field	Description
protected static Map<String,Class<? extends AgentLink<?>>>	agentTypeMap
protected static Map<String,AssetTypeInfo>	assetInfoMap
protected static List<AssetModelProvider>	assetModelProviders
protected static Map<String,Class<? extends Asset<?>>>	assetTypeMap
protected static com.kjetland.jackson.jsonSchema.JsonSchemaGenerator	generator
static com.fasterxml.jackson.databind.ObjectMapper	JSON
static Logger	LOG
protected static Map<String,MetaItemDescriptor<?>>	metaItemDescriptors
static final String	NULL_LITERAL
protected static jakarta.validation.Validator	validator
protected static Map<String,ValueDescriptor<?>>	valueDescriptors

Constructor Summary

Constructors

Constructor	Description
ValueUtil()

Method Summary

Modifier and Type	Method	Description
static Object	applyValueFilters(Object value, ValueFilter... filters)	Apply the specified set of ValueFilters to the specified value
static Optional<String>	asJSON(Object object)
static String	asJSONOrThrow(Object object)
protected static AssetTypeInfo	buildAssetInfoFromClass(Class<? extends Asset<?>> assetClass, Map<String,List<NameHolder>> classDescriptorMap)
protected static AssetTypeInfo	buildAssetInfoFromName(String name, Map<String,List<NameHolder>> classDescriptorMap)
static byte[]	bytesFromBinaryString(String binary)
static byte[]	bytesFromHexString(String hex)
static String	bytesToBinaryString(byte[] bytes)
static String	bytesToHexString(byte[] bytes)
static <T> T	clone(T object)
static com.fasterxml.jackson.databind.ObjectMapper	configureObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
static <T> T	convert(Object object, Class<T> targetType)
static <T> Predicate<T>	distinctByKey(Function<? super T,?> keyExtractor)
static String	doDynamicTimeReplace(String str, Instant instant)
static String	doDynamicValueReplace(String str, Object value)
protected static void	doSchemaInit()
static Object	findFirstNonNullElement(Collection<?> collection)
static Map.Entry<?,?>	findFirstNonNullEntry(Map<?,?> map)
static <T extends Agent<T, ?, ?>> Optional<AgentDescriptor<T,?,?>>	getAgentDescriptor(Class<T> agentType)
static Optional<AgentDescriptor<?,?,?>>	getAgentDescriptor(String agentType)
protected static Class<?>[]	getAgentLinkClasses()
static Class<?>	getArrayClass(Class<?> componentType)
static Optional<Class<? extends Asset<?>>>	getAssetClass(String assetType)
static Class<? extends Asset<?>>[]	getAssetClasses(String parentType)
protected static Set<Class<? extends Asset<?>>>	getAssetClasses(AssetModelProvider assetModelProvider)
static <T extends Asset<?>> Optional<AssetDescriptor<T>>	getAssetDescriptor(Class<T> assetType)
static Optional<AssetDescriptor<?>>	getAssetDescriptor(String assetType)
static AssetDescriptor<?>[]	getAssetDescriptors(String parentType)
static <T extends Asset<?>> Optional<AssetTypeInfo>	getAssetInfo(Class<T> assetType)
static Optional<AssetTypeInfo>	getAssetInfo(String assetType)
static AssetTypeInfo[]	getAssetInfos(String parentType)
static Optional<Boolean>	getBoolean(Object value)
static Optional<Boolean>	getBooleanCoerced(Object value)
protected static List<NameHolder>	getDescriptorFields(Class<?> type)	Extract public static field values that are of type AssetDescriptor, AttributeDescriptor, MetaItemDescriptor or ValueDescriptor.
static Optional<Double>	getDouble(Object value)
static Optional<Double>	getDoubleCoerced(Object value)
static Optional<Integer>	getInteger(Object value)
static Optional<Integer>	getIntegerCoerced(Object value)
static Optional<Long>	getLong(Object value)
static Optional<Long>	getLongCoerced(Object value)
static Optional<MetaItemDescriptor<?>>	getMetaItemDescriptor(String name)
static Map<String,MetaItemDescriptor<?>>	getMetaItemDescriptors()
static <T extends Asset<?>> Optional<MetaItemDescriptor<?>[]>	getMetaItemDescriptors(Class<T> assetType)
static Optional<MetaItemDescriptor<?>[]>	getMetaItemDescriptors(String assetType)
static List<AssetModelProvider>	getModelProviders()
static Object	getObjectFieldValue(Object object, Field field)
static Object	getObjectFieldValue(Object object, String fieldName)
static Object[]	getObjectFieldValues(Object object, Field[] fields)
static Object[]	getObjectFieldValues(Object object, String[] fieldNames)
static <T> com.fasterxml.jackson.core.type.TypeReference<Attribute<T>>	getRef(Class<T> clazz)
static com.fasterxml.jackson.databind.JsonNode	getSchema(Class<?> clazz)	Returns the schema for the specified type
static Optional<String>	getString(Object value)
static Optional<String>	getStringCoerced(Object value)
static jakarta.validation.Validator	getValidator()
static <T> Optional<T>	getValue(Object value, Class<T> type)
static <T> Optional<T>	getValue(Object value, Class<T> type, boolean coerce)
static <T> Optional<T>	getValueCoerced(Object value, Class<T> type)	Basic type coercion/casting of values; utilises Jackson's underlying type coercion/casting mechanism
static Optional<ValueDescriptor<?>>	getValueDescriptor(String name)
static ValueDescriptor<?>	getValueDescriptorForValue(Object value)
static Map<String,ValueDescriptor<?>>	getValueDescriptors()
static <T extends Asset<?>> Optional<ValueDescriptor<?>[]>	getValueDescriptors(Class<T> assetType)
static Optional<ValueDescriptor<?>[]>	getValueDescriptors(String assetType)
static void	initialise(Container container)
static void	initialiseAssetAttributes(Asset<?> asset)
static boolean	isArray(Class<?> clazz)
static boolean	isBoolean(Class<?> clazz)
static boolean	isCollection(Class<?> clazz)
protected static boolean	isGetter(Method method)
static boolean	isMap(Class<?> clazz)
static boolean	isNumber(Class<?> clazz)
static boolean	isObject(Class<?> clazz)
static boolean	isString(Class<?> clazz)
static boolean	objectsEquals(Object a, Object b)
static boolean	objectsEqualsUsingJSON(Object a, Object b)
static boolean	objectsEqualsWithJSONFallback(Object a, Object b)
static Optional<Object>	parse(String jsonString)
static <T> Optional<T>	parse(String jsonString, com.fasterxml.jackson.core.type.TypeReference<T> type)
static <T> Optional<T>	parse(String jsonString, Class<T> type)
static <T> Optional<T>	parse(String jsonString, Type type)
static <T> Set<jakarta.validation.ConstraintViolation<T>>	validate(T obj, Class<?>... groups)	Validates the supplied object using standard JSR-380 bean validation; therefore any type passed in here must follow the JSR-380 annotation requirements.
static boolean	validateValue(AttributeDescriptor<?> attributeDescriptor, ValueDescriptor<?> valueDescriptor, MetaHolder metaHolder, Instant now, jakarta.validation.ConstraintValidatorContext context, ValueUtil.ConstraintViolationPathProvider constraintBuilderProvider, Object value)	Evaluate the validity of a value dynamically by extracting ValueConstraints from the supplied parameters; each found constraint is then evaluated against the value supplied to the function.
static boolean	validateValueConstraint(jakarta.validation.ConstraintValidatorContext context, ValueUtil.ConstraintViolationPathProvider constraintViolationPathProvider, Instant now, ValueConstraint valueConstraint, Object value)

Methods inherited from class java.lang.Object

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

Field Details

LOG

public static Logger LOG

JSON

public static com.fasterxml.jackson.databind.ObjectMapper JSON

assetModelProviders

protected static List<AssetModelProvider> assetModelProviders

assetInfoMap

protected static Map<String,AssetTypeInfo> assetInfoMap

assetTypeMap

protected static Map<String,Class<? extends Asset<?>>> assetTypeMap

agentTypeMap

protected static Map<String,Class<? extends AgentLink<?>>> agentTypeMap

metaItemDescriptors

protected static Map<String,MetaItemDescriptor<?>> metaItemDescriptors

valueDescriptors

protected static Map<String,ValueDescriptor<?>> valueDescriptors

validator

protected static jakarta.validation.Validator validator

generator

protected static com.kjetland.jackson.jsonSchema.JsonSchemaGenerator generator

NULL_LITERAL

public static final String NULL_LITERAL

See Also:

• Constant Field Values

Constructor Details

ValueUtil

public ValueUtil()

Method Details

configureObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper configureObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

parse

public static Optional<Object> parse(String jsonString)

parse

public static <T> Optional<T> parse(String jsonString,
 Type type)

parse

public static <T> Optional<T> parse(String jsonString,
 com.fasterxml.jackson.core.type.TypeReference<T> type)

parse

public static <T> Optional<T> parse(String jsonString,
 Class<T> type)

asJSON

public static Optional<String> asJSON(Object object)

asJSONOrThrow

public static String asJSONOrThrow(Object object)
                            throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getValue

public static <T> Optional<T> getValue(Object value,
 Class<T> type,
 boolean coerce)

getValue

public static <T> Optional<T> getValue(Object value,
 Class<T> type)

getValueCoerced

public static <T> Optional<T> getValueCoerced(Object value,
 Class<T> type)

Basic type coercion/casting of values; utilises Jackson's underlying type coercion/casting mechanism

getString

public static Optional<String> getString(Object value)

getStringCoerced

public static Optional<String> getStringCoerced(Object value)

getBoolean

public static Optional<Boolean> getBoolean(Object value)

getBooleanCoerced

public static Optional<Boolean> getBooleanCoerced(Object value)

getInteger

public static Optional<Integer> getInteger(Object value)

getIntegerCoerced

public static Optional<Integer> getIntegerCoerced(Object value)

getDouble

public static Optional<Double> getDouble(Object value)

getDoubleCoerced

public static Optional<Double> getDoubleCoerced(Object value)

getLong

public static Optional<Long> getLong(Object value)

getLongCoerced

public static Optional<Long> getLongCoerced(Object value)

distinctByKey

public static <T> Predicate<T> distinctByKey(Function<? super T,?> keyExtractor)

convert

public static <T> T convert(Object object,
 Class<T> targetType)

isArray

public static boolean isArray(Class<?> clazz)

isBoolean

public static boolean isBoolean(Class<?> clazz)

isNumber

public static boolean isNumber(Class<?> clazz)

isString

public static boolean isString(Class<?> clazz)

isMap

public static boolean isMap(Class<?> clazz)

isCollection

public static boolean isCollection(Class<?> clazz)

isObject

public static boolean isObject(Class<?> clazz)

getArrayClass

public static Class<?> getArrayClass(Class<?> componentType)
                              throws ClassNotFoundException

Throws:

ClassNotFoundException

applyValueFilters

public static Object applyValueFilters(Object value,
 ValueFilter... filters)

Apply the specified set of ValueFilters to the specified value

clone

public static <T> T clone(T object)

getRef

public static <T>
com.fasterxml.jackson.core.type.TypeReference<Attribute<T>> getRef(Class<T> clazz)

findFirstNonNullElement

public static Object findFirstNonNullElement(Collection<?> collection)

findFirstNonNullEntry

public static Map.Entry<?,?> findFirstNonNullEntry(Map<?,?> map)

getAssetInfos

public static AssetTypeInfo[] getAssetInfos(String parentType)

getAssetClasses

public static Class<? extends Asset<?>>[] getAssetClasses(String parentType)

getAssetClass

public static Optional<Class<? extends Asset<?>>> getAssetClass(String assetType)

getAssetInfo

public static <T extends Asset<?>>
Optional<AssetTypeInfo> getAssetInfo(Class<T> assetType)

getAssetInfo

public static Optional<AssetTypeInfo> getAssetInfo(String assetType)

getAssetDescriptors

public static AssetDescriptor<?>[] getAssetDescriptors(String parentType)

getAssetDescriptor

public static <T extends Asset<?>>
Optional<AssetDescriptor<T>> getAssetDescriptor(Class<T> assetType)

getAssetDescriptor

public static Optional<AssetDescriptor<?>> getAssetDescriptor(String assetType)

getAgentDescriptor

public static <T extends Agent<T,
?,
?>>
Optional<AgentDescriptor<T,?,?>> getAgentDescriptor(Class<T> agentType)

getAgentDescriptor

public static Optional<AgentDescriptor<?,?,?>> getAgentDescriptor(String agentType)

getMetaItemDescriptors

public static Map<String,MetaItemDescriptor<?>> getMetaItemDescriptors()

getMetaItemDescriptors

public static <T extends Asset<?>>
Optional<MetaItemDescriptor<?>[]> getMetaItemDescriptors(Class<T> assetType)

getMetaItemDescriptors

public static Optional<MetaItemDescriptor<?>[]> getMetaItemDescriptors(String assetType)

getMetaItemDescriptor

public static Optional<MetaItemDescriptor<?>> getMetaItemDescriptor(String name)

getValueDescriptors

public static Map<String,ValueDescriptor<?>> getValueDescriptors()

getValueDescriptors

public static <T extends Asset<?>>
Optional<ValueDescriptor<?>[]> getValueDescriptors(Class<T> assetType)

getValueDescriptors

public static Optional<ValueDescriptor<?>[]> getValueDescriptors(String assetType)

getValueDescriptor

public static Optional<ValueDescriptor<?>> getValueDescriptor(String name)

getValueDescriptorForValue

public static ValueDescriptor<?> getValueDescriptorForValue(Object value)

getModelProviders

public static List<AssetModelProvider> getModelProviders()

initialise

public static void initialise(Container container)
                       throws IllegalStateException

Throws:

IllegalStateException

doSchemaInit

protected static void doSchemaInit()

getAgentLinkClasses

protected static Class<?>[] getAgentLinkClasses()

validate

public static <T>
Set<jakarta.validation.ConstraintViolation<T>> validate(@NotNull
 T obj,
 Class<?>... groups)

Validates the supplied object using standard JSR-380 bean validation; therefore any type passed in here must follow the JSR-380 annotation requirements.

getValidator

public static jakarta.validation.Validator getValidator()

validateValue

public static boolean validateValue(AttributeDescriptor<?> attributeDescriptor,
 ValueDescriptor<?> valueDescriptor,
 MetaHolder metaHolder,
 Instant now,
 jakarta.validation.ConstraintValidatorContext context,
 ValueUtil.ConstraintViolationPathProvider constraintBuilderProvider,
 Object value)

Evaluate the validity of a value dynamically by extracting ValueConstraints from the supplied parameters; each found constraint is then evaluated against the value supplied to the function.

Unfortunately JSR-380 can't be used (even Hibernate validator's programmatic API) because validators are type centric but here the type (e.g. Attribute or AttributeInfo) is fixed but the constraints to be applied are dynamic, would be nice if there was a solution to this problem but this works for now.

validateValueConstraint

public static boolean validateValueConstraint(jakarta.validation.ConstraintValidatorContext context,
 ValueUtil.ConstraintViolationPathProvider constraintViolationPathProvider,
 Instant now,
 ValueConstraint valueConstraint,
 Object value)

getSchema

public static com.fasterxml.jackson.databind.JsonNode getSchema(Class<?> clazz)

Returns the schema for the specified type

initialiseAssetAttributes

public static void initialiseAssetAttributes(Asset<?> asset)
                                      throws IllegalStateException

Throws:

IllegalStateException

getObjectFieldValues

public static Object[] getObjectFieldValues(Object object,
 String[] fieldNames)

getObjectFieldValues

public static Object[] getObjectFieldValues(Object object,
 Field[] fields)

getObjectFieldValue

public static Object getObjectFieldValue(Object object,
 String fieldName)

getObjectFieldValue

public static Object getObjectFieldValue(Object object,
 Field field)

objectsEquals

public static boolean objectsEquals(Object a,
 Object b)

objectsEqualsWithJSONFallback

public static boolean objectsEqualsWithJSONFallback(Object a,
 Object b)

objectsEqualsUsingJSON

public static boolean objectsEqualsUsingJSON(Object a,
 Object b)

isGetter

protected static boolean isGetter(Method method)

getAssetClasses

protected static Set<Class<? extends Asset<?>>> getAssetClasses(AssetModelProvider assetModelProvider)

getDescriptorFields

protected static List<NameHolder> getDescriptorFields(Class<?> type)

Extract public static field values that are of type AssetDescriptor, AttributeDescriptor, MetaItemDescriptor or ValueDescriptor.

buildAssetInfoFromName

protected static AssetTypeInfo buildAssetInfoFromName(String name,
 Map<String,List<NameHolder>> classDescriptorMap)
                                               throws IllegalStateException

Throws:

IllegalStateException

buildAssetInfoFromClass

protected static AssetTypeInfo buildAssetInfoFromClass(Class<? extends Asset<?>> assetClass,
 Map<String,List<NameHolder>> classDescriptorMap)
                                                throws IllegalStateException

Throws:

IllegalStateException

bytesToHexString

public static String bytesToHexString(byte[] bytes)

bytesFromHexString

public static byte[] bytesFromHexString(String hex)

bytesToBinaryString

public static String bytesToBinaryString(byte[] bytes)

bytesFromBinaryString

public static byte[] bytesFromBinaryString(String binary)

doDynamicTimeReplace

public static String doDynamicTimeReplace(String str,
 Instant instant)

doDynamicValueReplace

public static String doDynamicValueReplace(String str,
 Object value)