PersonAddress (OpenMRS 1.9.13-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.BaseOpenmrsData
  - - org.openmrs.PersonAddress

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<PersonAddress>, Address, Auditable, OpenmrsData, OpenmrsObject, Voidable
```
public class PersonAddress
extends BaseOpenmrsData
implements java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<PersonAddress>, Address
```
This class is the representation of a person's address. This class is many-to-one to the Person class, so a Person/Patient/User can have zero to n addresses

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID
- Fields inherited from class org.openmrs.BaseOpenmrsData
  creator

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description

PersonAddress()
default constructor

PersonAddress(java.lang.Integer personAddressId)
constructor with id

Constructors
Constructor and Description
`PersonAddress()` default constructor
`PersonAddress(java.lang.Integer personAddressId)` constructor with id

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`activate()` Makes an address active by setting its endDate to null
`java.lang.Object`	`clone()` bitwise copy of the personAddress object.
`int`	`compareTo(PersonAddress other)`
`void`	`deactivate()` Makes an address inactive by setting its endDate to the current time
`boolean`	`equalsContent(PersonAddress otherAddress)` Compares this PersonAddress object to the given otherAddress.
`java.lang.String`	`getAddress1()`
`java.lang.String`	`getAddress2()`
`java.lang.String`	`getAddress3()`
`java.lang.String`	`getAddress4()`
`java.lang.String`	`getAddress5()`
`java.lang.String`	`getAddress6()`
`java.lang.String`	`getCityVillage()`
`java.lang.String`	`getCountry()`
`java.lang.String`	`getCountyDistrict()`
`java.util.Date`	`getEndDate()`
`java.lang.Integer`	`getId()`
`java.lang.String`	`getLatitude()`
`java.lang.String`	`getLongitude()`
`java.lang.String`	`getNeighborhoodCell()` Deprecated. As of 1.8, replaced by `getAddress3()`
`Person`	`getPerson()`
`java.lang.Integer`	`getPersonAddressId()`
`java.lang.String`	`getPostalCode()`
`java.lang.Boolean`	`getPreferred()`
`java.lang.String`	`getRegion()` Deprecated. As of 1.8, replaced by `getAddress6()`
`java.util.Date`	`getStartDate()`
`java.lang.String`	`getStateProvince()`
`java.lang.String`	`getSubregion()` Deprecated. As of 1.8, replaced by `getAddress5()`
`java.lang.String`	`getTownshipDivision()` Deprecated. As of 1.8, replaced by `getAddress4()`
`java.lang.Boolean`	`isActive()` Returns true if the address' endDate is null
`boolean`	`isBlank()` Convenience method to test whether any of the fields in this address are set
`java.lang.Boolean`	`isPreferred()`
`void`	`setAddress1(java.lang.String address1)`
`void`	`setAddress2(java.lang.String address2)`
`void`	`setAddress3(java.lang.String address3)`
`void`	`setAddress4(java.lang.String address4)`
`void`	`setAddress5(java.lang.String address5)`
`void`	`setAddress6(java.lang.String address6)`
`void`	`setCityVillage(java.lang.String cityVillage)`
`void`	`setCountry(java.lang.String country)`
`void`	`setCountyDistrict(java.lang.String countyDistrict)`
`void`	`setEndDate(java.util.Date endDate)`
`void`	`setId(java.lang.Integer id)`
`void`	`setLatitude(java.lang.String latitude)`
`void`	`setLongitude(java.lang.String longitude)`
`void`	`setNeighborhoodCell(java.lang.String address3)` Deprecated. As of 1.8, replaced by `setAddress3(String)`
`void`	`setPerson(Person person)`
`void`	`setPersonAddressId(java.lang.Integer personAddressId)`
`void`	`setPostalCode(java.lang.String postalCode)`
`void`	`setPreferred(java.lang.Boolean preferred)`
`void`	`setRegion(java.lang.String address6)` Deprecated. As of 1.8, replaced by `setAddress6(String)`
`void`	`setStartDate(java.util.Date startDate)`
`void`	`setStateProvince(java.lang.String stateProvince)`
`void`	`setSubregion(java.lang.String address5)` Deprecated. As of 1.8, replaced by `setAddress5(String)`
`void`	`setTownshipDivision(java.lang.String address4)` Deprecated. As of 1.8, replaced by `setAddress4(String)`
`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.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
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
  - PersonAddress
```
public PersonAddress()
```
    default constructor
  - PersonAddress
```
public PersonAddress(java.lang.Integer personAddressId)
```
    constructor with id
- Method Detail
  - 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()
  - equalsContent
```
public boolean equalsContent(PersonAddress otherAddress)
```
    Compares this PersonAddress object to the given otherAddress. This method differs from BaseOpenmrsObject.equals(Object) in that this method compares the inner fields of each address for equality. Note: Null/empty fields on otherAddress /will not/ cause a false value to be returned
    
    Parameters:
    
    otherAddress - PersonAddress with which to compare
    
    Returns:
    
    boolean true/false whether or not they are the same addresses
  - clone
```
public java.lang.Object clone()
```
    bitwise copy of the personAddress object. NOTICE: THIS WILL NOT COPY THE PATIENT OBJECT. The PersonAddress.person object in this object AND the cloned object will point at the same person
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    New PersonAddress object
  - getAddress1
```
public java.lang.String getAddress1()
```
    Specified by:
    
    getAddress1 in interface Address
    
    Returns:
    
    Returns the address1.
  - setAddress1
```
public void setAddress1(java.lang.String address1)
```
    Specified by:
    
    setAddress1 in interface Address
    
    Parameters:
    
    address1 - The address1 to set.
  - getAddress2
```
public java.lang.String getAddress2()
```
    Specified by:
    
    getAddress2 in interface Address
    
    Returns:
    
    Returns the address2.
  - setAddress2
```
public void setAddress2(java.lang.String address2)
```
    Specified by:
    
    setAddress2 in interface Address
    
    Parameters:
    
    address2 - The address2 to set.
  - getCityVillage
```
public java.lang.String getCityVillage()
```
    Specified by:
    
    getCityVillage in interface Address
    
    Returns:
    
    Returns the cityVillage.
  - setCityVillage
```
public void setCityVillage(java.lang.String cityVillage)
```
    Specified by:
    
    setCityVillage in interface Address
    
    Parameters:
    
    cityVillage - The cityVillage to set.
  - getCountry
```
public java.lang.String getCountry()
```
    Specified by:
    
    getCountry in interface Address
    
    Returns:
    
    Returns the country.
  - setCountry
```
public void setCountry(java.lang.String country)
```
    Specified by:
    
    setCountry in interface Address
    
    Parameters:
    
    country - The country to set.
  - isPreferred
```
public java.lang.Boolean isPreferred()
```
    Returns:
    
    Returns the preferred.
  - getPreferred
```
public java.lang.Boolean getPreferred()
```
  - setPreferred
```
public void setPreferred(java.lang.Boolean preferred)
```
    Parameters:
    
    preferred - The preferred to set.
  - getLatitude
```
public java.lang.String getLatitude()
```
    Specified by:
    
    getLatitude in interface Address
    
    Returns:
    
    Returns the latitude.
  - setLatitude
```
public void setLatitude(java.lang.String latitude)
```
    Specified by:
    
    setLatitude in interface Address
    
    Parameters:
    
    latitude - The latitude to set.
  - getLongitude
```
public java.lang.String getLongitude()
```
    Specified by:
    
    getLongitude in interface Address
    
    Returns:
    
    Returns the longitude.
  - setLongitude
```
public void setLongitude(java.lang.String longitude)
```
    Specified by:
    
    setLongitude in interface Address
    
    Parameters:
    
    longitude - The longitude to set.
  - getPerson
```
public Person getPerson()
```
    Returns:
    
    Returns the person.
  - setPerson
```
public void setPerson(Person person)
```
    Parameters:
    
    person - The person to set.
  - getPersonAddressId
```
public java.lang.Integer getPersonAddressId()
```
    Returns:
    
    Returns the personAddressId.
  - setPersonAddressId
```
public void setPersonAddressId(java.lang.Integer personAddressId)
```
    Parameters:
    
    personAddressId - The personAddressId to set.
  - getPostalCode
```
public java.lang.String getPostalCode()
```
    Specified by:
    
    getPostalCode in interface Address
    
    Returns:
    
    Returns the postalCode.
  - setPostalCode
```
public void setPostalCode(java.lang.String postalCode)
```
    Specified by:
    
    setPostalCode in interface Address
    
    Parameters:
    
    postalCode - The postalCode to set.
  - getStateProvince
```
public java.lang.String getStateProvince()
```
    Specified by:
    
    getStateProvince in interface Address
    
    Returns:
    
    Returns the stateProvince.
  - setStateProvince
```
public void setStateProvince(java.lang.String stateProvince)
```
    Specified by:
    
    setStateProvince in interface Address
    
    Parameters:
    
    stateProvince - The stateProvince to set.
  - getCountyDistrict
```
public java.lang.String getCountyDistrict()
```
    Specified by:
    
    getCountyDistrict in interface Address
    
    Returns:
    
    Returns the countyDistrict.
  - setCountyDistrict
```
public void setCountyDistrict(java.lang.String countyDistrict)
```
    Specified by:
    
    setCountyDistrict in interface Address
    
    Parameters:
    
    countyDistrict - The countyDistrict to set.
  - getNeighborhoodCell
```
@Deprecated
public java.lang.String getNeighborhoodCell()
```
    Deprecated. As of 1.8, replaced by getAddress3()
    
    Returns:
    
    Returns the neighborhoodCell.
  - setNeighborhoodCell
```
@Deprecated
public void setNeighborhoodCell(java.lang.String address3)
```
    Deprecated. As of 1.8, replaced by setAddress3(String)
    
    Parameters:
    
    address3 - The neighborhoodCell to set.
  - isBlank
```
public boolean isBlank()
```
    Convenience method to test whether any of the fields in this address are set
    
    Returns:
    
    whether any of the address fields (address1, address2, cityVillage, stateProvince, country, countyDistrict, neighborhoodCell, postalCode, latitude, longitude, etc) are whitespace, empty ("") or null.
  - getRegion
```
@Deprecated
public java.lang.String getRegion()
```
    Deprecated. As of 1.8, replaced by getAddress6()
    
    Returns:
    
    the region
  - setRegion
```
@Deprecated
public void setRegion(java.lang.String address6)
```
    Deprecated. As of 1.8, replaced by setAddress6(String)
    
    Parameters:
    
    address6 - the region to set
  - getSubregion
```
@Deprecated
public java.lang.String getSubregion()
```
    Deprecated. As of 1.8, replaced by getAddress5()
    
    Returns:
    
    the subregion
  - setSubregion
```
@Deprecated
public void setSubregion(java.lang.String address5)
```
    Deprecated. As of 1.8, replaced by setAddress5(String)
    
    Parameters:
    
    address5 - the subregion to set
  - getTownshipDivision
```
@Deprecated
public java.lang.String getTownshipDivision()
```
    Deprecated. As of 1.8, replaced by getAddress4()
    
    Returns:
    
    the townshipDivision
  - setTownshipDivision
```
@Deprecated
public void setTownshipDivision(java.lang.String address4)
```
    Deprecated. As of 1.8, replaced by setAddress4(String)
    
    Parameters:
    
    address4 - the address4 to set
  - compareTo
```
public int compareTo(PersonAddress other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<PersonAddress>
    
    See Also:
    
    Comparable.compareTo(java.lang.Object)
  - getAddress3
```
public java.lang.String getAddress3()
```
    Specified by:
    
    getAddress3 in interface Address
    
    Returns:
    
    the address3
    
    Since:
    
    1.8
  - setAddress3
```
public void setAddress3(java.lang.String address3)
```
    Specified by:
    
    setAddress3 in interface Address
    
    Parameters:
    
    address3 - the address3 to set
    
    Since:
    
    1.8
  - getAddress4
```
public java.lang.String getAddress4()
```
    Specified by:
    
    getAddress4 in interface Address
    
    Returns:
    
    the address4
    
    Since:
    
    1.8
  - setAddress4
```
public void setAddress4(java.lang.String address4)
```
    Specified by:
    
    setAddress4 in interface Address
    
    Parameters:
    
    address4 - the address4 to set
    
    Since:
    
    1.8
  - getAddress6
```
public java.lang.String getAddress6()
```
    Specified by:
    
    getAddress6 in interface Address
    
    Returns:
    
    the address6
    
    Since:
    
    1.8
  - setAddress6
```
public void setAddress6(java.lang.String address6)
```
    Specified by:
    
    setAddress6 in interface Address
    
    Parameters:
    
    address6 - the address6 to set
    
    Since:
    
    1.8
  - getAddress5
```
public java.lang.String getAddress5()
```
    Specified by:
    
    getAddress5 in interface Address
    
    Returns:
    
    the address5
    
    Since:
    
    1.8
  - setAddress5
```
public void setAddress5(java.lang.String address5)
```
    Specified by:
    
    setAddress5 in interface Address
    
    Parameters:
    
    address5 - the address5 to set
    
    Since:
    
    1.8
  - 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)
  - getStartDate
```
public java.util.Date getStartDate()
```
    Returns:
    
    the startDate
    
    Since:
    
    1.9
  - setStartDate
```
public void setStartDate(java.util.Date startDate)
```
    Parameters:
    
    startDate - to set to
    
    Since:
    
    1.9
  - getEndDate
```
public java.util.Date getEndDate()
```
    Returns:
    
    the endDate
    
    Since:
    
    1.9
  - setEndDate
```
public void setEndDate(java.util.Date endDate)
```
    Parameters:
    
    endDate - to set to
    
    Since:
    
    1.9
  - isActive
```
public java.lang.Boolean isActive()
```
    Returns true if the address' endDate is null
    
    Returns:
    
    true or false
    
    Since:
    
    1.9
  - deactivate
```
public void deactivate()
```
    Makes an address inactive by setting its endDate to the current time
    
    Since:
    
    1.9
  - activate
```
public void activate()
```
    Makes an address active by setting its endDate to null
    
    Since:
    
    1.9

Class PersonAddress

Field Summary

Fields inherited from class org.openmrs.BaseOpenmrsData

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseOpenmrsData

Methods inherited from class org.openmrs.BaseOpenmrsObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.openmrs.OpenmrsObject

Field Detail

serialVersionUID

Constructor Detail

PersonAddress

PersonAddress

Method Detail

toString

equalsContent

clone

getAddress1

setAddress1

getAddress2

setAddress2

getCityVillage

setCityVillage

getCountry

setCountry

isPreferred

getPreferred

setPreferred

getLatitude

setLatitude

getLongitude

setLongitude

getPerson

setPerson

getPersonAddressId

setPersonAddressId

getPostalCode

setPostalCode

getStateProvince

setStateProvince

getCountyDistrict

setCountyDistrict

getNeighborhoodCell

setNeighborhoodCell

isBlank

getRegion

setRegion

getSubregion

setSubregion

getTownshipDivision

setTownshipDivision

compareTo

getAddress3

setAddress3

getAddress4

setAddress4

getAddress6

setAddress6

getAddress5

setAddress5

getId

setId

getStartDate

setStartDate

getEndDate

setEndDate

isActive

deactivate

activate