Location (OpenMRS 1.8.5-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.BaseOpenmrsMetadata
  - - org.openmrs.Location

All Implemented Interfaces:

Serializable, Address, Attributable<Location>, Auditable, OpenmrsMetadata, OpenmrsObject, Retireable
```
public class Location
extends BaseOpenmrsMetadata
implements Serializable, Attributable<Location>, Address
```
A Location is a physical place, such as a hospital, a room, a clinic, or a district. Locations support a single hierarchy, such that each location may have one parent location. A non-geographical grouping of locations, such as "All Community Health Centers" is not a location, and should be modeled using LocationTags.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int LOCATION_UNKNOWN

static long serialVersionUID

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

Constructor Summary

Constructors
Constructor and Description

Location()
default constructor

Location(Integer locationId)
constructor with id

Constructors
Constructor and Description
`Location()` default constructor
`Location(Integer locationId)` constructor with id

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addChildLocation(Location child)`
`void`	`addTag(LocationTag tag)` Attaches a tag to the Location.
`boolean`	`equals(Object obj)` Compares two objects for similarity
`List<Location>`	`findPossibleValues(String searchText)` Search for possible values of this object using the given search string
`String`	`getAddress1()`
`String`	`getAddress2()`
`String`	`getAddress3()`
`String`	`getAddress4()`
`String`	`getAddress5()`
`String`	`getAddress6()`
`Set<Location>`	`getChildLocations()`
`Set<Location>`	`getChildLocations(boolean includeRetired)` Returns all childLocations where child.locationId = this.locationId.
`String`	`getCityVillage()`
`String`	`getCountry()`
`String`	`getCountyDistrict()`
`String`	`getDisplayString()` Gets a descriptive String used for display purposes This is meant as an alternative to using the toString() to display this object to a user
`Integer`	`getId()`
`String`	`getLatitude()`
`Integer`	`getLocationId()`
`String`	`getLongitude()`
`String`	`getNeighborhoodCell()` Deprecated. As of 1.8, replaced by `getAddress3()`
`Location`	`getParentLocation()`
`List<Location>`	`getPossibleValues()` Find all possible values of this object.
`String`	`getPostalCode()`
`String`	`getRegion()` Deprecated. As of 1.8, replaced by `getAddress6()`
`String`	`getStateProvince()`
`String`	`getSubregion()` Deprecated. As of 1.8, replaced by `getAddress5()`
`Set<LocationTag>`	`getTags()`
`String`	`getTownshipDivision()` Deprecated. As of 1.8, replaced by `getAddress4()`
`int`	`hashCode()`
`Boolean`	`hasTag(String tagToFind)` Checks whether the Location has a particular tag.
`Location`	`hydrate(String locationId)` Deserialize the given string into a full object
`static Boolean`	`isInHierarchy(Location location, Location root)` Checks whether 'location' is a member of the tree starting at 'root'.
`void`	`removeChildLocation(Location child)`
`void`	`removeTag(LocationTag tag)` Remove the tag from the Location.
`String`	`serialize()` Turn the current object into an identifying string that can be retrieved later
`void`	`setAddress1(String address1)`
`void`	`setAddress2(String address2)`
`void`	`setAddress3(String address3)`
`void`	`setAddress4(String address4)`
`void`	`setAddress5(String address5)`
`void`	`setAddress6(String address6)`
`void`	`setChildLocations(Set<Location> childLocations)`
`void`	`setCityVillage(String cityVillage)`
`void`	`setCountry(String country)`
`void`	`setCountyDistrict(String countyDistrict)`
`void`	`setId(Integer id)`
`void`	`setLatitude(String latitude)`
`void`	`setLocationId(Integer locationId)`
`void`	`setLongitude(String longitude)`
`void`	`setNeighborhoodCell(String address3)` Deprecated. As of 1.8, replaced by `setAddress3(String)`
`void`	`setParentLocation(Location parentLocationId)`
`void`	`setPostalCode(String postalCode)`
`void`	`setRegion(String address6)` Deprecated. As of 1.8, replaced by `setAddress6(String)`
`void`	`setStateProvince(String stateProvince)`
`void`	`setSubregion(String address5)` Deprecated. As of 1.8, replaced by `setAddress5(String)`
`void`	`setTags(Set<LocationTag> tags)` Set the tags which are attached to this Location.
`void`	`setTownshipDivision(String address4)` Deprecated. As of 1.8, replaced by `setAddress4(String)`
`String`	`toString()`

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
getUuid, 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
  - LOCATION_UNKNOWN
```
public static final int LOCATION_UNKNOWN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Location
```
public Location()
```
    default constructor
  - Location
```
public Location(Integer locationId)
```
    constructor with id
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Compares two objects for similarity
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj -
    
    Returns:
    
    boolean true/false whether or not they are the same objects
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getAddress1
```
public String getAddress1()
```
    Specified by:
    
    getAddress1 in interface Address
    
    Returns:
    
    Returns the address1.
  - setAddress1
```
public void setAddress1(String address1)
```
    Specified by:
    
    setAddress1 in interface Address
    
    Parameters:
    
    address1 - The address1 to set.
  - getAddress2
```
public String getAddress2()
```
    Specified by:
    
    getAddress2 in interface Address
    
    Returns:
    
    Returns the address2.
  - setAddress2
```
public void setAddress2(String address2)
```
    Specified by:
    
    setAddress2 in interface Address
    
    Parameters:
    
    address2 - The address2 to set.
  - getCityVillage
```
public String getCityVillage()
```
    Specified by:
    
    getCityVillage in interface Address
    
    Returns:
    
    Returns the cityVillage.
  - setCityVillage
```
public void setCityVillage(String cityVillage)
```
    Specified by:
    
    setCityVillage in interface Address
    
    Parameters:
    
    cityVillage - The cityVillage to set.
  - getCountry
```
public String getCountry()
```
    Specified by:
    
    getCountry in interface Address
    
    Returns:
    
    Returns the country.
  - setCountry
```
public void setCountry(String country)
```
    Specified by:
    
    setCountry in interface Address
    
    Parameters:
    
    country - The country to set.
  - getLatitude
```
public String getLatitude()
```
    Specified by:
    
    getLatitude in interface Address
    
    Returns:
    
    Returns the latitude.
  - setLatitude
```
public void setLatitude(String latitude)
```
    Specified by:
    
    setLatitude in interface Address
    
    Parameters:
    
    latitude - The latitude to set.
  - getLocationId
```
public Integer getLocationId()
```
    Returns:
    
    Returns the locationId.
  - setLocationId
```
public void setLocationId(Integer locationId)
```
    Parameters:
    
    locationId - The locationId to set.
  - getLongitude
```
public String getLongitude()
```
    Specified by:
    
    getLongitude in interface Address
    
    Returns:
    
    Returns the longitude.
  - setLongitude
```
public void setLongitude(String longitude)
```
    Specified by:
    
    setLongitude in interface Address
    
    Parameters:
    
    longitude - The longitude to set.
  - getPostalCode
```
public String getPostalCode()
```
    Specified by:
    
    getPostalCode in interface Address
    
    Returns:
    
    Returns the postalCode.
  - setPostalCode
```
public void setPostalCode(String postalCode)
```
    Specified by:
    
    setPostalCode in interface Address
    
    Parameters:
    
    postalCode - The postalCode to set.
  - getStateProvince
```
public String getStateProvince()
```
    Specified by:
    
    getStateProvince in interface Address
    
    Returns:
    
    Returns the stateProvince.
  - setStateProvince
```
public void setStateProvince(String stateProvince)
```
    Specified by:
    
    setStateProvince in interface Address
    
    Parameters:
    
    stateProvince - The stateProvince to set.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getCountyDistrict
```
public String getCountyDistrict()
```
    Specified by:
    
    getCountyDistrict in interface Address
    
    Returns:
    
    Returns the countyDistrict.
  - setCountyDistrict
```
public void setCountyDistrict(String countyDistrict)
```
    Specified by:
    
    setCountyDistrict in interface Address
    
    Parameters:
    
    countyDistrict - The countyDistrict to set.
  - getNeighborhoodCell
```
@Deprecated
public String getNeighborhoodCell()
```
    Deprecated. As of 1.8, replaced by getAddress3()
    
    Returns:
    
    Returns the neighborhoodCell.
  - setNeighborhoodCell
```
@Deprecated
public void setNeighborhoodCell(String address3)
```
    Deprecated. As of 1.8, replaced by setAddress3(String)
    
    Parameters:
    
    address3 - The neighborhoodCell to set.
  - findPossibleValues
```
public List<Location> findPossibleValues(String searchText)
```
    Description copied from interface: Attributable
    
    Search for possible values of this object using the given search string
    
    Specified by:
    
    findPossibleValues in interface Attributable<Location>
    
    Parameters:
    
    searchText - String to search on
    
    Returns:
    
    List of possible objects that can be assigned
    
    See Also:
    
    Attributable.findPossibleValues(java.lang.String)
  - getPossibleValues
```
public List<Location> getPossibleValues()
```
    Description copied from interface: Attributable
    
    Find all possible values of this object. For example, if this object is a Location, the database is delved into and all Location objects should be returned
    
    Specified by:
    
    getPossibleValues in interface Attributable<Location>
    
    Returns:
    
    List of objects that can be assigned
    
    See Also:
    
    Attributable.getPossibleValues()
  - hydrate
```
public Location hydrate(String locationId)
```
    Description copied from interface: Attributable
    
    Deserialize the given string into a full object
    
    Specified by:
    
    hydrate in interface Attributable<Location>
    
    Parameters:
    
    locationId - String to deserialize
    
    Returns:
    
    hydrated object
    
    See Also:
    
    Attributable.hydrate(java.lang.String)
  - serialize
```
public String serialize()
```
    Description copied from interface: Attributable
    
    Turn the current object into an identifying string that can be retrieved later
    
    Specified by:
    
    serialize in interface Attributable<Location>
    
    Returns:
    
    String representing this object (Usually an identifier or primary key)
    
    See Also:
    
    Attributable.serialize()
  - getDisplayString
```
public String getDisplayString()
```
    Description copied from interface: Attributable
    
    Gets a descriptive String used for display purposes This is meant as an alternative to using the toString() to display this object to a user
    
    Specified by:
    
    getDisplayString in interface Attributable<Location>
    
    Returns:
    
    String acceptable to display on a page
    
    See Also:
    
    Attributable.getDisplayString()
  - getRegion
```
@Deprecated
public String getRegion()
```
    Deprecated. As of 1.8, replaced by getAddress6()
    
    Returns:
    
    the region
  - setRegion
```
@Deprecated
public void setRegion(String address6)
```
    Deprecated. As of 1.8, replaced by setAddress6(String)
    
    Parameters:
    
    address6 - the region to set
  - getSubregion
```
@Deprecated
public String getSubregion()
```
    Deprecated. As of 1.8, replaced by getAddress5()
    
    Returns:
    
    the subregion
  - setSubregion
```
@Deprecated
public void setSubregion(String address5)
```
    Deprecated. As of 1.8, replaced by setAddress5(String)
    
    Parameters:
    
    address5 - the subregion to set
  - getTownshipDivision
```
@Deprecated
public String getTownshipDivision()
```
    Deprecated. As of 1.8, replaced by getAddress4()
    
    Returns:
    
    the townshipDivision
  - setTownshipDivision
```
@Deprecated
public void setTownshipDivision(String address4)
```
    Deprecated. As of 1.8, replaced by setAddress4(String)
    
    Parameters:
    
    address4 - the townshipDivision to set
  - getParentLocation
```
public Location getParentLocation()
```
    Returns:
    
    Returns the parentLocation.
    
    Since:
    
    1.5
  - setParentLocation
```
public void setParentLocation(Location parentLocationId)
```
    Parameters:
    
    parentLocationId - The parentLocation to set.
    
    Since:
    
    1.5
  - getChildLocations
```
public Set<Location> getChildLocations()
```
    Returns:
    
    Returns the childLocations.
    
    Since:
    
    1.5
  - getChildLocations
```
public Set<Location> getChildLocations(boolean includeRetired)
```
    Returns all childLocations where child.locationId = this.locationId.
    
    Parameters:
    
    includeRetired - specifies whether or not to include voided childLocations
    
    Returns:
    
    Returns a Set of all the childLocations.
    
    Since:
    
    1.5
    
    Should:
    
    return a set of locations
  - setChildLocations
```
public void setChildLocations(Set<Location> childLocations)
```
    Parameters:
    
    childLocations - The childLocations to set.
    
    Since:
    
    1.5
  - addChildLocation
```
public void addChildLocation(Location child)
```
    Parameters:
    
    child - The child location to add.
    
    Since:
    
    1.5
    
    Should:
    
    return null given null parameter, throw APIException given same object as child, throw APIException if child already in hierarchy
  - isInHierarchy
```
public static Boolean isInHierarchy(Location location,
                                    Location root)
```
    Checks whether 'location' is a member of the tree starting at 'root'.
    
    Parameters:
    
    location - The location to be tested.
    
    root - Location node from which to start the testing (down in the hierarchy).
    
    Since:
    
    1.5
    
    Should:
    
    return false given any null parameter, return true given same object in both parameters, return true given location that is already somewhere in hierarchy, return false given location that is not in hierarchy, should find location in hierarchy
  - removeChildLocation
```
public void removeChildLocation(Location child)
```
    Parameters:
    
    child - The child location to remove.
    
    Since:
    
    1.5
  - getTags
```
public Set<LocationTag> getTags()
```
    Returns:
    
    Returns the tags which have been attached to this Location.
    
    Since:
    
    1.5
  - setTags
```
public void setTags(Set<LocationTag> tags)
```
    Set the tags which are attached to this Location.
    
    Parameters:
    
    tags - The tags to set.
    
    Since:
    
    1.5
  - addTag
```
public void addTag(LocationTag tag)
```
    Attaches a tag to the Location.
    
    Parameters:
    
    tag - The tag to add.
    
    Since:
    
    1.5
  - removeTag
```
public void removeTag(LocationTag tag)
```
    Remove the tag from the Location.
    
    Parameters:
    
    tag - The tag to remove.
    
    Since:
    
    1.5
  - hasTag
```
public Boolean hasTag(String tagToFind)
```
    Checks whether the Location has a particular tag.
    
    Parameters:
    
    tagToFind - the string of the tag for which to check
    
    Returns:
    
    true if the tags include the specified tag, false otherwise
    
    Since:
    
    1.5
    
    Should:
    
    not fail given null parameter, return false given empty string parameter
  - getAddress3
```
public String getAddress3()
```
    Specified by:
    
    getAddress3 in interface Address
    
    Returns:
    
    the address3
    
    Since:
    
    1.8
  - setAddress3
```
public void setAddress3(String address3)
```
    Specified by:
    
    setAddress3 in interface Address
    
    Parameters:
    
    address3 - the address3 to set
    
    Since:
    
    1.8
  - getAddress4
```
public String getAddress4()
```
    Specified by:
    
    getAddress4 in interface Address
    
    Returns:
    
    the address4
    
    Since:
    
    1.8
  - setAddress4
```
public void setAddress4(String address4)
```
    Specified by:
    
    setAddress4 in interface Address
    
    Parameters:
    
    address4 - the address4 to set
    
    Since:
    
    1.8
  - getAddress6
```
public String getAddress6()
```
    Specified by:
    
    getAddress6 in interface Address
    
    Returns:
    
    the address6
    
    Since:
    
    1.8
  - setAddress6
```
public void setAddress6(String address6)
```
    Specified by:
    
    setAddress6 in interface Address
    
    Parameters:
    
    address6 - the address6 to set
    
    Since:
    
    1.8
  - getAddress5
```
public String getAddress5()
```
    Specified by:
    
    getAddress5 in interface Address
    
    Returns:
    
    the address5
    
    Since:
    
    1.8
  - setAddress5
```
public void setAddress5(String address5)
```
    Specified by:
    
    setAddress5 in interface Address
    
    Parameters:
    
    address5 - the address5 to set
    
    Since:
    
    1.8
  - 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)

Class Location

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseOpenmrsMetadata

Methods inherited from class org.openmrs.BaseOpenmrsObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.openmrs.OpenmrsObject

Field Detail

serialVersionUID

LOCATION_UNKNOWN

Constructor Detail

Location

Location

Method Detail

equals

hashCode

getAddress1

setAddress1

getAddress2

setAddress2

getCityVillage

setCityVillage

getCountry

setCountry

getLatitude

setLatitude

getLocationId

setLocationId

getLongitude

setLongitude

getPostalCode

setPostalCode

getStateProvince

setStateProvince

toString

getCountyDistrict

setCountyDistrict

getNeighborhoodCell

setNeighborhoodCell

findPossibleValues

getPossibleValues

hydrate

serialize

getDisplayString

getRegion

setRegion

getSubregion

setSubregion

getTownshipDivision

setTownshipDivision

getParentLocation

setParentLocation

getChildLocations

getChildLocations

setChildLocations

addChildLocation

isInHierarchy

removeChildLocation

getTags

setTags

addTag

removeTag

hasTag

getAddress3

setAddress3

getAddress4

setAddress4

getAddress6

setAddress6

getAddress5

setAddress5

getId

setId