broadwick.data

Class Lookup

java.lang.Object

broadwick.data.Lookup

public final class Lookup
extends Object

This class works as an interface to the databases holding the movements, locations and animal data read from the configuration file. When the methods to retrieve all the data in the DB (e.g. getMovements()) are called the results are stored in a cache for speedier retrieval. This cache is not permanent however, freeing memory when required.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) com.google.common.cache.Cache<String,Animal>	animalsCache
private Connection	connection
private org.jooq.DSLContext	jooq
(package private) com.google.common.cache.Cache<String,Location>	locationsCache
(package private) com.google.common.cache.Cache<String,Collection<Movement>>	movementsCache
(package private) com.google.common.cache.Cache<String,Test>	testsCache

Constructor Summary

Constructors

Constructor and Description
Lookup(DatabaseImpl dbFacade) Create the lookup object for accessing data in the internal databases.

Method Summary

Modifier and Type	Method and Description
private Animal	createAnimal(org.jooq.Record animalRecord) Create an animal object from the node object defining it in the graph database.
private Location	createLocation(org.jooq.Record locationRecord) Create a location object from the node object defining it in the graph database.
private Movement	createMovement(org.jooq.Record movementRecord) Create a movement object from the relationship object defining it in the graph database.
private Test	createTest(org.jooq.Record testRecord) Create a Test object from the node object defining it in the graph database.
Animal	getAnimal(String animalId) Get an animal from the list of animals in the system.
String	getAnimalLocationIdAtDate(String animalId, int date) Get an animals location at a specified date.
Collection<Animal>	getAnimals() Get all the animals that have been read from the file(s) specified in the configuration file.
Collection<Animal>	getAnimals(int date) Get all the animals that have been read from the file(s) specified in the configuration file whose date of birth is before or on a given date and whose date of death (it there is any) is on or after the same date.
Location	getLocation(String locationId) Get a location from the list of locations in the system.
Collection<Location>	getLocations() Get all the movements that have been read from the file(s) specified in the configuration file.
Collection<Movement>	getMovements() Get all the movements that have been read from the file(s) specified in the configuration file.
Collection<Movement>	getMovements(int startDate, int endDate) Get all the movements that have been read from the file(s) specified in the configuration file filtered on a date range.
Collection<Movement>	getMovementsForAnimal(String animalId) Get all the recorded movements for a given animal.
int	getNumAnimals() Get the number of animals stored in the internal database.
int	getNumLocations() Get the number of locations stored in the internal database.
int	getNumMovements() Get the number of movements stored in the internal database.
int	getNumMovements(int startDate, int endDate) Get the number of movements stored in the internal database filtered on a date range.
int	getNumTests() Get the number of tests stored in the internal database.
Collection<Movement>	getOffMovements(int startDate, int endDate) Get all the OFF movements that have been read from the file(s) specified in the configuration file filtered on a date range.
Collection<Movement>	getOnMovements(int startDate, int endDate) Get all the ON movements that have been read from the file(s) specified in the configuration file filtered on a date range.
Collection<Test>	getTests() Get all the tests that have been read from the file(s) specified in the configuration file.
Collection<Test>	getTests(int startDate, int endDate) Get all the tests that have been read from the file(s) specified in the configuration file.
org.jooq.Result<org.jooq.Record>	runCustomQuery(String query) Run a custom query against the database.

Methods inherited from class java.lang.Object

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

Field Detail

movementsCache

com.google.common.cache.Cache<String,Collection<Movement>> movementsCache

locationsCache

com.google.common.cache.Cache<String,Location> locationsCache

animalsCache

com.google.common.cache.Cache<String,Animal> animalsCache

testsCache

com.google.common.cache.Cache<String,Test> testsCache

jooq

private org.jooq.DSLContext jooq

connection

private Connection connection

Constructor Detail

Lookup

public Lookup(DatabaseImpl dbFacade)

Create the lookup object for accessing data in the internal databases.

Parameters:

dbFacade - the object that is responsible for accessing the internal databases.

Method Detail

getNumTests

public int getNumTests()

Get the number of tests stored in the internal database.

Returns:

the number of tests in the database.

getNumAnimals

public int getNumAnimals()

Get the number of animals stored in the internal database.

Returns:

the number of animals in the database.

getNumLocations

public int getNumLocations()

Get the number of locations stored in the internal database.

Returns:

the number of locations in the database.

getNumMovements

public int getNumMovements()

Get the number of movements stored in the internal database.

Returns:

the number of movements in the database.

getNumMovements

public int getNumMovements(int startDate,
                           int endDate)

Get the number of movements stored in the internal database filtered on a date range.

Parameters:

startDate - the first date in the range with which we will filter the movements

endDate - the final date in the range with which we will filter the movements

Returns:

a collection of movement events that have been recorded.

getMovements

public Collection<Movement> getMovements()

Get all the movements that have been read from the file(s) specified in the configuration file.

Returns:

a collection of movement events that have been recorded.

getMovements

public Collection<Movement> getMovements(int startDate,
                                         int endDate)

