org.openmrs.api.db

Interface LocationDAO

All Known Implementing Classes:

HibernateLocationDAO

public interface LocationDAO

Location-related database functions

Method Summary

Modifier and Type	Method and Description
void	deleteLocation(Location location) Completely remove the location from the database.
void	deleteLocationAttributeType(LocationAttributeType locationAttributeType)
void	deleteLocationTag(LocationTag tag) Completely remove the location tag from the database.
List<LocationAttributeType>	getAllLocationAttributeTypes()
List<Location>	getAllLocations(boolean includeRetired) Get all locations
List<LocationTag>	getAllLocationTags(boolean includeRetired) Get all location tags
Long	getCountOfLocations(String nameFragment, Boolean includeRetired)
Location	getLocation(Integer locationId) Get a location by locationId
Location	getLocation(String name) Get a location by name
LocationAttribute	getLocationAttributeByUuid(String uuid)
LocationAttributeType	getLocationAttributeType(Integer id)
LocationAttributeType	getLocationAttributeTypeByName(String name)
LocationAttributeType	getLocationAttributeTypeByUuid(String uuid)
Location	getLocationByUuid(String uuid)
List<Location>	getLocations(String nameFragment, Location parent, Map<LocationAttributeType,String> serializedAttributeValues, boolean includeRetired, Integer start, Integer length) Gets the locations matching the specified arguments
List<Location>	getLocationsHavingAllTags(List<LocationTag> locationTagIdList) Get locations that have all the location tags specified.
LocationTag	getLocationTag(Integer locationTagId) Get a location tag by locationTagId
LocationTag	getLocationTagByName(String tag) Get a location tag by name
LocationTag	getLocationTagByUuid(String uuid)
List<LocationTag>	getLocationTags(String search) Find all location tags with matching names.
List<Location>	getRootLocations(boolean includeRetired)
Location	saveLocation(Location location) Create or update a location.
LocationAttributeType	saveLocationAttributeType(LocationAttributeType locationAttributeType)
LocationTag	saveLocationTag(LocationTag tag) Create or update a location tag.
void	setSessionFactory(org.hibernate.SessionFactory sessionFactory) Set the Hibernate SessionFactory to connect to the database.

Method Detail

setSessionFactory

void setSessionFactory(org.hibernate.SessionFactory sessionFactory)

Set the Hibernate SessionFactory to connect to the database.

Parameters:

sessionFactory -

saveLocation

Location saveLocation(Location location)

Create or update a location.

Parameters:

location - Location to save

Returns:

the saved Location

getLocation

Location getLocation(Integer locationId)

Get a location by locationId

Parameters:

locationId - Internal Integer identifier of the Location to get

Returns:

the requested Location

getLocation

Location getLocation(String name)

Get a location by name

Parameters:

name - String name of the Location to get

Returns:

the requested Location

getAllLocations

List<Location> getAllLocations(boolean includeRetired)

Get all locations

Parameters:

includeRetired - boolean - include retired locations as well?

Returns:

List<Location> object of all Locations, possibly including retired locations

getLocations

List<Location> getLocations(String nameFragment,
                            Location parent,
                            Map<LocationAttributeType,String> serializedAttributeValues,
                            boolean includeRetired,
                            Integer start,
                            Integer length)
                     throws DAOException

Gets the locations matching the specified arguments

Parameters:

nameFragment - is the string used to search for locations

parent - only return children of this parent

serializedAttributeValues - the serialized attribute values

includeRetired - specifies if retired locations should also be returned

start - the beginning index

length - the number of matching locations to return

Returns:

the list of locations

Throws:

DAOException

deleteLocation

void deleteLocation(Location location)

Completely remove the location from the database.

Parameters:

location - Location object to delete

saveLocationTag

LocationTag saveLocationTag(LocationTag tag)

Create or update a location tag.

Parameters:

tag -

Returns:

the saved LocationTag

getLocationTag

LocationTag getLocationTag(Integer locationTagId)

Get a location tag by locationTagId

Parameters:

locationTagId - Internal Integer identifier of the tag to get

Returns:

the requested LocationTag

getLocationTagByName

LocationTag getLocationTagByName(String tag)

Get a location tag by name

Parameters:

tag - String representation of the LocationTag to get

Returns:

the requested LocationTag

getAllLocationTags

List<LocationTag> getAllLocationTags(boolean includeRetired)

Get all location tags

Parameters:

includeRetired - boolean - include retired tags as well?

Returns:

List<LocationTag> object with all LocationTags, possibly included retired ones

getLocationTags

List<LocationTag> getLocationTags(String search)

Find all location tags with matching names.

Parameters:

search - name to search

Returns:

List<LocationTag> with all matching LocationTags

deleteLocationTag

void deleteLocationTag(LocationTag tag)

Completely remove the location tag from the database.

Parameters:

tag - The LocationTag to delete

getLocationByUuid

Location getLocationByUuid(String uuid)

Parameters:

uuid - the uuid to look for

Returns:

location matching uuid

getLocationTagByUuid

LocationTag getLocationTagByUuid(String uuid)

Parameters:

uuid -

Returns:

location tag or null

getCountOfLocations

Long getCountOfLocations(String nameFragment,
                         Boolean includeRetired)

See Also:

LocationService.getCountOfLocations(String, Boolean)

getRootLocations

List<Location> getRootLocations(boolean includeRetired)

See Also:

LocationService.getRootLocations(boolean)

getAllLocationAttributeTypes

List<LocationAttributeType> getAllLocationAttributeTypes()

See Also:

LocationService.getAllLocationAttributeTypes()

getLocationAttributeType

LocationAttributeType getLocationAttributeType(Integer id)

See Also:

LocationService.getLocationAttributeType(Integer)

getLocationAttributeTypeByUuid

LocationAttributeType getLocationAttributeTypeByUuid(String uuid)

See Also:

LocationService.getLocationAttributeTypeByUuid(String)

saveLocationAttributeType

LocationAttributeType saveLocationAttributeType(LocationAttributeType locationAttributeType)

See Also:

LocationService.saveLocationAttributeType(LocationAttributeType)

deleteLocationAttributeType

void deleteLocationAttributeType(LocationAttributeType locationAttributeType)

See Also:

LocationService.purgeLocationAttributeType(LocationAttributeType)

getLocationAttributeByUuid

LocationAttribute getLocationAttributeByUuid(String uuid)

See Also:

LocationService.getLocationAttributeByUuid(String)

getLocationAttributeTypeByName

LocationAttributeType getLocationAttributeTypeByName(String name)

See Also:

LocationService.getLocationAttributeTypeByName(String)

getLocationsHavingAllTags

List<Location> getLocationsHavingAllTags(List<LocationTag> locationTagIdList)

Get locations that have all the location tags specified.

Parameters:

locationTagIdList -

Returns:

list of locations Should get locations having all tags Should return empty list when no location has the given tags Should ignore null values in location tag list