Location (OpenMRS 2.7.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.BaseOpenmrsObject
- - org.openmrs.BaseOpenmrsMetadata
  - - org.openmrs.BaseChangeableOpenmrsMetadata
    - - org.openmrs.BaseCustomizableMetadata<LocationAttribute>
      - org.openmrs.Location

All Implemented Interfaces:

Serializable, Address, Attributable<Location>, Auditable, Changeable, Creatable, Customizable<LocationAttribute>, OpenmrsMetadata, OpenmrsObject, Retireable
```
@Entity
public class Location
extends BaseCustomizableMetadata<LocationAttribute>
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. Note: Prior to version 1.9 this class extended BaseMetadata

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.
`List<Location>`	`findPossibleValues(String searchText)` Deprecated.
`String`	`getAddress1()`
`String`	`getAddress10()`
`String`	`getAddress11()`
`String`	`getAddress12()`
`String`	`getAddress13()`
`String`	`getAddress14()`
`String`	`getAddress15()`
`String`	`getAddress2()`
`String`	`getAddress3()`
`String`	`getAddress4()`
`String`	`getAddress5()`
`String`	`getAddress6()`
`String`	`getAddress7()`
`String`	`getAddress8()`
`String`	`getAddress9()`
`Set<Location>`	`getChildLocations()`
`Set<Location>`	`getChildLocations(boolean includeRetired)` Returns all childLocations where child.locationId = this.locationId.
`String`	`getCityVillage()`
`String`	`getCountry()`
`String`	`getCountyDistrict()`
`Set<Location>`	`getDescendantLocations(boolean includeRetired)` Returns the descendant locations.
`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()`
`Location`	`getParentLocation()`
`List<Location>`	`getPossibleValues()` Deprecated.
`String`	`getPostalCode()`
`String`	`getStateProvince()`
`Set<LocationTag>`	`getTags()`
`Concept`	`getType()`
`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`	`setAddress10(String address10)`
`void`	`setAddress11(String address11)`
`void`	`setAddress12(String address12)`
`void`	`setAddress13(String address13)`
`void`	`setAddress14(String address14)`
`void`	`setAddress15(String address15)`
`void`	`setAddress2(String address2)`
`void`	`setAddress3(String address3)`
`void`	`setAddress4(String address4)`
`void`	`setAddress5(String address5)`
`void`	`setAddress6(String address6)`
`void`	`setAddress7(String address7)`
`void`	`setAddress8(String address8)`
`void`	`setAddress9(String address9)`
`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`	`setParentLocation(Location parentLocationId)`
`void`	`setPostalCode(String postalCode)`
`void`	`setStateProvince(String stateProvince)`
`void`	`setTags(Set<LocationTag> tags)` Set the tags which are attached to this Location.
`void`	`setType(Concept type)`
`String`	`toString()` Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

Methods inherited from class org.openmrs.BaseCustomizableMetadata
addAttribute, getActiveAttributes, getActiveAttributes, getAttributes, setAttribute, setAttributes

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

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
  - 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()
```
    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
  - 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.
  - getType
```
public Concept getType()
```
    Returns:
    
    Returns the code indicating the type of location this is
    
    Since:
    
    2.5.0
  - setType
```
public void setType(Concept type)
```
    Parameters:
    
    type - The Concept for the type of location this is
    
    Since:
    
    2.5.0
  - findPossibleValues
```
@Deprecated
public List<Location> findPossibleValues(String searchText)
```
    Deprecated.
    
    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
```
@Deprecated
public List<Location> getPossibleValues()
```
    Deprecated.
    
    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()
  - 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<Location> of all the childLocations.
    
    Since:
    
    1.5 Should return a set of locations
  - getDescendantLocations
```
public Set<Location> getDescendantLocations(boolean includeRetired)
```
    Returns the descendant locations.
    
    Parameters:
    
    includeRetired - specifies whether or not to include voided childLocations
    
    Returns:
    
    Returns a Set<Location> of the descendant location.
    
    Since:
    
    1.10
  - 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 Should throw APIException given same object as child Should 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 Should return true given same object in both parameters Should return true given location that is already somewhere in hierarchy Should return false given location that is not in hierarchy Should 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 Should 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)
  - getAddress7
```
public String getAddress7()
```
    Specified by:
    
    getAddress7 in interface Address
    
    Returns:
    
    the address7
  - setAddress7
```
public void setAddress7(String address7)
```
    Specified by:
    
    setAddress7 in interface Address
  - getAddress8
```
public String getAddress8()
```
    Specified by:
    
    getAddress8 in interface Address
    
    Returns:
    
    the address8
  - setAddress8
```
public void setAddress8(String address8)
```
    Specified by:
    
    setAddress8 in interface Address
  - getAddress9
```
public String getAddress9()
```
    Specified by:
    
    getAddress9 in interface Address
    
    Returns:
    
    the address9
  - setAddress9
```
public void setAddress9(String address9)
```
    Specified by:
    
    setAddress9 in interface Address
  - getAddress10
```
public String getAddress10()
```
    Specified by:
    
    getAddress10 in interface Address
    
    Returns:
    
    the address10
  - setAddress10
```
public void setAddress10(String address10)
```
    Specified by:
    
    setAddress10 in interface Address
  - getAddress11
```
public String getAddress11()
```
    Specified by:
    
    getAddress11 in interface Address
    
    Returns:
    
    the address11
  - setAddress11
```
public void setAddress11(String address11)
```
    Specified by:
    
    setAddress11 in interface Address
  - getAddress12
```
public String getAddress12()
```
    Specified by:
    
    getAddress12 in interface Address
    
    Returns:
    
    the address12
  - setAddress12
```
public void setAddress12(String address12)
```
    Specified by:
    
    setAddress12 in interface Address
  - getAddress13
```
public String getAddress13()
```
    Specified by:
    
    getAddress13 in interface Address
    
    Returns:
    
    the address13
  - setAddress13
```
public void setAddress13(String address13)
```
    Specified by:
    
    setAddress13 in interface Address
  - getAddress14
```
public String getAddress14()
```
    Specified by:
    
    getAddress14 in interface Address
    
    Returns:
    
    the address14
  - setAddress14
```
public void setAddress14(String address14)
```
    Specified by:
    
    setAddress14 in interface Address
  - getAddress15
```
public String getAddress15()
```
    Specified by:
    
    getAddress15 in interface Address
    
    Returns:
    
    the address15
  - setAddress15
```
public void setAddress15(String address15)
```
    Specified by:
    
    setAddress15 in interface Address

Class Location

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.openmrs.BaseCustomizableMetadata

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

getAddress1

setAddress1

getAddress2

setAddress2

getCityVillage

setCityVillage

getCountry

setCountry

getLatitude

setLatitude

getLocationId

setLocationId

getLongitude

setLongitude

getPostalCode

setPostalCode

getStateProvince

setStateProvince

toString

getCountyDistrict

setCountyDistrict

getType

setType

findPossibleValues

getPossibleValues

hydrate

serialize

getDisplayString

getParentLocation

setParentLocation

getChildLocations

getChildLocations

getDescendantLocations

setChildLocations

addChildLocation

isInHierarchy

removeChildLocation

getTags

setTags

addTag

removeTag

hasTag

getAddress3

setAddress3

getAddress4

setAddress4

getAddress6

setAddress6

getAddress5

setAddress5

getId

setId

getAddress7

setAddress7

getAddress8

setAddress8

getAddress9

setAddress9

getAddress10

setAddress10

getAddress11

setAddress11

getAddress12

setAddress12