Package adams.gui.tools.spreadsheetprocessor.processors

Class FlowProcessor

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.gui.tools.spreadsheetprocessor.AbstractWidget

adams.gui.tools.spreadsheetprocessor.processors.AbstractProcessor

adams.gui.tools.spreadsheetprocessor.processors.FlowProcessor

All Implemented Interfaces:

LoggingLevelHandler, LoggingSupporter, SizeOfHandler, Serializable, Comparable<AbstractWidget>

public class FlowProcessor
extends AbstractProcessor

Uses a subflow for processing the spreadsheet.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY_FLOW
protected BaseButton	m_ButtonCheck	the "check flow" button.
protected BaseButton	m_ButtonLoad	the "load flow" button.
protected BaseButton	m_ButtonNew	the "new flow" button.
protected BaseButton	m_ButtonRun	the "run flow" button.
protected BaseButton	m_ButtonSave	the "save flow" button.
protected FlowFileChooser	m_FileChooserFlow	the file chooser for the flows.
protected FlowPanel	m_PanelFlow	the flow panel.
protected BasePanel	m_PanelWidget	the widget.

Fields inherited from class adams.gui.tools.spreadsheetprocessor.AbstractWidget

m_Owner

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
FlowProcessor()

Method Summary

Modifier and Type	Method	Description
void	assign(AbstractWidget other)	Retrieves the values from the other widget, if possible.
protected boolean	checkFlow(boolean silent)	Checks the flow.
void	deserialize(Object data, MessageCollection errors)	Deserializes the setup and maps it onto the widget.
protected SpreadSheet	doProcess(SpreadSheet data, MessageCollection errors)	Processes the data.
Actor	getCurrentFlow()	Returns the flow.
String	getName()	Returns the name of the widget.
Component	getWidget()	Returns the widget.
protected void	loadFlow()	Allows the user to load a flow snippet.
protected void	newFlow()	Replaces the current flow snippet with an empty one.
protected void	runFlow()	Runs the flow.
protected void	saveFlow()	Allows the user to save the current flow snippet.
Object	serialize()	Serializes the setup from the widget.
void	setCurrentFlow(Actor value)	Sets the flow.
void	update()	Updates the widget.

Methods inherited from class adams.gui.tools.spreadsheetprocessor.processors.AbstractProcessor

check, process

Methods inherited from class adams.gui.tools.spreadsheetprocessor.AbstractWidget

compareTo, equals, getOwner, notifyOwner, setOwner, toString

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

setLoggingLevel

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

KEY_FLOW

public static final String KEY_FLOW

See Also:

Constant Field Values

m_PanelWidget

protected BasePanel m_PanelWidget

the widget.

m_PanelFlow

protected FlowPanel m_PanelFlow

the flow panel.

m_ButtonNew

protected BaseButton m_ButtonNew

the "new flow" button.

m_ButtonLoad

protected BaseButton m_ButtonLoad

the "load flow" button.

m_ButtonSave

protected BaseButton m_ButtonSave

the "save flow" button.

m_ButtonCheck

protected BaseButton m_ButtonCheck

the "check flow" button.

m_ButtonRun

protected BaseButton m_ButtonRun

the "run flow" button.

m_FileChooserFlow

protected FlowFileChooser m_FileChooserFlow

the file chooser for the flows.

Constructor Detail

FlowProcessor

public FlowProcessor()

Method Detail

getName

public String getName()

Returns the name of the widget.

Specified by:

getName in class AbstractWidget

Returns:

the name

getWidget

public Component getWidget()

Returns the widget.

Specified by:

getWidget in class AbstractWidget

Returns:

the widget

newFlow

protected void newFlow()

Replaces the current flow snippet with an empty one.

loadFlow

protected void loadFlow()

Allows the user to load a flow snippet.

saveFlow

protected void saveFlow()

Allows the user to save the current flow snippet.

checkFlow

protected boolean checkFlow(boolean silent)

Checks the flow.

Parameters:

silent - only pops up a dialog if invalid flow

Returns:

true if flow ok

runFlow

protected void runFlow()

Runs the flow.

setCurrentFlow

public void setCurrentFlow(Actor value)

Sets the flow.

Parameters:

value - the flow

getCurrentFlow

public Actor getCurrentFlow()

Returns the flow.

Returns:

the flow

assign

public void assign(AbstractWidget other)

Retrieves the values from the other widget, if possible.

Specified by:

assign in class AbstractWidget

Parameters:

other - the other widget to get the values from

serialize

public Object serialize()

Serializes the setup from the widget.

Specified by:

serialize in class AbstractWidget

Returns:

the generated setup representation

deserialize

public void deserialize(Object data,
                        MessageCollection errors)

Deserializes the setup and maps it onto the widget. /** Deserializes the setup and maps it onto the widget.

Specified by:

deserialize in class AbstractWidget

Parameters:

data - the setup representation to use

errors - for collecting errors

update

public void update()

Updates the widget.

Specified by:

update in class AbstractWidget

doProcess

protected SpreadSheet doProcess(SpreadSheet data,
                                MessageCollection errors)

Processes the data.

Specified by:

doProcess in class AbstractProcessor

Parameters:

data - the input data

errors - for storing errors

Returns:

the generated data, null in case of an error