broadwick.data

Class DataReader

java.lang.Object

broadwick.data.DataReader

All Implemented Interfaces:

AutoCloseable

public class DataReader
extends Object
implements AutoCloseable

Utility class to read, store and manipulate the data files.

Field Summary

Fields

Modifier and Type	Field and Description
private Project.Data	data
private DatabaseImpl	dbImpl
private String	dbName
private Lookup	lookup

Constructor Summary

Constructors

Constructor and Description
DataReader(Project.Data data) Create the object that will read the data element of the configuration file.

Method Summary

Modifier and Type	Method and Description
void	close()
private void	logDbStatistics() Save a message giving the numbers of elements in the database.
private int	readAllBatchedMovementSections(List<DataFiles.BatchMovementFile> batchMovementFiles, String addingFileMsg) Read the batched movements sections of the configuration file.
private int	readAllDirectedMovementSections(List<DataFiles.DirectedMovementFile> directedMovementFiles, String addingFileMsg) Read the directed movements sections of the configuration file.
private int	readAllFullMovementSections(List<DataFiles.FullMovementFile> fullMovementFiles, String addingFileMsg) Read the full movements sections of the configuration file.
private int	readAllLocationSections(List<DataFiles.LocationsFile> locationsFile, String addingFileMsg) Read the location sections of the configuration file.
private int	readAllPopulationSections(List<DataFiles.PopulationFile> populationsFiles, String addingFileMsg) Read the populations sections of the configuration file.
private int	readAllTestSections(List<DataFiles.TestsFile> testsFile, String addingFileMsg) Read the test sections of the configuration file.
private void	readDataFiles(DataFiles files) Read the datafiles, each section type of the element (e.g.
void	readDataSection() Read the data section from the configuration file.
protected void	updateSectionDefiniton(String elementName, int indexInDataFile, Map<String,Integer> keyValueMapping, StringBuilder errors, boolean recordErrors, String sectionName) Add a description of a configuration file section to an internal key value pair so that the correct column of a data file can be read.

Methods inherited from class java.lang.Object

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

Field Detail

lookup

private Lookup lookup

data

private Project.Data data

dbImpl

private DatabaseImpl dbImpl

dbName

private String dbName

Constructor Detail

DataReader

public DataReader(Project.Data data)

Create the object that will read the data element of the configuration file.

Parameters:

data - the element of the configuration file.

Method Detail

readDataSection

public final void readDataSection()

Read the data section from the configuration file. If a database section is found then it is used and any files specified are ignored.

close

public final void close()

Specified by:

close in interface AutoCloseable

logDbStatistics

private void logDbStatistics()

Save a message giving the numbers of elements in the database.

readDataFiles

private void readDataFiles(DataFiles files)

Read the datafiles, each section type of the element (e.g. all the s) are read in parallel and each individual element is its read in parallel with the data saved to an internal database. Once the datafiles have been read some post-processing is run to determine the locations of individuals at each time step throughout the simulation.

Parameters:

files - the Datafiles object from the configuration file.

updateSectionDefiniton

protected final void updateSectionDefiniton(String elementName,
                                            int indexInDataFile,
                                            Map<String,Integer> keyValueMapping,
                                            StringBuilder errors,
                                            boolean recordErrors,
                                            String sectionName)

Add a description of a configuration file section to an internal key value pair so that the correct column of a data file can be read. Each section in the configuration contains an element and the column location in the data file where this element can be found. This method update a key-value pair of the element name and location, recording errors as it finds them.

Parameters:

elementName - the name of the element in the configuration file.

indexInDataFile - the location of the element in each row of the data file.

keyValueMapping - a table of the keyValueMapping name index and type.

errors - a description of any parsing errors found.

recordErrors - flag to control whether or not error are recorded in the errors parameter.

sectionName - the name of the section from which the element being added to the table has been read.

readAllDirectedMovementSections

private int readAllDirectedMovementSections(List<DataFiles.DirectedMovementFile> directedMovementFiles,
                                            String addingFileMsg)

Read the directed movements sections of the configuration file.

Parameters:

directedMovementFiles - a collection of directedMovement sections.

addingFileMsg - formatted string (in the form "Adding %s to reading list") to be added to log files.

Returns:

the number of movements read.

readAllFullMovementSections

private int readAllFullMovementSections(List<DataFiles.FullMovementFile> fullMovementFiles,
                                        String addingFileMsg)

Read the full movements sections of the configuration file.

Parameters:

fullMovementFiles - a collection of fullMovement sections.

addingFileMsg - formatted string (in the form "Adding %s to reading list") to be added to log files.

Returns:

the number of movements read.

readAllBatchedMovementSections

private int readAllBatchedMovementSections(List<DataFiles.BatchMovementFile> batchMovementFiles,
                                           String addingFileMsg)

Read the batched movements sections of the configuration file.

Parameters:

batchMovementFiles - a collection of batchMovement sections.

addingFileMsg - formatted string (in the form "Adding %s to reading list") to be added to log files.

Returns:

the number of movements read.

readAllLocationSections

private int readAllLocationSections(List<DataFiles.LocationsFile> locationsFile,
                                    String addingFileMsg)

Read the location sections of the configuration file.

Parameters:

locationsFile - a collection of locations sections.

addingFileMsg - formatted string (in the form "Adding %s to reading list") to be added to log files.

Returns:

the number of locations read.

readAllTestSections

private int readAllTestSections(List<DataFiles.TestsFile> testsFile,
                                String addingFileMsg)

Read the test sections of the configuration file.

Parameters:

testsFile - a collection of locations sections.

addingFileMsg - formatted string (in the form "Adding %s to reading list") to be added to log files.

Returns:

the number of tests read.

readAllPopulationSections

private int readAllPopulationSections(List<DataFiles.PopulationFile> populationsFiles,
                                      String addingFileMsg)

Read the populations sections of the configuration file.

Parameters:

populationsFiles - a collection of populations sections.

addingFileMsg - formatted string (in the form "Adding %s to reading list") to be added to log files.

Returns:

the number of populations read.