org.opensrp.api.domain

Class Location

java.lang.Object

org.opensrp.api.domain.BaseDataObject

org.opensrp.api.domain.Location

public class Location
extends BaseDataObject

The registered location which needs to be identified uniquely across the system

Constructor Summary

Constructors

Constructor and Description
Location()
Location(String locationId, String name, Address address, Location parentLocation)
Location(String locationId, String name, Address address, Map<String,String> identifiers, Location parentLocation, Set<String> tags, Map<String,Object> attributes)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String name, Object value)
void	addIdentifier(String identifierType, String identifier)
void	addTag(String tag)
Address	getAddress()
Object	getAttribute(String name)
Map<String,Object>	getAttributes()
String	getIdentifier(String identifierType)
Map<String,String>	getIdentifiers()
String	getLocationId()
String	getName()
Location	getParentLocation()
Set<String>	getTags()
boolean	hasTag(String tag)
void	removeAttribute(String name)
void	removeIdentifier(String identifierType)
boolean	removeTag(String tag)
void	setAddress(Address address)
void	setAttributes(Map<String,Object> attributes) WARNING: Overrides all existing attributes
void	setIdentifiers(Map<String,String> identifiers) WARNING: Overrides all existing identifiers
void	setLocationId(String locationId)
void	setName(String name)
void	setParentLocation(Location parentLocation)
void	setTags(Set<String> tags) WARNING: Overrides all existing tags
String	toString()
Location	withAddress(Address address)
Location	withAttribute(String name, Object value)
Location	withAttributes(Map<String,Object> attributes) WARNING: Overrides all existing attributes
Location	withIdentifier(String identifierType, String identifier)
Location	withIdentifiers(Map<String,String> identifiers) WARNING: Overrides all existing identifiers
Location	withLocationId(String locationId)
Location	withName(String name)
Location	withParentLocation(Location parentLocation)
Location	withTag(String tag)
Location	withTags(Set<String> tags) WARNING: Overrides all existing tags

Methods inherited from class org.opensrp.api.domain.BaseDataObject

getCreator, getDateCreated, getDateEdited, getDateVoided, getEditor, getVoided, getVoider, getVoidReason, setCreator, setDateCreated, setDateEdited, setDateVoided, setEditor, setVoided, setVoider, setVoidReason, withCreator, withDateCreated, withDateEdited, withDateVoided, withEditor, withVoided, withVoider, withVoidReason

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Location

public Location()

Location

public Location(String locationId,
                String name,
                Address address,
                Location parentLocation)

Location

public Location(String locationId,
                String name,
                Address address,
                Map<String,String> identifiers,
                Location parentLocation,
                Set<String> tags,
                Map<String,Object> attributes)

Method Detail

getLocationId

public String getLocationId()

setLocationId

public void setLocationId(String locationId)

getName

public String getName()

setName

public void setName(String name)

getAddress

public Address getAddress()

setAddress

public void setAddress(Address address)

getIdentifiers

public Map<String,String> getIdentifiers()

getIdentifier

public String getIdentifier(String identifierType)

setIdentifiers

public void setIdentifiers(Map<String,String> identifiers)

WARNING: Overrides all existing identifiers

Parameters:

identifiers -

addIdentifier

public void addIdentifier(String identifierType,
                          String identifier)

removeIdentifier

public void removeIdentifier(String identifierType)

getParentLocation

public Location getParentLocation()

setParentLocation

public void setParentLocation(Location parentLocation)

getTags

public Set<String> getTags()

hasTag

public boolean hasTag(String tag)

setTags

public void setTags(Set<String> tags)

WARNING: Overrides all existing tags

Parameters:

tags -

addTag

public void addTag(String tag)

removeTag

public boolean removeTag(String tag)

getAttributes

public Map<String,Object> getAttributes()

getAttribute

public Object getAttribute(String name)

setAttributes

public void setAttributes(Map<String,Object> attributes)

WARNING: Overrides all existing attributes

Parameters:

attributes -

addAttribute

public void addAttribute(String name,
                         Object value)

removeAttribute

public void removeAttribute(String name)

withLocationId

public Location withLocationId(String locationId)

withName

public Location withName(String name)

withAddress

public Location withAddress(Address address)

withIdentifiers

public Location withIdentifiers(Map<String,String> identifiers)

WARNING: Overrides all existing identifiers

Parameters:

identifiers -

Returns:

withIdentifier

public Location withIdentifier(String identifierType,
                               String identifier)

withParentLocation

public Location withParentLocation(Location parentLocation)

withTags

public Location withTags(Set<String> tags)

WARNING: Overrides all existing tags

Parameters:

tags -

Returns:

withTag

public Location withTag(String tag)

withAttributes

public Location withAttributes(Map<String,Object> attributes)

WARNING: Overrides all existing attributes

Parameters:

attributes -

Returns:

withAttribute

public Location withAttribute(String name,
                              Object value)

toString

public String toString()

Overrides:

toString in class BaseDataObject