Package net.simplace.pipe.processors

Class DatasetLoaderProcessor

java.lang.Object

net.simplace.pipe.control.FWProcessor

net.simplace.pipe.processors.DatasetLoaderProcessor

public class DatasetLoaderProcessor
extends FWProcessor

This processor is based on JFreeChart and loads a chart data object (called DataSet) into memory. The following parameters define how the input file shall be processed.

Parameter	Description
type	File.Ascii.Cat: Loads the chart data from an ascii file (e.g. CSV) and creates an creates a DefaultCategoryDataset.
source	Path or URL to input file(s)
destParamKey	The object is stored in out parameters under a given key
tablen (optional)	Number of white spaces a tabulator stands for. Which is critical!! If tabs are used in input file, it is very recommended to set the tablen parameter!

Furthermore following configuration is expected (as a subelement in processor element in the configuration file) to describe the concrete data, that shall be read. Description: rowHeads - used for legend (and dataset diversion). If not specified, heads will be generated. - startCol - at which column the "label" starts (including; starting from 1) - endCol - at which column the "label" ends (including, if not specified, till the end of line) - Note: concrete rows are the same as specified by data element colHeads - used for legend (and dataset diversion). If not specified, heads will be generated. - row - at which row in the file are theses "labels" settled - concrete columns boundaries are the same as specified by each value in the data element data - specifies where the own data are settled in the file - startRow - from which line shall be the data read (including) - endRow - till which line shall be the data read (including; if not specified, till the end of file) - step - (current line + step = next line). default 1. - orientation - supported values are horizontal and vertical. Tells whether the data lies in rows (horizontal) or in columns (vertical). Default is horizontal. value - value which shall be read - startCol - at which column the value starts - endCol - at which column the value ends

Author:

Martin Uhlir

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESTKEY_KEY	Constant for in channel parameter key "DestParamKey".
static final String	SOURCE_KEY	Constant for in-channel parameter key "source".
static final String	TYPE_KEY	Constant for in-channel parameter key "type".
static final String	TYPE_VALUE_FILE_ASCII_CAT	Constant for input type "File.Ascii.Cat".
static final String	TYPE_VALUE_FILE_ASCII_XY	Constant for input type "File.Ascii.XY".

Fields inherited from class net.simplace.pipe.control.FWProcessor

iAllreadyLoopedCount, iContainer, iInObservable, iObservable, iProgressTasks

Constructor Summary

Constructors

Constructor	Description
DatasetLoaderProcessor()

Method Summary

Modifier and Type	Method	Description
boolean	checkInParameterMap()	Checks whether the in-channel contains all required parameters.
protected boolean	process()	Logger for this class

Methods inherited from class net.simplace.pipe.control.FWProcessor

checkOutParameterMap, clone, containsParameter, createProcessor, createProcessor, fireTaskEvent, getAllStringInParameters, getConfiguration, getInitialParameters, getInParameter, getInParameter, getInParameters, getNewProgressTask, getOutParameter, getOutParameterKeys, getPipeLine, getProgressTask, getStringInParameter, getStringInParameter, getSystemID, hasConfiguration, isEndOfPipe, pipe, removeOutParameter, setConfiguration, setEndOfPipeFlag, setInitialParameters, setInParameterMap, setLoopedCount, setOutParameter, setStateOfTask, setStateProgressing, toXML

Methods inherited from class java.lang.Object

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

Field Details

DESTKEY_KEY

public static final String DESTKEY_KEY

Constant for in channel parameter key "DestParamKey".

See Also:

• Constant Field Values

TYPE_KEY

public static final String TYPE_KEY

Constant for in-channel parameter key "type".

See Also:

• Constant Field Values

SOURCE_KEY

public static final String SOURCE_KEY

Constant for in-channel parameter key "source".

See Also:

• Constant Field Values

TYPE_VALUE_FILE_ASCII_XY

public static final String TYPE_VALUE_FILE_ASCII_XY

Constant for input type "File.Ascii.XY". @see XYDataSet

See Also:

• Constant Field Values

TYPE_VALUE_FILE_ASCII_CAT

public static final String TYPE_VALUE_FILE_ASCII_CAT

Constant for input type "File.Ascii.Cat". @see CategoryDataSet

See Also:

• Constant Field Values

Constructor Details

DatasetLoaderProcessor

public DatasetLoaderProcessor()

Method Details

process

protected boolean process()
                   throws PipeLineException

Logger for this class

Specified by:

process in class FWProcessor

Returns:

success

Throws:

PipeLineException

checkInParameterMap

public boolean checkInParameterMap()

Checks whether the in-channel contains all required parameters.

Overrides:

checkInParameterMap in class FWProcessor

Returns:

true if not overridden by implementations