Package de.ipk_gatersleben.ag_nw.graffiti.plugins.gui.layout_control.dbe

Class ExperimentDataFileReader

java.lang.Object

de.ipk_gatersleben.ag_nw.graffiti.plugins.gui.layout_control.dbe.ExperimentDataFileReader

All Implemented Interfaces:

BackgroundTaskStatusProvider

Direct Known Subclasses:

DBEinputFileReader, GeneExpressionFileReader

public abstract class ExperimentDataFileReader
extends Object
implements BackgroundTaskStatusProvider

Constructor Summary

Constructors

Constructor	Description
ExperimentDataFileReader()

Method Summary

Modifier and Type	Method	Description
static TableData	getCSVdata(File textFile, ArrayList<String> arrayList, BackgroundTaskStatusProviderSupportingExternalCall optStatus)
String	getCurrentStatusMessage1()	Returns a status message on what is going on.
String	getCurrentStatusMessage2()	Returns a status message on what is going on.
int	getCurrentStatusValue()	Returns the completion status.
double	getCurrentStatusValueFine()	Same as getCurrentStatusValue(), but this method should return a finer granted progress value.
static TableData	getExcelTableData(BufferedReader csvFile, int maximumRowToBeProcessed, ArrayList<TextFileColumnInformation> optValidColumns, BackgroundTaskStatusProviderSupportingExternalCall optStatus)
static TableData	getExcelTableData(File excelFile)
static TableData	getExcelTableData(File excelFile, int maximumRowToBeProcessed, ArrayList<TextFileColumnInformation> optValidColumns, BackgroundTaskStatusProviderSupportingExternalCall optStatus)
static TableData	getExcelTableData(File excelFile, ArrayList<String> optRelevantColumn)
static TableData	getExcelTableData(String tableData, int maximumRowToBeProcessed, ArrayList<TextFileColumnInformation> optValidColumns, BackgroundTaskStatusProviderSupportingExternalCall optStatus)
static TableData	getExcelTableDataPeak(File excelFile, int maximumRowToBeProcessed)
ExperimentInterface	getXMLdata(File excelFile, TableData myData, BackgroundTaskStatusProviderSupportingExternalCall statusProvider)
abstract ExperimentInterface	getXMLDataFromExcelTable(File excelFile, TableData myData, BackgroundTaskStatusProviderSupportingExternalCall statusProvider)
void	pleaseContinueRun()	This method is called as soon as the user indicates that he is comfortable to let the algorithm continue its work.
void	pleaseStop()	If this method is called on the status provider, the linked work task should stop its execution as soon as possible.
boolean	pluginWaitsForUser()
void	setCoordinator(String desiredCoordinatorValue)
void	setCurrentStatusValue(int value)	Override this method and pass a implementor of this interface to any other service method.
void	setExperimentName(String desiredExperimentName)
void	setMeasurementUnit(String desiredMeasurementUnit)
void	setTimeUnit(String desiredTimeUnit)

Methods inherited from class java.lang.Object

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

Constructor Details

ExperimentDataFileReader

public ExperimentDataFileReader()

Method Details

getExcelTableData

public static TableData getExcelTableData(File excelFile)

getExcelTableData

public static TableData getExcelTableData(File excelFile,
ArrayList<String> optRelevantColumn)

getExcelTableDataPeak

public static TableData getExcelTableDataPeak(File excelFile,
int maximumRowToBeProcessed)

getExcelTableData

public static TableData getExcelTableData(File excelFile,
int maximumRowToBeProcessed,
ArrayList<TextFileColumnInformation> optValidColumns,
BackgroundTaskStatusProviderSupportingExternalCall optStatus)

getExcelTableData

public static TableData getExcelTableData(String tableData,
int maximumRowToBeProcessed,
ArrayList<TextFileColumnInformation> optValidColumns,
BackgroundTaskStatusProviderSupportingExternalCall optStatus)

getExcelTableData

