org.openmrs.customdatatype

Class SerializingCustomDatatype<T>

java.lang.Object

org.openmrs.customdatatype.SerializingCustomDatatype<T>

All Implemented Interfaces:

CustomDatatype<T>

Direct Known Subclasses:

BooleanDatatype, DateDatatype, FreeTextDatatype, RegexValidatedTextDatatype

public abstract class SerializingCustomDatatype<T>
extends java.lang.Object
implements CustomDatatype<T>

Nested Class Summary

Nested classes/interfaces inherited from interface org.openmrs.customdatatype.CustomDatatype

CustomDatatype.Summary

Constructor Summary

Constructors

Constructor and Description
SerializingCustomDatatype()

Method Summary

Modifier and Type	Method and Description
abstract T	deserialize(java.lang.String serializedValue)
CustomDatatype.Summary	doGetTextSummary(T typedValue) Most implementations should override this method to return plain-text summary of the typed value, as defined by CustomDatatype.getTextSummary(String).
T	fromReferenceString(java.lang.String persistedValue) Converts a reference string to its typed value.
java.lang.String	getReferenceStringForValue(T typedValue) Gets the reference string that would be persisted for the given typed value.
CustomDatatype.Summary	getTextSummary(java.lang.String referenceString) Default implementation calls doGetTextSummary(Object).
java.lang.String	save(T typedValue, java.lang.String existingValueReference) The OpenMRS service layer calls this method when a custom value of this datatype is saved (created or edited).
abstract java.lang.String	serialize(T typedValue)
void	setConfiguration(java.lang.String config) Does nothing in the default implementation
void	validate(T typedValue) Passes for all non-null values in the default implementation

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializingCustomDatatype

public SerializingCustomDatatype()

Method Detail

serialize

public abstract java.lang.String serialize(T typedValue)

Parameters:

typedValue - (has already had validate called)

Returns:

a String representation of typedValue

deserialize

public abstract T deserialize(java.lang.String serializedValue)

Parameters:

serializedValue -

Returns:

the reconstructed typed version of serializedValue

doGetTextSummary

public CustomDatatype.Summary doGetTextSummary(T typedValue)

Most implementations should override this method to return plain-text summary of the typed value, as defined by CustomDatatype.getTextSummary(String). If deserialize(String) is expensive, then the implementation should override getTextSummary(String) instead. The default implementation returns typedValue.toString(), and indicates it is complete.

Parameters:

typedValue -

Returns:

a plain-text summary of the typed value

setConfiguration

public void setConfiguration(java.lang.String config)

Does nothing in the default implementation

Specified by:

setConfiguration in interface CustomDatatype<T>

See Also:

CustomDatatype.setConfiguration(java.lang.String)

validate

public void validate(T typedValue)
              throws InvalidCustomValueException

Passes for all non-null values in the default implementation

Specified by:

validate in interface CustomDatatype<T>

Throws:

InvalidCustomValueException

See Also:

CustomDatatype.validate(java.lang.Object)

fromReferenceString

public T fromReferenceString(java.lang.String persistedValue)
                      throws InvalidCustomValueException

Description copied from interface: CustomDatatype

Converts a reference string to its typed value. This may be expensive, especially if the datatype needs to go to remote storage.

Specified by:

fromReferenceString in interface CustomDatatype<T>

Returns:

the actual typed value for the given referenceString

Throws:

InvalidCustomValueException - if the persisted value is illegal (perhaps because datatype configuration was changed since this value was persisted)

See Also:

CustomDatatype.fromReferenceString(java.lang.String)

save

public java.lang.String save(T typedValue,
                             java.lang.String existingValueReference)
                      throws InvalidCustomValueException

Description copied from interface: CustomDatatype

The OpenMRS service layer calls this method when a custom value of this datatype is saved (created or edited). Implementations should persist the typed value, and return a valueReference that can be used to access that value in the future. (Simple datatype implementations that don't require external storage may just serialize their typedValue to a String and return that.) Implementations may safely assume that validate was called on typedValue before this method is called.

Specified by:

save in interface CustomDatatype<T>

existingValueReference - If null, the custom value is being saved for the first time. If not null, this custom value has been saved before with the given reference. Implementations may choose to return the same value reference if they are overwriting the old value on remote storage.

Returns:

a valueReference that may be used in the future to retrieve typedValue

Throws:

InvalidCustomValueException

See Also:

CustomDatatype.save(java.lang.Object, java.lang.String)

getReferenceStringForValue

public java.lang.String getReferenceStringForValue(T typedValue)
                                            throws java.lang.UnsupportedOperationException

Description copied from interface: CustomDatatype

Gets the reference string that would be persisted for the given typed value. (This allows efficient searching for exact attribute values.)

Specified by:

getReferenceStringForValue in interface CustomDatatype<T>

Returns:

Throws:

java.lang.UnsupportedOperationException - if it is not feasible to calculate this efficiently (e.g. you'd need to go to remote storage)

See Also:

CustomDatatype.getReferenceStringForValue(java.lang.Object)

getTextSummary

public CustomDatatype.Summary getTextSummary(java.lang.String referenceString)

Default implementation calls doGetTextSummary(Object). Most implementations should override that other method, but if deserialize(String) is expensive, then you should override this method instead.

Specified by:

getTextSummary in interface CustomDatatype<T>

Returns:

a summary representation of the given value

See Also:

CustomDatatype.getTextSummary(java.lang.String)