org.openmrs

Class GlobalProperty

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.GlobalProperty

All Implemented Interfaces:

java.io.Serializable, CustomValueDescriptor, SingleCustomValue<GlobalProperty>, OpenmrsObject

public class GlobalProperty
extends BaseOpenmrsObject
implements CustomValueDescriptor, SingleCustomValue<GlobalProperty>

Global properties are simple key-value pairs persisted in the database GPs can be thought of as something similar to environment variables used in operating systems.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GlobalProperty() Default empty constructor
GlobalProperty(java.lang.String property) Constructor defining the key for this GP
GlobalProperty(java.lang.String property, java.lang.String value) Constructor defining the key and value of this GP
GlobalProperty(java.lang.String property, java.lang.String value, java.lang.String description) Constructor defining key/value/description for this GP
GlobalProperty(java.lang.String property, java.lang.String value, java.lang.String description, java.lang.Class<? extends CustomDatatype<?>> datatypeClass, java.lang.String datatypeConfig) Constructor defining key/value/description/customDatatype/datatypeConfig

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDatatypeClassname() Return the name of a class that implements CustomDatatype.
java.lang.String	getDatatypeConfig() May be null.
java.lang.String	getDescription()
GlobalProperty	getDescriptor() The metadata describing this custom value
java.lang.String	getHandlerConfig() May be null.
java.lang.Integer	getId()
java.lang.String	getPreferredHandlerClassname() May be null.
java.lang.String	getProperty()
java.lang.String	getPropertyValue()
java.lang.Object	getValue() Convenience method to get the typed version of the serializedValue.
java.lang.String	getValueReference()
boolean	isDirty()
void	setDatatypeClassname(java.lang.String datatypeClassname)
void	setDatatypeConfig(java.lang.String datatypeConfig)
void	setDescription(java.lang.String description)
void	setHandlerConfig(java.lang.String handlerConfig)
void	setId(java.lang.Integer id)
void	setPreferredHandlerClassname(java.lang.String preferredHandlerClassname)
void	setProperty(java.lang.String property)
void	setPropertyValue(java.lang.String propertyValue)
<T> void	setValue(T typedValue) Sets the typed value.
void	setValueReferenceInternal(java.lang.String valueToPersist) Directly set the String value that OpenMRS should persist in the database in a varchar column.
java.lang.String	toString() Returns a string consisting of the name of the class of which the object is an instance and the uuid field surrounded by [ and ].

Methods inherited from class org.openmrs.BaseOpenmrsObject

equals, getUuid, hashCode, setUuid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GlobalProperty

public GlobalProperty()

Default empty constructor

GlobalProperty

public GlobalProperty(java.lang.String property)

Constructor defining the key for this GP

Parameters:

property - key to name the property

GlobalProperty

public GlobalProperty(java.lang.String property,
                      java.lang.String value)

Constructor defining the key and value of this GP

Parameters:

property - key to name the property

value - value to give to the property

GlobalProperty

public GlobalProperty(java.lang.String property,
                      java.lang.String value,
                      java.lang.String description)

Constructor defining key/value/description for this GP

Parameters:

property - key to name the property

value - value to give to the property

description - description of how this property is used

GlobalProperty

public GlobalProperty(java.lang.String property,
                      java.lang.String value,
                      java.lang.String description,
                      java.lang.Class<? extends CustomDatatype<?>> datatypeClass,
                      java.lang.String datatypeConfig)

Constructor defining key/value/description/customDatatype/datatypeConfig

Parameters:

property -

value -

description -

datatypeClass -

datatypeConfig -

Since:

1.9

Method Detail

getProperty

public java.lang.String getProperty()

Returns:

Returns the property.

setProperty

public void setProperty(java.lang.String property)

Parameters:

property - The property to set.

getPropertyValue

public java.lang.String getPropertyValue()

Returns:

Returns the propertyValue.

setPropertyValue

public void setPropertyValue(java.lang.String propertyValue)

Parameters:

propertyValue - The propertyValue to set.

getDescription

public java.lang.String getDescription()

Returns:

the description

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - the description to set

getId

public java.lang.Integer getId()

Specified by:

getId in interface OpenmrsObject

Returns:

id - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.getId()

setId

public void setId(java.lang.Integer id)

Specified by:

setId in interface OpenmrsObject

Parameters:

id - - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.setId(java.lang.Integer)

getDatatypeClassname

public java.lang.String getDatatypeClassname()

Description copied from interface: CustomValueDescriptor

Return the name of a class that implements CustomDatatype.

Specified by:

getDatatypeClassname in interface CustomValueDescriptor

Returns:

the datatype used to store this custom value

Since:

1.9

See Also:

CustomValueDescriptor.getDatatypeClassname()

setDatatypeClassname

public void setDatatypeClassname(java.lang.String datatypeClassname)

