org.openmrs

Class PersonAttribute

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.BaseChangeableOpenmrsData

org.openmrs.PersonAttribute

All Implemented Interfaces:

Serializable, Comparable<PersonAttribute>, Auditable, Changeable, Creatable, OpenmrsData, OpenmrsObject, Voidable

@Indexed
public class PersonAttribute
extends BaseChangeableOpenmrsData
implements Serializable, Comparable<PersonAttribute>

A PersonAttribute is meant as way for implementations to add arbitrary information about a user/patient to their database. PersonAttributes are essentially just key-value pairs. However, the PersonAttributeType can be defined in such a way that the value portion of this PersonAttribute is a foreign key to another database table (like to the location table, or concept table). This gives a PersonAttribute the ability to link to any other part of the database A Person can have zero to n PersonAttribute(s).

See Also:

PersonAttributeType, Attributable, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersonAttribute.DefaultComparator Provides a default comparator.

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class org.openmrs.BaseOpenmrsData

creator

Constructor Summary

Constructors

Constructor and Description
PersonAttribute() default constructor
PersonAttribute(Integer personAttributeId)
PersonAttribute(PersonAttributeType type, String value) Constructor for creating a basic attribute

Method Summary

Modifier and Type	Method and Description
int	compareTo(PersonAttribute other)
PersonAttribute	copy() Shallow copy of this PersonAttribute.
protected PersonAttribute	copyHelper(PersonAttribute target) The purpose of this method is to allow subclasses of PersonAttribute to delegate a portion of their copy() method back to the superclass, in case the base class implementation changes.
boolean	equalsContent(PersonAttribute otherAttribute) Compares this PersonAttribute object to the given otherAttribute.
PersonAttributeType	getAttributeType()
Object	getHydratedObject() Will try to create an object of class 'PersonAttributeType.format'.
Integer	getId()
Person	getPerson()
Integer	getPersonAttributeId()
String	getValue()
void	setAttributeType(PersonAttributeType attributeType)
void	setId(Integer id)
void	setPerson(Person person)
void	setPersonAttributeId(Integer personAttributeId)
void	setValue(String value)
String	toString() Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}
void	voidAttribute(String reason) Convenience method for voiding this attribute

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmrs.OpenmrsObject

getUuid, setUuid

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

PersonAttribute

public PersonAttribute()

default constructor

PersonAttribute

public PersonAttribute(Integer personAttributeId)

PersonAttribute

public PersonAttribute(PersonAttributeType type,
                       String value)

Constructor for creating a basic attribute

Parameters:

type - PersonAttributeType

value - String

Method Detail

copy

public PersonAttribute copy()

Shallow copy of this PersonAttribute. Does NOT copy personAttributeId

Returns:

a shallows copy of this

copyHelper

protected PersonAttribute copyHelper(PersonAttribute target)

The purpose of this method is to allow subclasses of PersonAttribute to delegate a portion of their copy() method back to the superclass, in case the base class implementation changes.

Parameters:

target - a PersonAttribute that will have the state of this copied into it

Returns:

Returns the PersonAttribute that was passed in, with state copied into it

equalsContent

public boolean equalsContent(PersonAttribute otherAttribute)

Compares this PersonAttribute object to the given otherAttribute. This method differs from BaseOpenmrsObject.equals(Object) in that this method compares the inner fields of each attribute for equality. Note: Null/empty fields on otherAttribute /will not/ cause a false value to be returned

Parameters:

otherAttribute - PersonAttribute with which to compare

Returns:

boolean true/false whether or not they are the same attributes Should return true if attributeType value and void status are the same

getPerson

public Person getPerson()

Returns:

Returns the person.

setPerson

public void setPerson(Person person)

Parameters:

person - The person to set.

getAttributeType

public PersonAttributeType getAttributeType()

Returns:

the attributeType

setAttributeType

public void setAttributeType(PersonAttributeType attributeType)

Parameters:

attributeType - the attributeType to set

getValue

public String getValue()

Returns:

the value

setValue

public void setValue(String value)

Parameters:

value - the value to set

toString

public String toString()

Description copied from class: BaseOpenmrsObject

Returns a string equal to the value of:

ClassName{hashCode=..., uuid=...}

If the uuid field is null, it returns:

ClassName{hashCode=...}

Should include hashCode if uuid is null Should include uuid if not null

Overrides:

toString in class BaseOpenmrsObject

See Also:

Should return toString of hydrated value

getPersonAttributeId

public Integer getPersonAttributeId()

Returns:

the personAttributeId

setPersonAttributeId

public void setPersonAttributeId(Integer personAttributeId)

Parameters:

personAttributeId - the personAttributeId to set

getHydratedObject

public Object getHydratedObject()

Will try to create an object of class 'PersonAttributeType.format'. If that implements Attributable, hydrate(value) is called. Defaults to just returning getValue()

Returns:

hydrated object or getValue() Should load class in format property Should still load class in format property if not Attributable

voidAttribute

public void voidAttribute(String reason)

Convenience method for voiding this attribute

Parameters:

reason - Should set voided bit to true

compareTo

public int compareTo(PersonAttribute other)

Specified by:

compareTo in interface Comparable<PersonAttribute>

See Also:

Should return negative if other attribute is voided Should return negative if other attribute has earlier date created Should return negative if this attribute has lower attribute type than argument Should return negative if other attribute has lower value Should return negative if this attribute has lower attribute id than argument Should not throw exception if attribute type is null Note: this comparator imposes orderings that are inconsistent with equals

getId

public 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(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)