org.openmrs.attribute

Class BaseAttribute<AT extends AttributeType,OwningType extends Customizable<?>>

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.attribute.BaseAttribute<AT,OwningType>

Type Parameters:

AT -

OwningType -

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Attribute>, Attribute<AT,OwningType>, Auditable, SingleCustomValue<AT>, OpenmrsData, OpenmrsObject, Voidable

Direct Known Subclasses:

LocationAttribute, ProviderAttribute, VisitAttribute

public abstract class BaseAttribute<AT extends AttributeType,OwningType extends Customizable<?>>
extends BaseOpenmrsData
implements Attribute<AT,OwningType>, java.lang.Comparable<Attribute>

Abstract base implementation of Attribute. Actual implementations should be able to extend this class, and have very little of their own code.

Since:

1.9

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openmrs.BaseOpenmrsData

creator

Constructor Summary

Constructors

Constructor and Description
BaseAttribute()

Method Summary

Modifier and Type	Method and Description
int	compareTo(Attribute other)
AT	getAttributeType()
AT	getDescriptor() The metadata describing this custom value
OwningType	getOwner()
java.lang.Object	getValue() Convenience method to get the typed version of the serializedValue.
java.lang.String	getValueReference()
boolean	isDirty()
void	setAttributeType(AT attributeType)
void	setOwner(OwningType owner) Sets the owner of this attribute
<T> void	setValue(T typedValue) Sets the typed value.
void	setValueReferenceInternal(java.lang.String valueReference) Directly set the String value that OpenMRS should persist in the database in a varchar column.

Methods inherited from class org.openmrs.BaseOpenmrsData

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateVoided, getVoided, getVoidedBy, getVoidReason, isVoided, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateVoided, setVoided, setVoidedBy, setVoidReason

Methods inherited from class org.openmrs.BaseOpenmrsObject

equals, getUuid, hashCode, setUuid, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmrs.Auditable

getChangedBy, getCreator, getDateChanged, getDateCreated, setChangedBy, setCreator, setDateChanged, setDateCreated

Methods inherited from interface org.openmrs.Voidable

getDateVoided, getVoidedBy, getVoidReason, isVoided, setDateVoided, setVoided, setVoidedBy, setVoidReason

Methods inherited from interface org.openmrs.OpenmrsObject

getId, getUuid, setId, setUuid

Constructor Detail

BaseAttribute

public BaseAttribute()

Method Detail

getOwner

public OwningType getOwner()

Specified by:

getOwner in interface Attribute<AT extends AttributeType,OwningType extends Customizable<?>>

Returns:

the owner that this attribute belongs to

See Also:

Attribute.getOwner()

setOwner

public void setOwner(OwningType owner)

Description copied from interface: Attribute

Sets the owner of this attribute

Specified by:

setOwner in interface Attribute<AT extends AttributeType,OwningType extends Customizable<?>>

See Also:

Attribute.setOwner(org.openmrs.customdatatype.Customizable)

setAttributeType

public void setAttributeType(AT attributeType)

Parameters:

attributeType - the attributeType to set

getAttributeType

public AT getAttributeType()

Specified by:

getAttributeType in interface Attribute<AT extends AttributeType,OwningType extends Customizable<?>>

Returns:

the AttributeType that controls this attribute's behavior

See Also:

Attribute.getAttributeType()

getDescriptor

public AT getDescriptor()

Description copied from interface: SingleCustomValue

The metadata describing this custom value

Specified by:

getDescriptor in interface SingleCustomValue<AT extends AttributeType>

Returns:

See Also:

SingleCustomValue.getDescriptor()

getValueReference

public java.lang.String getValueReference()

Specified by:

getValueReference in interface SingleCustomValue<AT extends AttributeType>

Returns:

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

See Also:

SingleCustomValue.getValueReference()

setValueReferenceInternal

public void setValueReferenceInternal(java.lang.String valueReference)
                               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<AT extends AttributeType>

Throws:

InvalidCustomValueException

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<AT extends AttributeType>

Returns:

typed value, converted from serializedValue by a CustomDatatype

Throws:

InvalidCustomValueException

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<AT extends AttributeType>

Throws:

InvalidCustomValueException

See Also:

SingleCustomValue.setValue(java.lang.Object)

isDirty

public boolean isDirty()

Specified by:

isDirty in interface SingleCustomValue<AT extends AttributeType>

Returns:

the dirty

compareTo

public int compareTo(Attribute other)

Specified by:

compareTo in interface java.lang.Comparable<Attribute>

See Also:

Comparable.compareTo(java.lang.Object)