Package de.ipk_gatersleben.ag_nw.graffiti.plugins.algorithms.data_mapping

Class DataMapping

java.lang.Object

org.graffiti.plugin.algorithm.AbstractAlgorithm

org.graffiti.plugin.algorithm.AbstractEditorAlgorithm

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

de.ipk_gatersleben.ag_nw.graffiti.plugins.algorithms.data_mapping.DataMapping

All Implemented Interfaces:

ExperimentDataProcessor, UndoableEdit, Algorithm, EditorAlgorithm

public class DataMapping
extends AbstractExperimentDataProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataMapping.ShowMappingResults

Constructor Summary

Constructors

Constructor	Description
DataMapping()
DataMapping(boolean register)

Method Summary

Modifier and Type	Method	Description
boolean	activeForView(View v)
void	execute()	Should not be overridden, only in case processData() uses a background thread.
String	getDescription()	The algorithm description.
ImageIcon	getIcon()	Returns the icon of the algorithm (used, e.g.
String	getName()	Returns the name (ID) of the algorithm.
Parameter[]	getParameters()	Returns a list of Parameter that are set for this algorithm.
Set<Category>	getSetCategory()	Returns a set of categories to classify this algorithm .
String	getShortName()
boolean	isSupressReset()
boolean	mayWorkOnMultipleGraphs()
void	processData()
void	reset()	Resets the internal state of the algorithm.
void	setActionEvent(ActionEvent a)
void	setDoShowResult(DataMapping.ShowMappingResults showResult)
void	setExperimentData(ExperimentInterface md)	Perform data mapping (or something else).
void	setParameters(Parameter[] params)	Sets the parameters for this algorithm.
void	setSupressReset(boolean supressReset)
DataMapping.ShowMappingResults	showResult()

Methods inherited from class de.ipk_gatersleben.ag_nw.graffiti.plugins.gui.layout_control.dbe.AbstractExperimentDataProcessor

addPostProcessor, getAnnotations, removePostProcessor, setComponent

Methods inherited from class org.graffiti.plugin.algorithm.AbstractEditorAlgorithm

getParameterDialog

Methods inherited from class org.graffiti.plugin.algorithm.AbstractAlgorithm

addEdit, attach, canRedo, canUndo, check, die, doesUndo, getAcceleratorKeyStroke, getActionEvent, getCategory, getMenuCategory, getPresentationName, getRedoPresentationName, getUndoPresentationName, isAlwaysExecutable, isLayoutAlgorithm, isSignificant, markExecutionDone, markRedoDone, markUndoDone, redo, replaceEdit, showMenuIcon, undo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graffiti.plugin.algorithm.Algorithm

attach, check, getAcceleratorKeyStroke, getActionEvent, getCategory, getMenuCategory, isLayoutAlgorithm, showMenuIcon

Constructor Details

DataMapping

public DataMapping()

DataMapping

public DataMapping(boolean register)

Method Details

setExperimentData

public void setExperimentData(ExperimentInterface md)

Description copied from interface: ExperimentDataProcessor

Perform data mapping (or something else).

Specified by:

setExperimentData in interface ExperimentDataProcessor

Specified by:

setExperimentData in class AbstractExperimentDataProcessor

Parameters:

md - Experiment data (XML)

execute

public void execute()

Description copied from class: AbstractExperimentDataProcessor

Should not be overridden, only in case processData() uses a background thread. In this case the postProcessors and the setExperimentData() call should be executed by your code as soon as the background processing is finished.

Specified by:

execute in interface Algorithm

Overrides:

execute in class AbstractExperimentDataProcessor

activeForView

public boolean activeForView(View v)

getDescription

public String getDescription()

Description copied from class: AbstractAlgorithm

The algorithm description.

Specified by:

getDescription in interface Algorithm

Overrides:

getDescription in class AbstractAlgorithm

Returns:

String, could be HTML-styled.

getParameters

public Parameter[] getParameters()

Description copied from interface: Algorithm

Returns a list of Parameter that are set for this algorithm.

Specified by:

getParameters in interface Algorithm

Overrides:

getParameters in class AbstractAlgorithm

Returns:

a collection of Parameter that are needed by the Algorithm.

setParameters

public void setParameters(Parameter[] params)

Description copied from interface: Algorithm

Sets the parameters for this algorithm. Must have the same types and order as the array returned by getParameter.

Specified by:

setParameters in interface Algorithm

Overrides:

setParameters in class AbstractAlgorithm

Parameters:

params - Parameter array

setActionEvent

public void setActionEvent(ActionEvent a)

Specified by:

setActionEvent in interface Algorithm

Overrides:

setActionEvent in class AbstractAlgorithm

processData

public void processData()

getName

public String getName()

Description copied from interface: Algorithm

Returns the name (ID) of the algorithm.

Returns:

DOCUMENT ME!

getShortName

public String getShortName()

Specified by:

getShortName in interface EditorAlgorithm

Overrides:

getShortName in class AbstractEditorAlgorithm

Returns:

A short name, used for the parameter dialog window.

mayWorkOnMultipleGraphs

public boolean mayWorkOnMultipleGraphs()

Specified by:

mayWorkOnMultipleGraphs in interface Algorithm

Overrides:

mayWorkOnMultipleGraphs in class AbstractAlgorithm

setDoShowResult

public void setDoShowResult(DataMapping.ShowMappingResults showResult)

showResult

public DataMapping.ShowMappingResults showResult()

reset

public void reset()

Description copied from interface: Algorithm

Resets the internal state of the algorithm.

Specified by:

reset in interface Algorithm

Overrides:

reset in class AbstractAlgorithm

setSupressReset

public void setSupressReset(boolean supressReset)

isSupressReset

public boolean isSupressReset()

getIcon

public ImageIcon getIcon()

Description copied from class: AbstractEditorAlgorithm

Returns the icon of the algorithm (used, e.g. in the menu bar). Icon is only shown if showMenuIcon returns true.

Specified by:

getIcon in interface EditorAlgorithm

Overrides:

getIcon in class AbstractEditorAlgorithm

Returns:

The icon of the algorithm or null if the plugin icon should be used.

getSetCategory

public Set<Category> getSetCategory()

Description copied from interface: Algorithm

Returns a set of categories to classify this algorithm . e.g. return new HashSet(Arrays.asList( Category.GRAPH, Category.NODE )); is an algorithm, working on graphs and more specific on nodes

Specified by:

getSetCategory in interface Algorithm

Overrides:

getSetCategory in class AbstractAlgorithm

Returns:

Set of Category Enums that classify this algorithm.