Get all the movements that have been read from the file(s) specified in the configuration file filtered on a date range.

Parameters:

startDate - the first date in the range with which we will filter the movements

endDate - the final date in the range with which we will filter the movements

Returns:

a collection of movement events that have been recorded.

getOffMovements

public Collection<Movement> getOffMovements(int startDate,
                                            int endDate)

Get all the OFF movements that have been read from the file(s) specified in the configuration file filtered on a date range.

Parameters:

startDate - the first date in the range with which we will filter the movements

endDate - the final date in the range with which we will filter the movements

Returns:

a collection of movement events that have been recorded.

getOnMovements

public Collection<Movement> getOnMovements(int startDate,
                                           int endDate)

Get all the ON movements that have been read from the file(s) specified in the configuration file filtered on a date range.

Parameters:

startDate - the first date in the range with which we will filter the movements

endDate - the final date in the range with which we will filter the movements

Returns:

a collection of movement events that have been recorded.

getTests

public Collection<Test> getTests()

Get all the tests that have been read from the file(s) specified in the configuration file.

Returns:

a collection of movement events that have been recorded.

getTests

public Collection<Test> getTests(int startDate,
                                 int endDate)

Get all the tests that have been read from the file(s) specified in the configuration file.

Parameters:

startDate - the first date in the range with which we will filter the tests.

endDate - the final date in the range with which we will filter the tests.

Returns:

a collection of movement events that have been recorded.

getAnimals

public Collection<Animal> getAnimals()

Get all the animals that have been read from the file(s) specified in the configuration file.

Returns:

a collection of animal events that have been recorded.

getAnimals

public Collection<Animal> getAnimals(int date)

Get all the animals that have been read from the file(s) specified in the configuration file whose date of birth is before or on a given date and whose date of death (it there is any) is on or after the same date.

Parameters:

date - the date for which we reuqire the animals in the system.

Returns:

a collection of animals that have been recorded whose DoB ≥ date and DoD ≥ date

getLocations

public Collection<Location> getLocations()

Get all the movements that have been read from the file(s) specified in the configuration file.

Returns:

a collection of movement events that have been recorded.

getLocation

public Location getLocation(String locationId)

Get a location from the list of locations in the system. If there is no location matching the id a BroadwickException is thrown because we should only be looking for valid locations. Note, this method returns a live view of the movements so changes to one affect the other and in a worst case scenario can cause a ConcurrentModificationException. The returned collection isn't threadsafe or serializable, even if unfiltered is.

Parameters:

locationId - the id of the location we are looking for.

Returns:

the Location object with the required id.

getAnimal

public Animal getAnimal(String animalId)

Get an animal from the list of animals in the system. If there is no animal matching the id a BroadwickException is thrown because we should only be looking for valid animals. Note, this method returns a live view of the movements so changes to one affect the other and in a worst case scenario can cause a ConcurrentModificationException. The returned collection isn't threadsafe or serializable, even if unfiltered is.

Parameters:

animalId - the id of the animal we are looking for.

Returns:

the Animal object with the required id.

getMovementsForAnimal

public Collection<Movement> getMovementsForAnimal(String animalId)

Get all the recorded movements for a given animal. Note, this method returns a live view of the movements so changes to one affect the other and in a worst case scenario can cause a ConcurrentModificationException. The returned collection isn't threadsafe or serializable, even if unfiltered is.

Parameters:

animalId - the id of the animal whose movements are to be returned.

Returns:

a collection of movement events that have been recorded for the animal with the given id.

getAnimalLocationIdAtDate

public String getAnimalLocationIdAtDate(String animalId,
                                        int date)

Get an animals location at a specified date. If the animal does not have a specified location, e.g. if we are asking for its location before it's born or in the middle of a movement where the departure and destination dates span several days then a null location will be returned.

Parameters:

animalId - the id of the animal.

date - the date for which we want the animals location.

Returns:

the location of the animal on date or Location.getNullLocation if there isn't a valid location.

runCustomQuery

public org.jooq.Result<org.jooq.Record> runCustomQuery(String query)

Run a custom query against the database. This method is not intended to be used in general situations as it exposed the underlying jooq data structures but in some situations it may be used as a last resort.

Parameters:

query - the SQL query to be run.

Returns:

a Result set of records that were returned by the database.

createLocation

private Location createLocation(org.jooq.Record locationRecord)

Create a location object from the node object defining it in the graph database.

Parameters:

locationRecord - the record object from the database defining the location.

Returns:

the created location object.

createAnimal

private Animal createAnimal(org.jooq.Record animalRecord)

Create an animal object from the node object defining it in the graph database.

Parameters:

animalRecord - the record object from the database defining the animal.

Returns:

the created animal object.

createTest

private Test createTest(org.jooq.Record testRecord)

Create a Test object from the node object defining it in the graph database.

Parameters:

testRecord - the record object from the database defining the test.

Returns:

the created test object.

createMovement

private Movement createMovement(org.jooq.Record movementRecord)

Create a movement object from the relationship object defining it in the graph database.

Parameters:

movementRecord - the record object from the database defining the movement.

Returns:

the created movement object.