org.hkijena.jipipe.ui.plotbuilder

Class JIPipePlotSeriesBuilder

java.lang.Object

org.hkijena.jipipe.ui.plotbuilder.JIPipePlotSeriesBuilder

All Implemented Interfaces:

JIPipeValidatable, JIPipeParameterCollection

public class JIPipePlotSeriesBuilder
extends Object
implements JIPipeParameterCollection, JIPipeValidatable

Constructs a series from a set of columns

Nested Class Summary

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Constructor Summary

Constructors

Constructor and Description
JIPipePlotSeriesBuilder(PlotEditor plotBuilderUI, JIPipeDataInfo plotType) Creates a new instance

Method Summary

Modifier and Type	Method and Description
void	assignData(String column, TableColumn columnData) Assigns data to a column
PlotDataSeries	buildSeries() Generates a series
JIPipeDynamicParameterCollection	getColumnAssignments()
EventBus	getEventBus() Gets the event bus that posts events about the parameters
String	getName()
PlotEditor	getPlotBuilderUI()
JIPipeDataInfo	getPlotType()
Map<String,TableColumn>	getSelectedSources() Returns the currently selected sources.
boolean	isEnabled()
void	onParametersChanged(JIPipeParameterCollection.ParameterChangedEvent event) Triggered when the plot builder's parameters are changed
void	reportValidity(JIPipeIssueReport report) Generates a validity report
void	setEnabled(boolean enabled)
void	setName(String name)
void	updateSeriesList() Updates the column parameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, isParameterUIVisible, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Methods inherited from interface org.hkijena.jipipe.api.JIPipeValidatable

generateValidityReport

Constructor Detail

JIPipePlotSeriesBuilder

public JIPipePlotSeriesBuilder(PlotEditor plotBuilderUI,
                               JIPipeDataInfo plotType)

Creates a new instance

Parameters:

plotBuilderUI - the plot builder

plotType - the plot type this series builder is defined for

Method Detail

getSelectedSources

public Map<String,TableColumn> getSelectedSources()

Returns the currently selected sources.

Returns:

map of series column ID to source

updateSeriesList

public void updateSeriesList()

Updates the column parameters

onParametersChanged

public void onParametersChanged(JIPipeParameterCollection.ParameterChangedEvent event)

Triggered when the plot builder's parameters are changed

Parameters:

event - generated event

getEventBus

public EventBus getEventBus()

Description copied from interface: JIPipeParameterCollection

Gets the event bus that posts events about the parameters

Specified by:

getEventBus in interface JIPipeParameterCollection

Returns:

The event bus triggering JIPipeParameterCollection.ParameterChangedEvent and JIPipeParameterCollection.ParameterStructureChangedEvent

assignData

public void assignData(String column,
                       TableColumn columnData)

Assigns data to a column

Parameters:

column - the series column

columnData - the assigned data

getColumnAssignments

public JIPipeDynamicParameterCollection getColumnAssignments()

getPlotType

public JIPipeDataInfo getPlotType()

getName

public String getName()

setName

public void setName(String name)

getPlotBuilderUI

public PlotEditor getPlotBuilderUI()

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

reportValidity

public void reportValidity(JIPipeIssueReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Parameters:

report - the report to be added to

buildSeries

public PlotDataSeries buildSeries()

Generates a series

Returns:

Generated series