fr.cnes.genius.plots

Class GPlotDataMadonaReader

java.lang.Object

fr.cnes.genius.plots.GPlotDataMadonaReader

All Implemented Interfaces:

GPlotDataReaderInterface

public class GPlotDataMadonaReader
extends Object
implements GPlotDataReaderInterface

Class implementing the read of the madona column formatted files for plotting.

Author:

jjct

Constructor Summary

Constructors

Constructor and Description
GPlotDataMadonaReader() Constructor.

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<GPlotColumnInfo>	getColumnsInfo() getter to retrieve all the columns informations
List<String>	getDatasetList() Get the list of data sets in the file.
File	getFile() getter to retrieve file loaded
int	getFirstMadonaIndex() Get the first index in Madona file
int	getNumberColums(String datasetId) Get the number of columns of the data file.
ArrayList<Double[]>	getXYColumns(String datasetId, int xColumn, int yColumn) Get the XY values corresponding to the requested columns.
ArrayList<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[] columnData1, Object[] columnData2) 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.
void	load(File file) Load the file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.genius.plots.GPlotDataReaderInterface

isISODate, parseColumnValue

Constructor Detail

GPlotDataMadonaReader

public GPlotDataMadonaReader()

Constructor.

Method Detail

getColumnsInfo

public List<GPlotColumnInfo> getColumnsInfo()

getter to retrieve all the columns informations

Returns:

a list of GPlotColumnInfo

load

public void load(File file)
          throws GPlotDataReaderException

Load the file.

Specified by:

load in interface GPlotDataReaderInterface

Parameters:

file - file to load.

Throws:

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

getDatasetList

public List<String> getDatasetList()

Get the list of data sets in the file.

Specified by:

getDatasetList in interface GPlotDataReaderInterface

Returns:

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

getNumberColums

public int getNumberColums(String datasetId)

Get the number of columns of the data file.

Specified by:

getNumberColums in interface GPlotDataReaderInterface

Parameters:

datasetId - dataset identifier.

Returns:

the number of columns of the data file.

getColumnInfo

public GPlotColumnInfo getColumnInfo(String datasetId,
                                     int columnIndex)

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

Specified by:

getColumnInfo in interface GPlotDataReaderInterface

Parameters:

datasetId - dataset identifier.

columnIndex - index of the column.

Returns:

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

getColumnInfo

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

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

Specified by:

getColumnInfo in interface GPlotDataReaderInterface

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

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

Get the XY values corresponding to the requested columns.

Specified by:

getXYColumns in interface GPlotDataReaderInterface

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:

ParseException

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

getColumns

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

Get the values corresponding to the requested columns.

Specified by:

getColumns in interface GPlotDataReaderInterface

Parameters:

datasetId - dataset identifier.

columnIndexList - List of indexes of the columns to recover.

Returns:

the array of values corresponding to the colunms.

Throws:

ParseException

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

getXYColumns

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

Get the XY values corresponding to the requested columns.

Specified by:

getXYColumns in interface GPlotDataReaderInterface

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:

ParseException

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

getXYColumnsCalculator

public ArrayList<Double[]> getXYColumnsCalculator(String datasetId,
                                                  String xColumnName,
                                                  String yColumnName,
                                                  Object[] columnData1,
                                                  Object[] columnData2)
                                           throws GPlotDataReaderException

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.

Specified by:

getXYColumnsCalculator in interface GPlotDataReaderInterface

Parameters:

datasetId - dataset identifier.

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

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

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

columnData2 - 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.

getColumns

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

Get the values corresponding to the requested columns.

Specified by:

getColumns in interface GPlotDataReaderInterface

Parameters:

datasetId - dataset identifier.

columnNameList - List of names of the columns to recover.

Returns:

the array of values corresponding to the colunms.

Throws:

ParseException

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

getColumnsAsString

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

Get the values corresponding to the requested columns.

Specified by:

getColumnsAsString in interface GPlotDataReaderInterface

Parameters:

datasetId - dataset identifier.

columnIndexList - List of indexes of the columns to recover.

Returns:

the array of values corresponding to the colunms.

Throws:

ParseException

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

close

public void close()
           throws GPlotDataReaderException

Close the data file.

Specified by:

close in interface GPlotDataReaderInterface

Throws:

GPlotDataReaderException - in case of error closing the data file.

fileIsLoaded

public boolean fileIsLoaded()

Description copied from interface: GPlotDataReaderInterface

Checks if the file is loaded

Specified by:

fileIsLoaded in interface GPlotDataReaderInterface

Returns:

true if the file is loaded

getFirstMadonaIndex

public int getFirstMadonaIndex()

Get the first index in Madona file

Returns:

the first index in Madona file

getFile

public File getFile()

Description copied from interface: GPlotDataReaderInterface

getter to retrieve file loaded

Specified by:

getFile in interface GPlotDataReaderInterface

Returns:

file loaded

addColumnInfo

public void addColumnInfo(ColumnInfo columnInfo)

Description copied from interface: GPlotDataReaderInterface

Method that allows the user to add column information

Specified by:

addColumnInfo in interface GPlotDataReaderInterface

Parameters:

columnInfo - the column information