DirectedMovementsFileReader (Broadwick 1.2 API)

java.lang.Object
- broadwick.data.readers.DataFileReader
- - broadwick.data.readers.DirectedMovementsFileReader

```
public class DirectedMovementsFileReader
extends DataFileReader
```
Reader for the files describing the directed movements (i.e. those that only have a location and a movement_ON or movement_OFF flag)for the simulation. The movements are read and stored in internal databases for later use.

Field Summary

Fields
Modifier and Type	Field and Description
`private StringBuilder`	`createTableCommand`
`private DatabaseImpl`	`database`
`private String`	`dataFile`
`private Collection<Integer>`	`dateFields`
`private String`	`dateFormat`
`private static String`	`ID`
`private Map<String,Integer>`	`insertedColInfo`
`private String`	`insertString`
`private static String`	`LOCATION_ID`
`private static String`	`MOVEMENT_DATE`
`private static String`	`MOVEMENT_DIRECTION`
`private static String`	`SECTION_NAME`
`private static String`	`SPECIES`
`private static String`	`TABLE_NAME`

Constructor Summary

Constructors
Constructor and Description
`DirectedMovementsFileReader(DataFiles.DirectedMovementFile movementFile, DatabaseImpl dbImpl)` Create the movement file reader.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

int insert()
Insert the data from the input file into the database.
- Methods inherited from class broadwick.data.readers.DataFileReader
  asCsv, asQuestionCsv, createTable, insert, updateCreateTableCommand
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`insert()` Insert the data from the input file into the database.

- Field Detail
  - database
```
private DatabaseImpl database
```
  - dataFile
```
private String dataFile
```
  - dateFormat
```
private String dateFormat
```
  - TABLE_NAME
```
private static final String TABLE_NAME
```
    See Also:
    
    Constant Field Values
  - createTableCommand
```
private StringBuilder createTableCommand
```
  - insertString
```
private String insertString
```
  - insertedColInfo
```
private Map<String,Integer> insertedColInfo
```
  - dateFields
```
private Collection<Integer> dateFields
```
  - ID
```
private static final String ID
```
    See Also:
    
    Constant Field Values
  - SPECIES
```
private static final String SPECIES
```
    See Also:
    
    Constant Field Values
  - LOCATION_ID
```
private static final String LOCATION_ID
```
    See Also:
    
    Constant Field Values
  - MOVEMENT_DATE
```
private static final String MOVEMENT_DATE
```
    See Also:
    
    Constant Field Values
  - MOVEMENT_DIRECTION
```
private static final String MOVEMENT_DIRECTION
```
    See Also:
    
    Constant Field Values
  - SECTION_NAME
```
private static final String SECTION_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DirectedMovementsFileReader
```
public DirectedMovementsFileReader(DataFiles.DirectedMovementFile movementFile,
                                   DatabaseImpl dbImpl)
```
    Create the movement file reader.
    
    Parameters:
    
    movementFile - the [XML] tag of the config file that is to be read.
    
    dbImpl - the implementation of the database object.
- Method Detail
  - insert
```
public final int insert()
```
    Insert the data from the input file into the database. The data structure has been read and the database set up already so this method simply reads the file and extracts the relevant information, storing it in the database.
    
    Specified by:
    
    insert in class DataFileReader
    
    Returns:
    
    the number of rows read

Class DirectedMovementsFileReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class broadwick.data.readers.DataFileReader

Methods inherited from class java.lang.Object

Field Detail

database

dataFile

dateFormat

TABLE_NAME

createTableCommand

insertString

insertedColInfo

dateFields

ID

SPECIES

LOCATION_ID

MOVEMENT_DATE

MOVEMENT_DIRECTION

SECTION_NAME

Constructor Detail

DirectedMovementsFileReader

Method Detail

insert