org.openmrs.customdatatype

Class CustomDatatypeUtil

java.lang.Object

org.openmrs.customdatatype.CustomDatatypeUtil

public class CustomDatatypeUtil
extends java.lang.Object

Helper methods for dealing with custom datatypes and their handlers

Since:

1.9

Constructor Summary

Constructors

Constructor and Description
CustomDatatypeUtil()

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.String>	deserializeSimpleConfiguration(java.lang.String serializedConfig) Deserializes a simple String-based configuration from the serialized form used by serializeSimpleConfiguration Utility method for AttributeHandlers that have property-style configuration.
static CustomDatatype<?>	getDatatype(CustomValueDescriptor descriptor)
static CustomDatatype<?>	getDatatype(java.lang.String datatypeClassname, java.lang.String datatypeConfig)
static java.util.List<java.lang.String>	getDatatypeClassnames()
static CustomDatatype<?>	getDatatypeOrDefault(CustomValueDescriptor descriptor)
static CustomDatatypeHandler	getHandler(CustomDatatype<?> dt, java.lang.String preferredHandlerClassname, java.lang.String handlerConfig)
static CustomDatatypeHandler	getHandler(CustomValueDescriptor descriptor)
static java.util.List<java.lang.String>	getHandlerClassnames()
static <T extends AttributeType<?>,U> java.util.Map<T,java.lang.String>	getValueReferences(java.util.Map<T,U> datatypeValues) Uses the appropriate datatypes to convert all values in the input map to their valueReference equivalents.
static boolean	isCompatibleHandler(CustomDatatypeHandler handler, CustomDatatype<?> datatype)
static void	saveAttributesIfNecessary(Customizable<?> customizable) To be called by service save methods for customizable implementations.
static void	saveIfDirty(SingleCustomValue<?> value) Calls the save method on value's ConceptDatatype if necessary
static java.lang.String	serializeSimpleConfiguration(java.util.Map<java.lang.String,java.lang.String> simpleConfig) Converts a simple String-based configuration to a serialized form.
static <T,D extends CustomValueDescriptor> boolean	validate(SingleCustomValue<D> value) Validates a SingleCustomValue

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomDatatypeUtil

public CustomDatatypeUtil()

Method Detail

getDatatype

public static CustomDatatype<?> getDatatype(CustomValueDescriptor descriptor)

Parameters:

descriptor -

Returns:

a configured datatype appropriate for descriptor

getDatatype

public static CustomDatatype<?> getDatatype(java.lang.String datatypeClassname,
                                            java.lang.String datatypeConfig)

Parameters:

datatypeClassname -

datatypeConfig -

Returns:

a configured datatype with the given classname and configuration

getDatatypeOrDefault

public static CustomDatatype<?> getDatatypeOrDefault(CustomValueDescriptor descriptor)

Parameters:

descriptor -

Returns:

a configured datatype appropriate for descriptor

getHandler

public static CustomDatatypeHandler getHandler(CustomValueDescriptor descriptor)

Parameters:

descriptor -

Returns:

a configured datatype handler appropriate for descriptor

getHandler

public static CustomDatatypeHandler getHandler(CustomDatatype<?> dt,
                                               java.lang.String preferredHandlerClassname,
                                               java.lang.String handlerConfig)

Parameters:

dt - the datatype that this handler should be for

preferredHandlerClassname -

handlerConfig -

Returns:

a configured datatype handler with the given classname and configuration

serializeSimpleConfiguration

public static java.lang.String serializeSimpleConfiguration(java.util.Map<java.lang.String,java.lang.String> simpleConfig)

Converts a simple String-based configuration to a serialized form. Utility method for AttributeHandlers that have property-style configuration.

Parameters:

simpleConfig -

Returns:

deserializeSimpleConfiguration

public static java.util.Map<java.lang.String,java.lang.String> deserializeSimpleConfiguration(java.lang.String serializedConfig)

Deserializes a simple String-based configuration from the serialized form used by serializeSimpleConfiguration Utility method for AttributeHandlers that have property-style configuration.

Parameters:

serializedConfig -

Returns:

getValueReferences

public static <T extends AttributeType<?>,U> java.util.Map<T,java.lang.String> getValueReferences(java.util.Map<T,U> datatypeValues)

Uses the appropriate datatypes to convert all values in the input map to their valueReference equivalents. This is a convenience method for calling XyzService.getXyz(..., attributeValues, ...).

Parameters:

datatypeValues -

Returns:

a map similar to the input parameter, but with typed values converted to their reference equivalents

getDatatypeClassnames

public static java.util.List<java.lang.String> getDatatypeClassnames()

Returns:

fully-qualified classnames of all registered datatypes

getHandlerClassnames

public static java.util.List<java.lang.String> getHandlerClassnames()

Returns:

full-qualified classnames of all registered handlers

isCompatibleHandler

public static boolean isCompatibleHandler(CustomDatatypeHandler handler,
                                          CustomDatatype<?> datatype)

Parameters:

handler -

datatype -

Returns:

whether or not handler is compatible with datatype

saveAttributesIfNecessary

public static void saveAttributesIfNecessary(Customizable<?> customizable)

To be called by service save methods for customizable implementations. Iterates over all attributes and calls save on the ConceptDatatype for any dirty ones.

Parameters:

customizable -

saveIfDirty

public static void saveIfDirty(SingleCustomValue<?> value)

Calls the save method on value's ConceptDatatype if necessary

Parameters:

value -

validate

public static <T,D extends CustomValueDescriptor> boolean validate(SingleCustomValue<D> value)

Validates a SingleCustomValue

Parameters:

value -

Returns:

true is value is valid, according to its configured datatype