Parameters:

datatypeClassname - the datatypeClassname to set

Since:

1.9

getDatatypeConfig

public java.lang.String getDatatypeConfig()

Description copied from interface: CustomValueDescriptor

May be null.

Specified by:

getDatatypeConfig in interface CustomValueDescriptor

Returns:

the configuration to be passed to the datatype. For example if the datatype is RegexValidatedString the datatypeConfig would be the regular expression

Since:

1.9

See Also:

CustomValueDescriptor.getDatatypeConfig()

setDatatypeConfig

public void setDatatypeConfig(java.lang.String datatypeConfig)

Parameters:

datatypeConfig - the datatypeConfig to set

Since:

1.9

getPreferredHandlerClassname

public java.lang.String getPreferredHandlerClassname()

Description copied from interface: CustomValueDescriptor

May be null.

Specified by:

getPreferredHandlerClassname in interface CustomValueDescriptor

Returns:

the fully-qualified classname of the preferred CustomDatatypeHandler chosen by the system administrator for this attribute type.

Since:

1.9

See Also:

CustomValueDescriptor.getPreferredHandlerClassname()

setPreferredHandlerClassname

public void setPreferredHandlerClassname(java.lang.String preferredHandlerClassname)

Parameters:

preferredHandlerClassname - the preferredHandlerClassname to set

Since:

1.9

getHandlerConfig

public java.lang.String getHandlerConfig()

Description copied from interface: CustomValueDescriptor

May be null.

Specified by:

getHandlerConfig in interface CustomValueDescriptor

Returns:

the configuration to be passed to the handler for a datatype. For example if the datatype is "regex-validated-string", the handlerConfig would be the regular expression.

Since:

1.9

See Also:

CustomValueDescriptor.getHandlerConfig()

setHandlerConfig

public void setHandlerConfig(java.lang.String handlerConfig)

Parameters:

handlerConfig - the handlerConfig to set

Since:

1.9

toString

public java.lang.String toString()

Description copied from class: BaseOpenmrsObject

Returns a string consisting of the name of the class of which the object is an instance and the uuid field surrounded by [ and ]. In other words, this method returns a string equal to the value of:

 getClass().getName() + '[' + uuid + ']'
 

If the uuid field is null, it delegates to Object.toString()

Overrides:

toString in class BaseOpenmrsObject

See Also:

Object.toString()

getDescriptor

public GlobalProperty getDescriptor()

Description copied from interface: SingleCustomValue

The metadata describing this custom value

Specified by:

getDescriptor in interface SingleCustomValue<GlobalProperty>

Returns:

Since:

1.9

See Also:

SingleCustomValue.getDescriptor()

getValueReference

public java.lang.String getValueReference()

Specified by:

getValueReference in interface SingleCustomValue<GlobalProperty>

Returns:

the value persisted in a database in a varchar column. Not necessarily human-readable.

Since:

1.9

See Also:

SingleCustomValue.getValueReference()

setValueReferenceInternal

public void setValueReferenceInternal(java.lang.String valueToPersist)
                               throws InvalidCustomValueException

Description copied from interface: SingleCustomValue

Directly set the String value that OpenMRS should persist in the database in a varchar column. Implementations should validate this value and throw an InvalidCustomValueException if it's invalid, rather than setting it blindly. If you are coding against the OpenMRS API, you should use SingleCustomValue.setValue(Object) instead.

Specified by:

setValueReferenceInternal in interface SingleCustomValue<GlobalProperty>

Throws:

InvalidCustomValueException

Since:

1.9

See Also:

SingleCustomValue.setValueReferenceInternal(java.lang.String)

getValue

public java.lang.Object getValue()
                          throws InvalidCustomValueException

Description copied from interface: SingleCustomValue

Convenience method to get the typed version of the serializedValue. (This will result in a call to a CustomDatatype.fromReferenceString(String).)

Specified by:

getValue in interface SingleCustomValue<GlobalProperty>

Returns:

typed value, converted from serializedValue by a CustomDatatype

Throws:

InvalidCustomValueException

Since:

1.9

See Also:

SingleCustomValue.getValue()

setValue

public <T> void setValue(T typedValue)
                  throws InvalidCustomValueException

Description copied from interface: SingleCustomValue

Sets the typed value. (This will result in a call to CustomDatatype#toReferenceString(Object)

Specified by:

setValue in interface SingleCustomValue<GlobalProperty>

Throws:

InvalidCustomValueException

Since:

1.9

See Also:

SingleCustomValue.setValue(java.lang.Object)

isDirty

public boolean isDirty()

Specified by:

isDirty in interface SingleCustomValue<GlobalProperty>

Returns:

whether or not setValue has been called (thus CustomDatatype.save(Object, String) needs to be called

See Also:

SingleCustomValue.isDirty()