public static TableData getExcelTableData(BufferedReader csvFile,
int maximumRowToBeProcessed,
ArrayList<TextFileColumnInformation> optValidColumns,
BackgroundTaskStatusProviderSupportingExternalCall optStatus)

getCSVdata

public static TableData getCSVdata(File textFile,
ArrayList<String> arrayList,
BackgroundTaskStatusProviderSupportingExternalCall optStatus)

getXMLdata

public ExperimentInterface getXMLdata(File excelFile,
TableData myData,
BackgroundTaskStatusProviderSupportingExternalCall statusProvider)

getXMLDataFromExcelTable

public abstract ExperimentInterface getXMLDataFromExcelTable(File excelFile,
TableData myData,
BackgroundTaskStatusProviderSupportingExternalCall statusProvider)

getCurrentStatusValue

public int getCurrentStatusValue()

Description copied from interface: BackgroundTaskStatusProvider

Returns the completion status. WARNING: This method must be Thread-Safe!

Specified by:

getCurrentStatusValue in interface BackgroundTaskStatusProvider

Returns:

A number from 0..100 which represents the completion status. If -1 is returned, the progress bar is set to "indeterminate", which means, that the progress bar will float from left to right and reverse. (Useful if status can not be determined) Other values let the progressbar disappear.

setCurrentStatusValue

public void setCurrentStatusValue(int value)

Description copied from interface: BackgroundTaskStatusProvider

Override this method and pass a implementor of this interface to any other service method. This method can use this call to update the status value.

Specified by:

setCurrentStatusValue in interface BackgroundTaskStatusProvider

getCurrentStatusValueFine

public double getCurrentStatusValueFine()

Description copied from interface: BackgroundTaskStatusProvider

Same as getCurrentStatusValue(), but this method should return a finer granted progress value. If this is not needed, the code for getCurrentStatusValue() could be reused by the client.

Specified by:

getCurrentStatusValueFine in interface BackgroundTaskStatusProvider

Returns:

The current progress value (fine).

getCurrentStatusMessage1

public String getCurrentStatusMessage1()

Description copied from interface: BackgroundTaskStatusProvider

Returns a status message on what is going on. WARNING: This method must be Thread-Safe!

Specified by:

getCurrentStatusMessage1 in interface BackgroundTaskStatusProvider

Returns:

A status message, or null if not needed.

getCurrentStatusMessage2

public String getCurrentStatusMessage2()

Description copied from interface: BackgroundTaskStatusProvider

Returns a status message on what is going on. Is used the same like getCurrentStatusMessage1. This second message adds flexibility. If not needed, the first message should be used and this should return null if not needed. WARNING: This method must be Thread-Safe!

Specified by:

getCurrentStatusMessage2 in interface BackgroundTaskStatusProvider

Returns:

A status message, or null if not needed.

pleaseStop

public void pleaseStop()

Description copied from interface: BackgroundTaskStatusProvider

If this method is called on the status provider, the linked work task should stop its execution as soon as possible.

Specified by:

pleaseStop in interface BackgroundTaskStatusProvider

pluginWaitsForUser

public boolean pluginWaitsForUser()

Specified by:

pluginWaitsForUser in interface BackgroundTaskStatusProvider

Returns:

Let this method return true in order to show a "Continue" button in the GUI. When this buttons is clicked, the method pleaseContinueRun is called. Use these two methods to let the user interact with the GUI while the algorithm is waiting for the user to be ready for the continued work of the algorithm.

pleaseContinueRun

public void pleaseContinueRun()

Description copied from interface: BackgroundTaskStatusProvider

This method is called as soon as the user indicates that he is comfortable to let the algorithm continue its work.

Specified by:

pleaseContinueRun in interface BackgroundTaskStatusProvider

setCoordinator

public void setCoordinator(String desiredCoordinatorValue)

setExperimentName

public void setExperimentName(String desiredExperimentName)

setTimeUnit

public void setTimeUnit(String desiredTimeUnit)

setMeasurementUnit

public void setMeasurementUnit(String desiredMeasurementUnit)