org.openmrs

Class PersonName

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.BaseChangeableOpenmrsData

org.openmrs.PersonName

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PersonName>, Auditable, Changeable, Creatable, OpenmrsData, OpenmrsObject, Voidable

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

A Person can have zero to n PersonName(s).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersonName.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
PersonName() default constructor
PersonName(Integer personNameId) constructor with id
PersonName(String givenName, String middleName, String familyName) Convenience constructor with the basic requirements

Method Summary

Modifier and Type	Method and Description
int	compareTo(PersonName other)
boolean	equalsContent(PersonName otherName) Compares this PersonName object to the given otherName.
String	getDegree()
String	getFamilyName()
String	getFamilyName2()
String	getFamilyNamePrefix()
String	getFamilyNameSuffix()
static String	getFormat()
String	getFullName() Convenience method to get all the names of this PersonName and concatenating them together with spaces in between.
String	getGivenName()
Integer	getId()
String	getMiddleName()
Person	getPerson()
Integer	getPersonNameId()
Boolean	getPreferred()
String	getPrefix()
Boolean	isPreferred() Deprecated. as of 2.0, use getPreferred()
static PersonName	newInstance(PersonName pn) Bitwise copy of the personName object.
void	setDegree(String degree)
void	setFamilyName(String familyName)
void	setFamilyName2(String familyName2)
void	setFamilyNamePrefix(String familyNamePrefix)
void	setFamilyNameSuffix(String familyNameSuffix)
static void	setFormat(String format)
void	setGivenName(String givenName)
void	setId(Integer id)
void	setMiddleName(String middleName)
void	setPerson(Person person)
void	setPersonNameId(Integer personNameId)
void	setPreferred(Boolean preferred)
void	setPrefix(String prefix)
String	toString() Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

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

PersonName

public PersonName()

default constructor

PersonName

public PersonName(Integer personNameId)

constructor with id

PersonName

public PersonName(String givenName,
                  String middleName,
                  String familyName)

Convenience constructor with the basic requirements

Parameters:

givenName - String this person's first name

middleName - String this person's middle name

familyName - String this person's last name

Method Detail

equalsContent

public boolean equalsContent(PersonName otherName)

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

Parameters:

otherName - PersonName with which to compare

Returns:

boolean true/false whether or not they are the same names Should return true if given middle and family name are equal

newInstance

public static PersonName newInstance(PersonName pn)

Bitwise copy of the personName object. NOTICE: THIS WILL NOT COPY THE PATIENT OBJECT. The PersonName.person object in this object AND the cloned object will point at the same person

Returns:

New PersonName object Should copy every property of given personName

getDegree

public String getDegree()

Returns:

Returns the degree.

setDegree

public void setDegree(String degree)

Parameters:

degree - The degree to set.

getFamilyName

public String getFamilyName()

Returns:

Returns the familyName. Should return obscured name if obscure_patients is set to true

setFamilyName

public void setFamilyName(String familyName)

Parameters:

familyName - The familyName to set.

getFamilyName2

public String getFamilyName2()

Returns:

Returns the familyName2. Should return null if obscure_patients is set to true

setFamilyName2

public void setFamilyName2(String familyName2)

Parameters:

familyName2 - The familyName2 to set.

getFamilyNamePrefix

public String getFamilyNamePrefix()

Returns:

Returns the familyNamePrefix. Should return null if obscure_patients is set to true

setFamilyNamePrefix

public void setFamilyNamePrefix(String familyNamePrefix)

Parameters:

familyNamePrefix - The familyNamePrefix to set.

getFamilyNameSuffix

public String getFamilyNameSuffix()

Returns:

Returns the familyNameSuffix. Should return null if obscure_patients is set to true

setFamilyNameSuffix

public void setFamilyNameSuffix(String familyNameSuffix)

Parameters:

familyNameSuffix - The familyNameSuffix to set.

getGivenName

public String getGivenName()

Returns:

Returns the givenName. Should return obscured name if obscure_patients is set to true

setGivenName

public void setGivenName(String givenName)

Parameters:

givenName - The givenName to set.

getMiddleName

public String getMiddleName()

Returns:

Returns the middleName. Should return obscured name if obscure_patients is set to true

setMiddleName

public void setMiddleName(String middleName)

Parameters:

middleName - The middleName to set.

getPerson

public Person getPerson()

Returns:

Returns the person.

setPerson

public void setPerson(Person person)

Parameters:

person - The person to set.

getPersonNameId

public Integer getPersonNameId()

Returns:

Returns the personNameId.

setPersonNameId

public void setPersonNameId(Integer personNameId)

Parameters:

personNameId - The personNameId to set.

isPreferred

@Deprecated
public Boolean isPreferred()

Deprecated. as of 2.0, use getPreferred()

Returns:

Returns the preferred.

getPreferred

public Boolean getPreferred()

setPreferred

public void setPreferred(Boolean preferred)

Parameters:

preferred - The preferred to set.

getPrefix

public String getPrefix()

Returns:

Returns the prefix. Should return null if obscure_patients is set to true

setPrefix

public void setPrefix(String prefix)

Parameters:

prefix - The prefix to set.

getFullName

public String getFullName()

Convenience method to get all the names of this PersonName and concatenating them together with spaces in between. If any part of getPrefix(), getGivenName(), getMiddleName(), etc are null, they are not included in the returned name

Returns:

all of the parts of this PersonName joined with spaces Should not put spaces around an empty middle name

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:

Object.toString()

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

compareTo

public int compareTo(PersonName other)

Specified by:

compareTo in interface Comparable<PersonName>

See Also:

Should return negative if other name is voided Should return negative if this name is preferred Should return negative if other familyName is greater Should return negative if other familyName2 is greater Should return negative if other givenName is greater Should return negative if other middleName is greater Should return negative if other familynamePrefix is greater Should return negative if other familyNameSuffix is greater Should return negative if other dateCreated is greater Note: this comparator imposes orderings that are inconsistent with equals.

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)

setFormat

public static void setFormat(String format)

getFormat

public static String getFormat()