org.sourceforge.vlibrary.user.dao

Class LocationDAO

java.lang.Object

org.sourceforge.vlibrary.user.dao.LocationDAO

public class LocationDAO
extends Object

Version:

$Revision$ $Date$

Constructor Summary

Constructors

Constructor and Description
LocationDAO()

Method Summary

Modifier and Type	Method and Description
String	getLocationDescription(long id) Gets the description of the dropoff location with the given ID
Long	getLocationIdByDescription(Location location) Looks up a location in the database by its description.
ArrayList<Location>	getLocations() Retrieves all locations from the database
Location	insert(Location location) Inserts a location into the database and updates the ID of the input location parameter.
void	insertNewLocationRecord(Location location) Inserts a new location record into the database, using description field in location input parameter.
void	setInsertLocationSQL(String insertLocationSQL) Used for Spring Dependency Injection
void	setJdbcTemplate(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate) Used for Spring Dependency Injection
void	setLocationIds(ArrayList<Location> locations) Walks input ArrayList, looking up and setting ID properties for each Location in the list.
void	setResourceBundleMessageSource(org.springframework.context.support.ResourceBundleMessageSource resourceBundleMessageSource) Used for Spring Dependency Injection
void	setSelectAllLocationsSQL(String selectAllLocationsSQL) Used for Spring Dependency Injection
void	setSelectLocationOnDescriptionSQL(String selectLocationOnDescriptionSQL) Used for Spring Dependency Injection

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationDAO

public LocationDAO()

Method Detail

setResourceBundleMessageSource

public void setResourceBundleMessageSource(org.springframework.context.support.ResourceBundleMessageSource resourceBundleMessageSource)

Used for Spring Dependency Injection

setInsertLocationSQL

public void setInsertLocationSQL(String insertLocationSQL)

Used for Spring Dependency Injection

setSelectAllLocationsSQL

public void setSelectAllLocationsSQL(String selectAllLocationsSQL)

Used for Spring Dependency Injection

setSelectLocationOnDescriptionSQL

public void setSelectLocationOnDescriptionSQL(String selectLocationOnDescriptionSQL)

Used for Spring Dependency Injection

setJdbcTemplate

public void setJdbcTemplate(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate)

Used for Spring Dependency Injection

Parameters:

jdbcTemplate - The jdbcTemplate to set.

getLocationIdByDescription

public Long getLocationIdByDescription(Location location)
                                throws LibraryException

Looks up a location in the database by its description. Returned Long instance wraps the subject ID. Returns null if there is no subject with the given description.

Parameters:

subject - Subject instance whose (trimmed) description field is used as the key in the lookup

Returns:

Long object wrapping the subject id, if found; null otherwise

Throws:

LibraryException - if subject is null or has null description

insertNewLocationRecord

public void insertNewLocationRecord(Location location)
                             throws LibraryException

Inserts a new location record into the database, using description field in location input parameter. ID will be generated by the database engine and is not updated on the input parameter.

Parameters:

subject - The new Subject to insert

Throws:

LibraryException - if required fields are missing or an SQL error occurs

insert

public Location insert(Location location)
                throws LibraryException

Inserts a location into the database and updates the ID of the input location parameter. First checks to see if a location with same description exists. If so, no insert is performed, but id is updated to the id of the previously existing record. If the location is new, a record with the given description is inserted and the ID of the input location instance is updated to the ID of the newly inserted record.

Parameters:

location - The Location to insert

Returns:

fully populated Location object, incl location id

Throws:

LibraryException - if location is null or has null description or a database access error occurs

getLocationDescription

public String getLocationDescription(long id)
                              throws LibraryException

Gets the description of the dropoff location with the given ID

Parameters:

id - ID of the location

Returns:

human-readable description of the dropoff location

Throws:

LibraryException - if there is no location with the given ID or an exception occurs retrieving data

getLocations

public ArrayList<Location> getLocations()
                                 throws LibraryException

Retrieves all locations from the database

Returns:

ArrayList of Location instances, if none found returns an empty ArrayList

Throws:

LibraryException

setLocationIds

public void setLocationIds(ArrayList<Location> locations)
                    throws LibraryException

Walks input ArrayList, looking up and setting ID properties for each Location in the list. Lookup is based on description property. If a Location is not found, a new entry is inserted into the database and the ID of the newly created record is assigned to the instance.

Parameters:

locations - ArrayList of Locations

Throws:

LibraryException