org.hkijena.jipipe.plugins.plots.datatypes

Class JFreeChartPlotData

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.plugins.plots.datatypes.JFreeChartPlotData

All Implemented Interfaces:

Closeable, AutoCloseable, JIPipeData, JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeValidatable

Direct Known Subclasses:

CategoryJFreeChartPlotData, HistogramJFreeChartPlotData, PieJFreeChartPlotData, XYJFreeChartPlotData

public abstract class JFreeChartPlotData
extends AbstractJIPipeParameterCollection
implements JIPipeData, JIPipeValidatable

Contains all necessary data to generate a plot

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JFreeChartPlotData.Serializer Serializes the metadata of JFreeChartPlotData

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

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Constructor Summary

Constructors

Constructor and Description
JFreeChartPlotData() Creates a new empty instance
JFreeChartPlotData(JFreeChartPlotData other) Creates a copy of the provided data

Method Summary

Modifier and Type	Method and Description
void	addSeries(JFreeChartPlotDataSeries series) Adds a new series into this plot
static void	calibrateAxis(org.jfree.chart.axis.ValueAxis axis, OptionalDoubleParameter min, OptionalDoubleParameter max) Calibrates the axes of a plot, setting min and max values
void	clearSeries() Removes all series
ResultsTableData	createSeriesTable() Generates an empty series table with the correct columns
JIPipeThumbnailData	createThumbnail(int width, int height, JIPipeProgressInfo progressInfo) This function generates a thumbnail for this data Can return null
JIPipeData	duplicate(JIPipeProgressInfo progressInfo) Duplicates the data
void	exportData(JIPipeWriteDataStorage storage, String name, boolean forceName, JIPipeProgressInfo progressInfo) Saves the data to a folder
void	fromJson(com.fasterxml.jackson.databind.JsonNode node) Loads metadata from JSON
Color	getBackgroundColor()
abstract org.jfree.chart.JFreeChart	getChart()
ColorMap	getColorMap()
Paint[]	getCurrentColorMap()
ColorListParameter	getCustomColorMap()
int	getExportHeight()
int	getExportWidth()
Color	getGridColor()
int	getLegendFontSize()
JFreeChartPlotMetadata	getMetadata() Gets the metadata for this plot instance.
List<JFreeChartPlotDataSeries>	getSeries()
String	getTitle()
int	getTitleFontSize()
static <T extends JFreeChartPlotData> T	importData(JIPipeReadDataStorage storage, Class<T> klass, JIPipeProgressInfo progressInfo)
static <T extends JFreeChartPlotData> T	importData(JIPipeReadDataStorage storage, JIPipeProgressInfo progressInfo)
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterAccess access) Allows to override the visibility of parameters inside the UI
boolean	isUseCustomColorMap()
boolean	isWithLegend()
Component	preview(int width, int height) This function generates a preview component for usage within the GUI Can return null
void	removeSeries(JFreeChartPlotDataSeries series) Removes a series
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	setBackgroundColor(Color backgroundColor)
void	setColorMap(ColorMap colorMap)
void	setCustomColorMap(ColorListParameter customColorMap)
void	setExportHeight(int exportHeight)
void	setExportWidth(int exportWidth)
void	setGridColor(Color gridColor)
void	setLegendFontSize(int legendFontSize)
void	setTitle(String title) Sets the plot title
boolean	setTitleFontSize(int titleFontSize)
void	setUseCustomColorMap(boolean useCustomColorMap)
void	setWithLegend(boolean withLegend)
String	toString()
protected void	updateChartProperties(org.jfree.chart.JFreeChart chart) Sets properties of charts

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.data.JIPipeData

close, exportThumbnails, getDescriptionOf, getMenuPathOf, getNameOf, getSortedList, getStorageDocumentation, getStorageSchema, groupByMenuPath, isCommon, isHeavy, isHidden, toDetailedString

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

generateValidityReport

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

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Constructor Detail

JFreeChartPlotData

public JFreeChartPlotData()

Creates a new empty instance

JFreeChartPlotData

public JFreeChartPlotData(JFreeChartPlotData other)

Creates a copy of the provided data

Parameters:

other - the original

Method Detail

importData

public static <T extends JFreeChartPlotData> T importData(JIPipeReadDataStorage storage,
                                                          JIPipeProgressInfo progressInfo)

importData

public static <T extends JFreeChartPlotData> T importData(JIPipeReadDataStorage storage,
                                                          Class<T> klass,
                                                          JIPipeProgressInfo progressInfo)

