org.openmrs.attribute

Class BaseAttributeType<OwningType extends Customizable<?>>

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsMetadata

org.openmrs.BaseChangeableOpenmrsMetadata

org.openmrs.attribute.BaseAttributeType<OwningType>

All Implemented Interfaces:

Serializable, AttributeType<OwningType>, Auditable, Changeable, Creatable, CustomValueDescriptor, RepeatingCustomValueDescriptor, OpenmrsMetadata, OpenmrsObject, Retireable

Direct Known Subclasses:

ConceptAttributeType, DiagnosisAttributeType, LocationAttributeType, OrderAttributeType, OrderGroupAttributeType, OrderSetAttributeType, ProgramAttributeType, ProviderAttributeType, VisitAttributeType

@MappedSuperclass
public abstract class BaseAttributeType<OwningType extends Customizable<?>>
extends BaseChangeableOpenmrsMetadata
implements AttributeType<OwningType>

Abstract base implementation of AttributeType. Actual implementations (e.g. VisitAttributeType, ProviderAttributeType) should be able to extend this and provide very little of their own code.

Since:

1.9

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseAttributeType()

Method Summary

Modifier and Type	Method and Description
String	getDatatypeClassname() Return the name of a class that implements CustomDatatype.
String	getDatatypeConfig() May be null.
String	getHandlerConfig() May be null.
Integer	getMaxOccurs() Implementation should never return a number <= 0.
Integer	getMinOccurs() Implementations should never return null.
String	getPreferredHandlerClassname() May be null.
void	setDatatypeClassname(String datatypeClassname)
void	setDatatypeConfig(String datatypeConfig)
void	setHandlerConfig(String handlerConfig)
void	setMaxOccurs(Integer maxOccurs)
void	setMinOccurs(Integer minOccurs)
void	setPreferredHandlerClassname(String preferredHandlerClassname)

Methods inherited from class org.openmrs.BaseOpenmrsMetadata

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateRetired, getDescription, getName, getRetired, getRetiredBy, getRetireReason, isRetired, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateRetired, setDescription, setName, setRetired, setRetiredBy, setRetireReason

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.OpenmrsMetadata

getChangedBy, getDateChanged, getDescription, getName, setChangedBy, setDateChanged, setDescription, setName

Methods inherited from interface org.openmrs.Creatable

getCreator, getDateCreated, setCreator, setDateCreated

Methods inherited from interface org.openmrs.OpenmrsObject

getId, getUuid, setId, setUuid

Methods inherited from interface org.openmrs.Retireable

getDateRetired, getRetired, getRetiredBy, getRetireReason, isRetired, setDateRetired, setRetired, setRetiredBy, setRetireReason

Constructor Detail

BaseAttributeType

public BaseAttributeType()

Method Detail

getMinOccurs

public Integer getMinOccurs()

Description copied from interface: RepeatingCustomValueDescriptor

Implementations should never return null. Positive return values indicate a "required" value.

Specified by:

getMinOccurs in interface RepeatingCustomValueDescriptor

Returns:

the minimum number of values of this type that must be present for the owner to be valid

See Also:

RepeatingCustomValueDescriptor.getMinOccurs()

getMaxOccurs

public Integer getMaxOccurs()

Description copied from interface: RepeatingCustomValueDescriptor

Implementation should never return a number <= 0.

Specified by:

getMaxOccurs in interface RepeatingCustomValueDescriptor

Returns:

the maximum number of values of this type that may be present for the owner to be valid

See Also:

RepeatingCustomValueDescriptor.getMaxOccurs()

getDatatypeClassname

public 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

See Also:

CustomValueDescriptor.getDatatypeClassname()

getDatatypeConfig

public 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

See Also:

CustomValueDescriptor.getDatatypeConfig()

getPreferredHandlerClassname

public 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.

See Also:

CustomValueDescriptor.getPreferredHandlerClassname()

getHandlerConfig

public 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.

See Also:

CustomValueDescriptor.getHandlerConfig()

setMinOccurs

public void setMinOccurs(Integer minOccurs)

Parameters:

minOccurs - the minOccurs to set

setMaxOccurs

public void setMaxOccurs(Integer maxOccurs)

Parameters:

maxOccurs - the maxOccurs to set

setDatatypeClassname

public void setDatatypeClassname(String datatypeClassname)

Parameters:

datatypeClassname - the datatypeClassname to set

setDatatypeConfig

public void setDatatypeConfig(String datatypeConfig)

Parameters:

datatypeConfig - the datatypeConfig to set

setPreferredHandlerClassname

public void setPreferredHandlerClassname(String preferredHandlerClassname)

Parameters:

preferredHandlerClassname - the preferredHandlerClassname to set

setHandlerConfig

public void setHandlerConfig(String handlerConfig)

Parameters:

handlerConfig - the handlerConfig to set