org.openmrs.customdatatype.datatype

Class LongFreeTextDatatype

java.lang.Object

org.openmrs.customdatatype.datatype.LongFreeTextDatatype

All Implemented Interfaces:

CustomDatatype<java.lang.String>

@Component
public class LongFreeTextDatatype
extends java.lang.Object
implements CustomDatatype<java.lang.String>

Free-text datatype, represented by a plain String in Java, but stored in the database as a CLOB or similar.

Since:

1.9

Nested Class Summary

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

CustomDatatype.Summary

Constructor Summary

Constructors

Constructor and Description
LongFreeTextDatatype()

Method Summary

Modifier and Type	Method and Description
java.lang.String	fromReferenceString(java.lang.String referenceString) Converts a reference string to its typed value.
java.lang.String	getReferenceStringForValue(java.lang.String typedValue) Gets the reference string that would be persisted for the given typed value.
CustomDatatype.Summary	getTextSummary(java.lang.String referenceString) Converts a reference string to a short (generally < 100 characters) plain-text representation of its value.
java.lang.String	save(java.lang.String typedValue, java.lang.String existingValueReference) The OpenMRS service layer calls this method when a custom value of this datatype is saved (created or edited).
void	setConfiguration(java.lang.String config) A CustomValueDescriptor defines both a datatype and its configuration (e.g.
void	validate(java.lang.String typedValue) Validates the given value to see if it is a legal value for the given handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

LongFreeTextDatatype

public LongFreeTextDatatype()

Method Detail

setConfiguration

public void setConfiguration(java.lang.String config)

Description copied from interface: CustomDatatype

A CustomValueDescriptor defines both a datatype and its configuration (e.g. a regex for a RegexValidatedString datatype). The framework will instantiate datatypes and call this method to set that configuration. Subclasses should define the format of this configuration.

Specified by:

setConfiguration in interface CustomDatatype<java.lang.String>

See Also:

CustomDatatype.setConfiguration(java.lang.String)

save

public java.lang.String save(java.lang.String 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<java.lang.String>

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(java.lang.String 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<java.lang.String>

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)

fromReferenceString

public java.lang.String fromReferenceString(java.lang.String referenceString)
                                     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<java.lang.String>

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)

getTextSummary

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

Description copied from interface: CustomDatatype

Converts a reference string to a short (generally < 100 characters) plain-text representation of its value. The return value also indicates whether this representation is a complete view of the value, or if there is more to display. Implementations of this method must be high-performance, e.g. if the method is called thousands of times for a table of objects with custom values.

Specified by:

getTextSummary in interface CustomDatatype<java.lang.String>

Returns:

a summary representation of the given value

See Also:

CustomDatatype.getTextSummary(java.lang.String)

validate

public void validate(java.lang.String typedValue)
              throws InvalidCustomValueException

Description copied from interface: CustomDatatype

Validates the given value to see if it is a legal value for the given handler. (For example the RegexValidatedText type checks against a regular expression.)

Specified by:

validate in interface CustomDatatype<java.lang.String>

Throws:

InvalidCustomValueException

See Also:

CustomDatatype.validate(java.lang.Object)