calibrateAxis

public static void calibrateAxis(org.jfree.chart.axis.ValueAxis axis,
                                 OptionalDoubleParameter min,
                                 OptionalDoubleParameter max)

Calibrates the axes of a plot, setting min and max values

Parameters:

axis - the axis

min - the min value

max - the max value

preview

public Component preview(int width,
                         int height)

Description copied from interface: JIPipeData

This function generates a preview component for usage within the GUI Can return null

Specified by:

preview in interface JIPipeData

Parameters:

width - the target width

height - the target height

Returns:

the component or null if none should be available

createThumbnail

public JIPipeThumbnailData createThumbnail(int width,
                                           int height,
                                           JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

This function generates a thumbnail for this data Can return null

Specified by:

createThumbnail in interface JIPipeData

Parameters:

width - the width

height - the height

progressInfo - the progress info

Returns:

the thumbnail or null

exportData

public void exportData(JIPipeWriteDataStorage storage,
                       String name,
                       boolean forceName,
                       JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

Saves the data to a folder

Specified by:

exportData in interface JIPipeData

Parameters:

storage - The storage where the data should be written

name - A name reference that can be used to generate filename(s)

forceName - If enabled, the data is saved potentially destructively. Generated files must always contain the name parameter. This is used to collect results for humans or other algorithms.

progressInfo - the progress

duplicate

public JIPipeData duplicate(JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

Duplicates the data

Specified by:

duplicate in interface JIPipeData

Parameters:

progressInfo - the progress of duplicating the data

Returns:

a deep copy of the data

getChart

public abstract org.jfree.chart.JFreeChart getChart()

getTitle

public String getTitle()

Returns:

The plot title

setTitle

public void setTitle(String title)

Sets the plot title

Parameters:

title - The title

getExportWidth

public int getExportWidth()

setExportWidth

public void setExportWidth(int exportWidth)

getExportHeight

public int getExportHeight()

setExportHeight

public void setExportHeight(int exportHeight)

getBackgroundColor

public Color getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

getGridColor

public Color getGridColor()

setGridColor

public void setGridColor(Color gridColor)

isWithLegend

public boolean isWithLegend()

setWithLegend

public void setWithLegend(boolean withLegend)

getTitleFontSize

public int getTitleFontSize()

setTitleFontSize

public boolean setTitleFontSize(int titleFontSize)

getLegendFontSize

public int getLegendFontSize()

setLegendFontSize

public void setLegendFontSize(int legendFontSize)

getColorMap

public ColorMap getColorMap()

setColorMap

public void setColorMap(ColorMap colorMap)

isUseCustomColorMap

public boolean isUseCustomColorMap()

setUseCustomColorMap

public void setUseCustomColorMap(boolean useCustomColorMap)

getCustomColorMap

public ColorListParameter getCustomColorMap()

setCustomColorMap

public void setCustomColorMap(ColorListParameter customColorMap)

getCurrentColorMap

public Paint[] getCurrentColorMap()

isParameterUIVisible

public boolean isParameterUIVisible(JIPipeParameterTree tree,
                                    JIPipeParameterAccess access)

Description copied from interface: JIPipeParameterCollection

Allows to override the visibility of parameters inside the UI

Specified by:

isParameterUIVisible in interface JIPipeParameterCollection

Parameters:

tree - the parameter tree that is used to access this parameter

access - the parameter

Returns:

if the parameter is visible inside the UI

updateChartProperties

protected void updateChartProperties(org.jfree.chart.JFreeChart chart)

Sets properties of charts

Parameters:

chart - the chart

getMetadata

public JFreeChartPlotMetadata getMetadata()

Gets the metadata for this plot instance.

Returns:

the metadata

createSeriesTable

public ResultsTableData createSeriesTable()

Generates an empty series table with the correct columns

Returns:

the series table

reportValidity

public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Parameters:

reportContext - the report context

report - the report to be added to

getSeries

public List<JFreeChartPlotDataSeries> getSeries()

addSeries

public void addSeries(JFreeChartPlotDataSeries series)

Adds a new series into this plot

Parameters:

series - the series

removeSeries

public void removeSeries(JFreeChartPlotDataSeries series)

Removes a series

Parameters:

series - the series

clearSeries

public void clearSeries()

Removes all series

toString

public String toString()

Overrides:

toString in class Object

fromJson

public void fromJson(com.fasterxml.jackson.databind.JsonNode node)

Loads metadata from JSON

Parameters:

node - JSON node