at.mug.iqm.commons.util.plot

Class PlotParser

java.lang.Object

javax.swing.SwingWorker<Vector<Vector<String>>,Void>

at.mug.iqm.commons.util.plot.PlotParser

All Implemented Interfaces:

Runnable, Future<Vector<Vector<String>>>, RunnableFuture<Vector<Vector<String>>>

public class PlotParser
extends SwingWorker<Vector<Vector<String>>,Void>

This class is responsible for reading Plot(time Series)-data from a given file with a certain format (x header + y data lines, each ends with CR LF) and writing it into 2-dim Vector of type String. Afterwards the Vector is forwarded to an instance of PlotSelectionFrame. Furthermore, this class can be used for extracting specified data (header, unit: e.g. extractColumn(int column), extractData(Vector<Integer> vecRows, Vector<Integer> vecCols)) from given data (setData(Vector<Vector<Double>> data))

Since:

2012 10 14

Author:

Michael Mayrhofer-R., Philipp Kainz

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.SwingWorker

SwingWorker.StateValue

Field Summary

Fields

Modifier and Type	Field and Description
private BufferedReader	buf
private Vector<Vector<String>>	dataString
private Vector<Vector<Double>>	dataValues
private File	file
private FileInputStream	fin
private String[]	headers
private static org.apache.log4j.Logger	logger
private int	numColumns
private int	numRows
private String[]	units

Constructor Summary

Constructors

Constructor and Description
PlotParser() Default constructor.
PlotParser(File file) Constructs a plot parser for a given file.

Method Summary

Modifier and Type	Method and Description
protected Vector<Vector<String>>	doInBackground()
protected void	done()
Vector<Double>	extractColumn(int column)
Vector<Vector<Double>>	extractData(Vector<Integer> vecRows, Vector<Integer> vecCols)
String	extractHeader(int col)
String[]	extractHeaders(Vector<Integer> vecCols)
String	extractUnit(int col)
String[]	extractUnits(Vector<Integer> vecCols)
Vector<Vector<Double>>	getData()
Vector<Vector<String>>	getDataString()
String[]	getHeaders()
Vector<String>	getRowFromDataString(int row)
String[]	getUnits()
Vector<Vector<String>>	parseContent() Parse the file's content into a 2D-Vector array: Vector< Vector<String>>.
void	setData(Vector<Vector<Double>> data)
void	setDataString(Vector<Vector<String>> data)
void	setFile(File file) Sets the file to be parsed.
void	setHeaders(int row)
void	setHeaders(String[] headers)
void	setUnits(int row)
void	setUnits(String[] units)

Methods inherited from class javax.swing.SwingWorker

addPropertyChangeListener, cancel, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, process, publish, removePropertyChangeListener, run, setProgress

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.apache.log4j.Logger logger

file

private File file

numColumns

private int numColumns

numRows

private int numRows

fin

private FileInputStream fin

buf

private BufferedReader buf

headers

private String[] headers

units

private String[] units

dataValues

private Vector<Vector<Double>> dataValues

dataString

private Vector<Vector<String>> dataString

Constructor Detail

PlotParser

public PlotParser()

Default constructor.

PlotParser

public PlotParser(File file)

Constructs a plot parser for a given file.

Parameters:

file - an ASCII encoded plain text file

Method Detail

setFile

public void setFile(File file)

Sets the file to be parsed.

Parameters:

file - the file to be parsed

setData

public void setData(Vector<Vector<Double>> data)

Parameters:

data - Vector<Vector<Double>>

getData

public Vector<Vector<Double>> getData()

Returns:

data Vector<Vector<Double>>

setHeaders

public void setHeaders(String[] headers)

Parameters:

headers - String[]

getHeaders

public String[] getHeaders()

Returns:

headers String[]

setUnits

public void setUnits(String[] units)

Parameters:

units - String[]

getUnits

public String[] getUnits()

Returns:

the units String[]

setDataString

public void setDataString(Vector<Vector<String>> data)

Parameters:

data - Vector<Vector<String>>

getDataString

public Vector<Vector<String>> getDataString()

Returns:

the data Vector<Vector<String>>

setHeaders

public void setHeaders(int row)
                throws ArrayIndexOutOfBoundsException

Parameters:

row - (int) from which to set the headers String[]

Throws:

ArrayIndexOutOfBoundsException

setUnits

public void setUnits(int row)

Parameters:

row - (int) from which to set the units String[]

getRowFromDataString

public Vector<String> getRowFromDataString(int row)

Returns:

the row (int) from the dataString Vector<String>

parseContent

public Vector<Vector<String>> parseContent()

Parse the file's content into a 2D-Vector array: Vector< Vector<String>>. In the end, pass the parsed content on to the PlotSelectionFrame instance in order to enable the user to choose the data.

extractColumn

public Vector<Double> extractColumn(int column)

Returns:

the data of one column (int), all rows Vector<Double>

extractData

public Vector<Vector<Double>> extractData(Vector<Integer> vecRows,
                                          Vector<Integer> vecCols)
                                   throws NumberFormatException

Parameters:

vecRows - the vector of row indices

vecCols - the vector of column indices

Returns:

the data of more columns and rows (Vector<Integer>) Vector<Vector<Double>>

Throws:

NumberFormatException

extractHeaders

public String[] extractHeaders(Vector<Integer> vecCols)

Returns:

the headers from specified columns (Vector<Integer>) String[]

extractUnits

public String[] extractUnits(Vector<Integer> vecCols)

Returns:

the units from specified columns (Vector<Integer>) String[]

extractHeader

public String extractHeader(int col)

Returns:

the header from specified columns (int) String

extractUnit

public String extractUnit(int col)

Returns:

the unit from specified columns (int) String

doInBackground

protected Vector<Vector<String>> doInBackground()
                                         throws Exception

Specified by:

doInBackground in class SwingWorker<Vector<Vector<String>>,Void>

Throws:

Exception

done

protected void done()

Overrides:

done in class SwingWorker<Vector<Vector<String>>,Void>