fr.cnes.genius.plots

Interface GPlotDataReaderInterface

All Known Implementing Classes:

GPlotDataMadonaReader, GPlotDataSqliteReader

public interface GPlotDataReaderInterface

Interface to be implemented by all the data readers to be used with the Plots.

Author:

jjct

Method Summary

Modifier and Type	Method and Description
void	addColumnInfo(ColumnInfo columnInfo) Method that allows the user to add column information
void	close() Close the data file.
boolean	fileIsLoaded() Checks if the file is loaded
GPlotColumnInfo	getColumnInfo(String datasetId, int columnIndex) Get the column information corresponding to the column indicated by the columnIndex.
GPlotColumnInfo	getColumnInfo(String datasetId, String columnName, int columnIndex) Get the column information corresponding to the column indicated by the columnName.
List<Double[]>	getColumns(String datasetId, Integer... columnIndexList) Get the values corresponding to the requested columns.
List<Double[]>	getColumns(String datasetId, String... columnNameList) Get the values corresponding to the requested columns.
List<String[]>	getColumnsAsString(String datasetId, Integer... columnIndexList) Get the values corresponding to the requested columns.
List<String>	getDatasetList() Get the list of data sets in the file.
File	getFile() getter to retrieve file loaded
int	getNumberColums(String datasetId) Get the number of columns of the data file.
List<Double[]>	getXYColumns(String datasetId, int xColumn, int yColumn) Get the XY values corresponding to the requested columns.
List<Double[]>	getXYColumns(String datasetId, String xColumnName, String yColumnName) Get the XY values corresponding to the requested columns.
ArrayList<Double[]>	getXYColumnsCalculator(String datasetId, String xColumnName, String yColumnName, Object[] columnXData, Object[] columnYData) Get the XY values corresponding to the requested columns, to be used when the data for on the two columns is not in a file.
default boolean	isISODate(String line) checks if the string is a date
void	load(File file) Load the file.
default double	parseColumnValue(String valueString) Parse the contents of a column depending on its type.

Method Detail

load

void load(File file)
   throws GPlotDataReaderException

Load the file.

Parameters:

file - file to load.

Throws:

GPlotDataReaderException - in case there is a problem loading the file.

getDatasetList

List<String> getDatasetList()
                     throws GPlotDataReaderException

Get the list of data sets in the file.

Returns:

the list of data sets in the file or null if only one dataset.

Throws:

GPlotDataReaderException - in case of error getting the dataset identifiers from the database.

getNumberColums

int getNumberColums(String datasetId)

Get the number of columns of the data file.

Parameters:

datasetId - dataset identifier.

Returns:

the number of columns of the data file.

getColumnInfo

GPlotColumnInfo getColumnInfo(String datasetId,
                              int columnIndex)

Get the column information corresponding to the column indicated by the columnIndex.

Parameters:

datasetId - dataset identifier.

columnIndex - index of the column.

Returns:

the column information corresponding to the column indicated by the columnIndex.

getColumnInfo

GPlotColumnInfo getColumnInfo(String datasetId,
                              String columnName,
                              int columnIndex)

Get the column information corresponding to the column indicated by the columnName.

Parameters:

datasetId - dataset identifier.

columnName - name of the column.

columnIndex - index of the column.

Returns:

the column information corresponding to the column indicated by the columnName.

getXYColumns

List<Double[]> getXYColumns(String datasetId,
                            int xColumn,
                            int yColumn)
                     throws GPlotDataReaderException

Get the XY values corresponding to the requested columns.

Parameters:

datasetId - dataset identifier.

xColumn - index of the x column to get the values.

yColumn - index of the y column to get the values.

Returns:

the array of XY value paris.

Throws:

GPlotDataReaderException - in case of error reading the column values from the data file.

getColumns

List<Double[]> getColumns(String datasetId,
                          Integer... columnIndexList)
                   throws GPlotDataReaderException

Get the values corresponding to the requested columns.

Parameters:

datasetId - dataset identifier.

columnIndexList - List of indexes of the columns to recover.

Returns:

the array of values corresponding to the colunms.

Throws:

GPlotDataReaderException - in case of error reading the column values from the data file.

getXYColumns

List<Double[]> getXYColumns(String datasetId,
                            String xColumnName,
                            String yColumnName)
                     throws GPlotDataReaderException

Get the XY values corresponding to the requested columns.

Parameters:

datasetId - dataset identifier.

xColumnName - name of the x column to get the values.

yColumnName - name of the y column to get the values.

Returns:

the array of XY value pairs.

Throws:

GPlotDataReaderException - in case of error reading the column values from the data file.

getXYColumnsCalculator

ArrayList<Double[]> getXYColumnsCalculator(String datasetId,
                                           String xColumnName,
                                           String yColumnName,
                                           Object[] columnXData,
                                           Object[] columnYData)
                                    throws GPlotDataReaderException,
                                           ParseException

Get the XY values corresponding to the requested columns, to be used when the data for on the two columns is not in a file.

Parameters:

datasetId - dataset identifier.

xColumnName - name of the x column to get the values.

yColumnName - name of the y column to get the values.

columnXData - Data of the parameter which isnt in the file, is null if Y is the missing column

columnYData - Data of the parameter which isnt in the file, is null if X is the missing column

Returns:

the array of XY value pairs.

Throws:

GPlotDataReaderException - in case of error reading the column values from the data file.

ParseException - in case of error reading the column values from the data file.

getColumns

List<Double[]> getColumns(String datasetId,
                          String... columnNameList)
                   throws GPlotDataReaderException

Get the values corresponding to the requested columns.

Parameters:

datasetId - dataset identifier.

columnNameList - List of names of the columns to recover.

Returns:

the array of values corresponding to the colunms.

Throws:

GPlotDataReaderException - in case of error reading the column values from the data file.

getColumnsAsString

List<String[]> getColumnsAsString(String datasetId,
                                  Integer... columnIndexList)
                           throws GPlotDataReaderException

Get the values corresponding to the requested columns.

Parameters:

datasetId - dataset identifier.

columnIndexList - List of indexes of the columns to recover.

Returns:

the array of values corresponding to the colunms.

Throws:

GPlotDataReaderException - in case of error reading the column values from the data file.

close

void close()
    throws GPlotDataReaderException

Close the data file.

Throws:

GPlotDataReaderException - in case of error closing the data file.

fileIsLoaded

boolean fileIsLoaded()

Checks if the file is loaded

Returns:

true if the file is loaded

getFile

File getFile()

getter to retrieve file loaded

Returns:

file loaded

isISODate

default boolean isISODate(String line)

checks if the string is a date

Parameters:

line - is string

Returns:

true if the string is a date

parseColumnValue

default double parseColumnValue(String valueString)
                         throws ParseException

Parse the contents of a column depending on its type. Columns can be date or real numbers, integers are .

Parameters:

valueString - values to parse as a string.

Returns:

the parsed values as a double.

Throws:

ParseException - in case the values can not be parsed.

addColumnInfo

void addColumnInfo(ColumnInfo columnInfo)

Method that allows the user to add column information

Parameters:

columnInfo - the column information