public interface IFHAESReader
AbstractFireHistoryReader
class.Modifier and Type | Method and Description |
---|---|
java.util.ArrayList<java.lang.Integer> |
getBadDataLineNumbers()
Get ArrayList of line numbers for all data lines that contain errors.
|
int[] |
getBarkIndexPerTree()
Returns an int[] with one entry per sample in the file with each int containing the index to the year in which the bark for the
sample is found.
|
java.util.ArrayList<java.util.ArrayList<java.lang.Character>> |
getCalosperSample2d()
TODO Documentation needed
|
java.util.ArrayList<java.util.ArrayList<java.lang.Integer>> |
getCalosYearperSample2d()
TODO Documentation needed
|
java.util.ArrayList<java.util.ArrayList<java.lang.Character>> |
getCapsperSample2d()
TODO Documentation needed
|
java.util.ArrayList<java.util.ArrayList<java.lang.Integer>> |
getCapsYearperSample2d()
TODO Documentation needed
|
java.util.ArrayList<java.lang.String> |
getData()
Returns an array of strings, each containing the data portion of the FHX file minus any year value on the end.
|
java.util.ArrayList<java.util.ArrayList<java.lang.Integer>> |
getEventDataArrays(EventTypeToProcess eventType)
Get a multi-dimensional array with rows = number of years, and columns = number of samples.
|
java.io.File |
getFile()
Get the file being read.
|
java.lang.String |
getFileFormat()
Get the type of file that is being read.
|
java.util.ArrayList<java.util.ArrayList<java.lang.Double>> |
getFilterArrays(EventTypeToProcess eventType)
Get a multi-dimensional array with rows = number of years, and columns = 3.
|
java.util.ArrayList<java.lang.Integer> |
getFireEventsArray()
Get an ArrayList with length equal to number of years in file, containing Integer codes meaning.
|
java.util.ArrayList<java.lang.Integer> |
getFiresAndInjuriesArray()
Get an ArrayList with length equal to number of years in file, containing Integer codes meaning.
|
java.lang.Integer |
getFirstFireYear()
Get the year in which the first fire is recorded.
|
java.lang.Integer |
getFirstIndicatorYear()
Get the first year in which an indicator is found within this file.
|
java.lang.Integer |
getFirstInjuryYear()
Get the year in which the first injury is found.
|
java.lang.Integer |
getFirstYear()
Get the first year in the file as indicated by the file header.
|
int[] |
getInnerMostperTree()
Get an array containing the index (not year) of the innermost (earliest) ring for each sample.
|
int[] |
getInnerMostYearPerTree()
Get an array containing the year (not index) of the innermost (earliest) ring for each sample.
|
java.lang.Integer |
getLastYear()
Get the last (most recent) year in the file.
|
int[] |
getLastYearIndexPerSample()
Returns an int[] with one entry per sample in the file with each int containing the index to the last year for the sample.
|
int[] |
getLastYearPerSample()
Returns an int[] with one entry per sample in the file with each int containing the year number for the last year in the sample.
|
java.lang.Integer |
getLengthOfSeriesName()
Get the maximum length of the series names specified in the file header.
|
java.lang.String |
getName()
Returns the name of the file being read.
|
java.lang.Integer |
getNumberOfSeries()
Get the number of series contained in this file.
|
java.util.ArrayList<java.lang.Integer> |
getOtherInjuriesArray()
Get an ArrayList with length equal to number of years in file, containing Integer codes meaning.
|
int[] |
getOuterMostYearPerTree()
Get an array containing the year (not index) of the outermost (most recent) ring for each sample.
|
int[] |
getOutterMostperTree()
Get an array containing the index (not year) of the outermost (most recent) ring for each sample.
|
int[] |
getPithIndexPerSample()
Returns an int[] with one entry per sample in the file with each int containing the index to the year in which the pith for the
sample is found.
|
java.util.ArrayList<java.lang.String> |
getRawRowData()
Returns an array of rows containing the raw character data extracted from the data block of the FHX file.
|
java.util.ArrayList<java.util.ArrayList<java.lang.Integer>> |
getRecorderYears2DArray()
Returns a 2D array containing information on when the samples are in recording status or not.
|
java.util.ArrayList<java.lang.String> |
getSeriesNameArray()
Get an ArrayList of the series names from this file.
|
int[] |
getStartYearIndexPerSample()
Returns an int[] with one entry per sample in the file with each int containing the index to the earliest year for the sample.
|
int[] |
getStartYearPerSample()
Returns an int[] with one entry per sample in the file with each int containing the year number for the sample.
|
int[] |
getTotalRecorderYearsPerSample()
Get an int array with one entry per sample in the file with each int containing the count of the number of recorder years.
|
int[] |
getTotals()
TODO Documentation needed
|
java.util.ArrayList<java.lang.Integer> |
getYearArray()
Get an ArrayList of years contained within this file.
|
boolean |
hasFireEvents()
Whether this file contains any fire events.
|
boolean |
hasFireEventsOrInjuries()
Whether this file contains any fire events or injuries.
|
boolean |
hasInjuryEvents()
Whether this file contains any injury events.
|
void |
makeDecompSyb2d()
TODO ????
|
boolean |
passesBasicSyntaxCheck()
Whether the file passes rudimentary syntax checks.
|
java.lang.String getFileFormat()
boolean passesBasicSyntaxCheck()
java.lang.String getName()
java.io.File getFile()
java.lang.Integer getFirstIndicatorYear()
java.lang.Integer getFirstInjuryYear()
java.util.ArrayList<java.lang.Integer> getFireEventsArray()
Get an ArrayList with length equal to number of years in file, containing Integer codes meaning.
java.util.ArrayList<java.lang.Integer> getOtherInjuriesArray()
Get an ArrayList with length equal to number of years in file, containing Integer codes meaning.
java.util.ArrayList<java.lang.Integer> getFiresAndInjuriesArray()
Get an ArrayList with length equal to number of years in file, containing Integer codes meaning.
java.util.ArrayList<java.lang.Integer> getYearArray()
java.util.ArrayList<java.lang.String> getData()
getRawRowData()
java.util.ArrayList<java.lang.String> getRawRowData()
getData()
java.util.ArrayList<java.lang.Integer> getBadDataLineNumbers()
int[] getTotals()
java.util.ArrayList<java.util.ArrayList<java.lang.Integer>> getEventDataArrays(EventTypeToProcess eventType)
Get a multi-dimensional array with rows = number of years, and columns = number of samples. The integer values within the arrays mean the following:
eventType
- java.util.ArrayList<java.util.ArrayList<java.lang.Integer>> getCapsYearperSample2d()
java.util.ArrayList<java.util.ArrayList<java.lang.Integer>> getCalosYearperSample2d()
java.util.ArrayList<java.util.ArrayList<java.lang.Character>> getCapsperSample2d()
java.util.ArrayList<java.util.ArrayList<java.lang.Character>> getCalosperSample2d()
java.util.ArrayList<java.util.ArrayList<java.lang.Double>> getFilterArrays(EventTypeToProcess eventType)
Get a multi-dimensional array with rows = number of years, and columns = 3.
This array is typically used when wanting to filter the data by number of percentage of events.
eventType
- int[] getStartYearIndexPerSample()
getStartYearPerSample()
int[] getStartYearPerSample()
getStartYearIndexPerSample()
int[] getLastYearIndexPerSample()
getLastYearPerSample()
int[] getLastYearPerSample()
getLastYearIndexPerSample()
int[] getPithIndexPerSample()
int[] getTotalRecorderYearsPerSample()
int[] getInnerMostperTree()
getInnerMostYearPerTree()
int[] getInnerMostYearPerTree()
int[] getOutterMostperTree()
int[] getOuterMostYearPerTree()
int[] getBarkIndexPerTree()
java.lang.Integer getFirstYear()
java.util.ArrayList<java.lang.String> getSeriesNameArray()
boolean hasFireEventsOrInjuries()
boolean hasFireEvents()
boolean hasInjuryEvents()
java.lang.Integer getNumberOfSeries()
java.lang.Integer getLengthOfSeriesName()
java.lang.Integer getLastYear()
void makeDecompSyb2d()
java.lang.Integer getFirstFireYear()
java.util.ArrayList<java.util.ArrayList<java.lang.Integer>> getRecorderYears2DArray()