fr.cnes.genius.chart

Class GFreeChartXY

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.chart.GFreeChartXY

All Implemented Interfaces:

GDisplay, MouseWheelListener, EventListener, org.jfree.chart.ChartMouseListener, org.jfree.chart.labels.CrosshairLabelGenerator

Direct Known Subclasses:

GFreeChartLatLong

public class GFreeChartXY
extends GComponent
implements GDisplay, org.jfree.chart.ChartMouseListener, org.jfree.chart.labels.CrosshairLabelGenerator

Class that encapsulates the JFreeChart plotting library. It allows to create a chart with a plot in it. The plot can have a "primary y axis" and an optional "secondary y axis". Any number of data series can be added to the plot.

Author:

jjct

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GFreeChartXY.GAxis Class represeint the a freechart axis with information about its type.
static class	GFreeChartXY.GAxisType Enumerate indicating the types of axis available for the GFreeChartXY.
static class	GFreeChartXY.GFreeChartXYItem Class defining an Item of the plot.
static class	GFreeChartXY.GPlotPosition Class to define the position of a point in a GFeeChartXYPlot in the corresponging axis.
static class	GFreeChartXY.GSeriesProperties Class to store the graphic plot properties to apply to the curves of a certain series.
static class	GFreeChartXY.GToolTipGenerator A tool tip generator that stores custom tooltips.

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEF_EPSILON By default precision for interactive plots

Fields inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GFreeChartXY(String chartTitle, GFreeChartXY.GAxisType xAxisType, GFreeChartXY.GAxisType yAxisType, GFreeChartXY.GAxisType ySecondaryAxisType, String xAxisTitle, String yAxisTitle, String secondaryYTitle, boolean addLegends) Create an empty chart.
GFreeChartXY(String chartTitle, GFreeChartXY.GAxisType xAxisType, GFreeChartXY.GAxisType yAxisType, String xAxisTitle, String yAxisTitle, String secondaryYTitle, boolean addLegends) Create an empty chart.
GFreeChartXY(String widgetId, String chartTitle, GFreeChartXY.GAxisType xAxisType, GFreeChartXY.GAxisType yAxisType, GFreeChartXY.GAxisType ySecondaryAxisType, String xAxisTitle, String yAxisTitle, String secondaryYTitle, boolean addLegends) Create an empty chart.
GFreeChartXY(String widgetId, String chartTitle, GFreeChartXY.GAxisType xAxisType, GFreeChartXY.GAxisType yAxisType, String xAxisTitle, String yAxisTitle, String secondaryYTitle, boolean addLegends) Create an empty chart.
GFreeChartXY(String chartTitle, String xAxisTitle, String yAxisTitle, String secondaryYTitle, boolean addLegends) Create an empty chart.
GFreeChartXY(String widgetId, String chartTitle, String xAxisTitle, String yAxisTitle, String secondaryYTitle, boolean addLegends) Create an empty chart.

Method Summary

Modifier and Type	Method and Description
void	addLegend(org.jfree.chart.title.LegendTitle legend) Method to add a new legend
void	addSerie(boolean useSecondaryYAxis, GFreeChartXY.GSeriesProperties serieProperty, org.jfree.data.xy.XYSeries serieDataSet) Add a given series as either lines or points to the primary axis.
void	addSerie(String serieName, double[] xValueArray, double[] yValueArray, List<String> tooltipList, Color color, Shape shape) Add a given series as either lines or points to the primary axis.
void	addSerie(String serieName, double[] xValueArray, double[] yValueArray, List<String> tooltipArray, Color color, Shape shape, boolean useSecondaryYAxis, Double xGapThreshold, Double yGapThreshold) Add a given series to a given plot as either lines or points.
void	chartMouseClicked(org.jfree.chart.ChartMouseEvent event) When the mouse button is clicked the last plot coordinates are stored so they can be recovered by the user.
void	chartMouseMoved(org.jfree.chart.ChartMouseEvent event)
void	display() Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.
String	generateLabel(org.jfree.chart.plot.Crosshair crosshair)
org.jfree.chart.entity.ChartEntity	getChartEntity() Getter for the Chart Entity.
org.jfree.chart.ChartPanel	getChartPanel() Get the underlying chartPanel.
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
GFreeChartXY.GFreeChartXYItem	getItemCoordinates() Method to get the coordinates of a drawn point.
GFreeChartXY.GFreeChartXYItem	getItemEvent() Method to get the coordinates of a drawn point.
GFreeChartXY.GPlotPosition	getLastClickPosition() Returns the position of the last mouse click in plot coordinates.
GFreeChartXY.GFreeChartXYItem	getPlaneCoordinates(boolean isSecondaryAxis) Method to get the coordinates of the click regardless where the click is.
org.jfree.chart.plot.XYPlot	getPlot() Returns the chart plot.
GFreeChartXY.GSeriesProperties	getSerieProperties(String serieName) Get the properties of a curve
String	getSubTitle() Return the chart subtitle.
String	getTitle() Get the title of the plot.
GFreeChartXY.GAxis	getXAxis() Return X-axis.
org.jfree.data.xy.XYSeries	getXYDataSet(String serieName, boolean secondaryYAxis) Get the XYSeries dataSet for a curve
GFreeChartXY.GAxis	getYAxis() Return Y-axis.
boolean	isInteractive() Method to know if the interactive mode is activated
void	removeAllSeries() Remove all the curves from the plot.
void	removeLegend() Method to remove the legend
void	removeSeries(String serieName, boolean secondaryYAxis) Remove a curve from the plot.
void	setColorSeries(String serieName, boolean secondaryYAxis, Color color) Set the color of a curve.
void	setEventTooltipList(List<String> tooltipList) Setter for the tooltipList
void	setForcedDrawLine(boolean forced) Method to set if lines will be always drawn.
void	setInteractive(boolean isInteractive) Method to set the plot interactive or not
void	setInteractivePrecision(double eps) Method to set the precision for interactive plots
void	setPlotGapThreshold(boolean secondaryPlot, int series, Double xGapThreshold, Double yGapThreshold) Set the gap thresholds.
void	setSecondaryYAxeTitle(String title) Set the title of the secondary y axis.
void	setSeriesShape(String serieName, boolean secondaryYAxis, Shape shape) Set the shape of a curve.
void	setSubTitle(String subTitle) Set the chart subtitle.
void	setTitle(String title) Set the title of the plot.
void	setXAxeTitle(String title) Set the title of the primary x axis.
void	setXFormat(Format format) Set the X axis format.
void	setXTickInterval(Double tickInterval) Set the X tick interval in axis units.
void	setXZoom(Double minValue, Double maxValue) Sets the minimum and maximum value of the displayed X axis, if any of the zoom values is null the zoom is reset.
void	setYAxeTitle(String title) Set the title of the primary y axis.
void	setYFormat(boolean secondaryAxis, Format format) Set the Y axis format.
void	setYTickInterval(boolean secondaryAxis, Double tickInterval) Set the Y tick interval in axis units.
void	setYZoom(boolean secondaryAxis, Double minValue, Double maxValue) Sets the minimum and maximum values of the displayed Y axis, if any of the zoom values is null the zoom is reset.
void	showChrossHair(boolean showCrosshair) Method to show/hide the crosshair.
void	showLegend(boolean show) Show or hide the plot legend.
void	showYSecondaryAxis(boolean showYSecondaryAxis) Set the visibility of the secondary axis.

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getSubComponent, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setEnabled, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidgetId, setWidth, setWindowBusyCursor, updateIsModifiedIndicator, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

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

Field Detail

DEF_EPSILON

public static final double DEF_EPSILON

By default precision for interactive plots

See Also:

Constant Field Values

Constructor Detail

GFreeChartXY

public GFreeChartXY(String chartTitle,
                    String xAxisTitle,
                    String yAxisTitle,
                    String secondaryYTitle,
                    boolean addLegends)

Create an empty chart. The widget identifier is automatically generated and with both axis numerical.

Parameters:

chartTitle - plot window title (can be null).

xAxisTitle - x Axis titles (can contain nulls, must be same length as yTitle).

yAxisTitle - y Axis titles (can contain nulls).

secondaryYTitle - secondary y Axis titles (can be null).

addLegends - true if series legends are wanted.

GFreeChartXY

public GFreeChartXY(String widgetId,
                    String chartTitle,
                    String xAxisTitle,
                    String yAxisTitle,
                    String secondaryYTitle,
                    boolean addLegends)

Create an empty chart. Both axis are numerical.

Parameters:

widgetId - widget identifier.

chartTitle - plot window title (can be null).

xAxisTitle - x Axis titles (can contain nulls, must be same length as yTitle).

yAxisTitle - y Axis titles (can contain nulls).

secondaryYTitle - secondary y Axis titles (can be null).

addLegends - true if series legends are wanted.

GFreeChartXY

public GFreeChartXY(String chartTitle,
                    GFreeChartXY.GAxisType xAxisType,
                    GFreeChartXY.GAxisType yAxisType,
                    String xAxisTitle,
                    String yAxisTitle,
                    String secondaryYTitle,
                    boolean addLegends)

Create an empty chart. The widget identifier is automatically generated.

Parameters:

chartTitle - plot window title (can be null).

xAxisType - type of the X axis.

yAxisType - type of the Y axis.

xAxisTitle - x Axis titles (can contain nulls, must be same length as yTitle).

yAxisTitle - y Axis titles (can contain nulls).

secondaryYTitle - secondary y Axis titles (can be null).

addLegends - true if series legends are wanted.

GFreeChartXY

public GFreeChartXY(String widgetId,
                    String chartTitle,
                    GFreeChartXY.GAxisType xAxisType,
                    GFreeChartXY.GAxisType yAxisType,
                    String xAxisTitle,
                    String yAxisTitle,
                    String secondaryYTitle,
                    boolean addLegends)

Create an empty chart.

Parameters:

widgetId - widget identifier.

chartTitle - plot window title (can be null).

xAxisType - type of the X axis.

yAxisType - type of the Y axis.

xAxisTitle - x Axis titles (can contain nulls, must be same length as yTitle).

yAxisTitle - y Axis titles (can contain nulls).

secondaryYTitle - secondary y Axis titles (can be null).

addLegends - true if series legends are wanted.

GFreeChartXY

public GFreeChartXY(String chartTitle,
                    GFreeChartXY.GAxisType xAxisType,
                    GFreeChartXY.GAxisType yAxisType,
                    GFreeChartXY.GAxisType ySecondaryAxisType,
                    String xAxisTitle,
                    String yAxisTitle,
                    String secondaryYTitle,
                    boolean addLegends)

Create an empty chart.

Parameters:

chartTitle - plot window title (can be null).

xAxisType - type of the X axis.

yAxisType - type of the Y axis.

ySecondaryAxisType - type of the secondary Y axis.

xAxisTitle - x Axis titles (can contain nulls, must be same length as yTitle).

yAxisTitle - y Axis titles (can contain nulls).

secondaryYTitle - secondary y Axis titles (can be null).

addLegends - true if series legends are wanted.

GFreeChartXY

public GFreeChartXY(String widgetId,
                    String chartTitle,
                    GFreeChartXY.GAxisType xAxisType,
                    GFreeChartXY.GAxisType yAxisType,
                    GFreeChartXY.GAxisType ySecondaryAxisType,
                    String xAxisTitle,
                    String yAxisTitle,
                    String secondaryYTitle,
                    boolean addLegends)

Create an empty chart.

Parameters:

widgetId - widget identifier.

chartTitle - plot window title (can be null).

xAxisType - type of the X axis.

yAxisType - type of the Y axis.

ySecondaryAxisType - type of the secondary Y axis.

xAxisTitle - x Axis titles (can contain nulls, must be same length as yTitle).

yAxisTitle - y Axis titles (can contain nulls).

secondaryYTitle - secondary y Axis titles (can be null).

addLegends - true if series legends are wanted.

Method Detail

showChrossHair

public final void showChrossHair(boolean showCrosshair)

Method to show/hide the crosshair.

Parameters:

showCrosshair - true if the crosshair shall be visible, false otherwise.

setTitle

public void setTitle(String title)

Set the title of the plot.

Parameters:

title - title of the plot to set.

getTitle

public String getTitle()

Get the title of the plot.

Returns:

title title of the plot to set.

setSubTitle

public void setSubTitle(String subTitle)

Set the chart subtitle.

Parameters:

subTitle - the chart subtitle, in can be null.

getSubTitle

public String getSubTitle()

Return the chart subtitle.

Returns:

the chart subtitle, it can return null.

setXAxeTitle

public void setXAxeTitle(String title)

Set the title of the primary x axis. If the title is null the axis will be hidden.

Parameters:

title - of the x axis. If the title is null the axis will be hidden.

setYAxeTitle

public void setYAxeTitle(String title)

Set the title of the primary y axis. If the title is null the axis will be hidden.

Parameters:

title - of the y axis. If the title is null the axis will be hidden.

setSecondaryYAxeTitle

public final void setSecondaryYAxeTitle(String title)

Set the title of the secondary y axis. If the title is null the axis will be hidden.

Parameters:

title - of the secondary axis.If the title is null the axis will be hidden.

showYSecondaryAxis

public void showYSecondaryAxis(boolean showYSecondaryAxis)

Set the visibility of the secondary axis.

Parameters:

showYSecondaryAxis - if true the secondary Y axis shall be displayed if defined, false otehrwise.

setPlotGapThreshold

public void setPlotGapThreshold(boolean secondaryPlot,
                                int series,
                                Double xGapThreshold,
                                Double yGapThreshold)

Set the gap thresholds.

Parameters:

secondaryPlot - true if the gaps apply to the secondary plot, false otherwise.

series - serie identifier.

xGapThreshold - Value of the threshold between X coordinates to avoid displaying the segment, if null it is not used.

yGapThreshold - Value of the threshold between Y coordinates to avoid displaying the segment, if null it is not used.

addSerie

public void addSerie(String serieName,
                     double[] xValueArray,
                     double[] yValueArray,
                     List<String> tooltipArray,
                     Color color,
                     Shape shape,
                     boolean useSecondaryYAxis,
                     Double xGapThreshold,
                     Double yGapThreshold)
              throws GFreeChartException

Add a given series to a given plot as either lines or points.

Parameters:

serieName - series name

xValueArray - series abscissas

yValueArray - series ordinates (same length as x)

tooltipArray - tooltips for the elements of the series.

color - series color.

shape - series shape.

useSecondaryYAxis - true it the data-set shall be assigned to the secondary Y axis, otherwise it is assigned to the primary.

xGapThreshold - treshold for the x gap.

yGapThreshold - treshold for the y gap.

Throws:

GFreeChartException - If the xValueArray and yValueArray do not have the same dimensions.

addSerie

public void addSerie(String serieName,
                     double[] xValueArray,
                     double[] yValueArray,
                     List<String> tooltipList,
                     Color color,
                     Shape shape)
              throws GFreeChartException

Add a given series as either lines or points to the primary axis.

Parameters:

serieName - series name

xValueArray - series abscissas

yValueArray - series ordinates (same length as x)

tooltipList - tooltips for the elements of the series.

color - series color.

shape - series shape.

Throws:

GFreeChartException - If the xValueArray and yValueArray do not have the same dimensions.

addSerie

public void addSerie(boolean useSecondaryYAxis,
                     GFreeChartXY.GSeriesProperties serieProperty,
                     org.jfree.data.xy.XYSeries serieDataSet)

Add a given series as either lines or points to the primary axis.

Parameters:

useSecondaryYAxis - true it the data-set shall be assigned to the secondary Y axis, otherwise it is assigned to the primary.

serieProperty - series properties

serieDataSet - series dataset

getSerieProperties

public GFreeChartXY.GSeriesProperties getSerieProperties(String serieName)

Get the properties of a curve

Parameters:

serieName - name of the curve.

Returns:

the properties of the curve

getXYDataSet

public org.jfree.data.xy.XYSeries getXYDataSet(String serieName,
                                               boolean secondaryYAxis)

Get the XYSeries dataSet for a curve

Parameters:

serieName - name of the curve.

secondaryYAxis - true if the curve is associated to the secondary axe, false otherwise.

Returns:

the dataset of the curve

removeSeries

public void removeSeries(String serieName,
                         boolean secondaryYAxis)

Remove a curve from the plot.

Parameters:

serieName - name of the curve.

secondaryYAxis - true if the curve is associated to the secondary axe, false otherwise.

removeAllSeries

public void removeAllSeries()

Remove all the curves from the plot.

setColorSeries

public void setColorSeries(String serieName,
                           boolean secondaryYAxis,
                           Color color)

Set the color of a curve.

Parameters:

serieName - name of the curve.

secondaryYAxis - true if the curve is associated to the secondary axe, false otherwise.

color - new color of the curve.

setSeriesShape

public void setSeriesShape(String serieName,
                           boolean secondaryYAxis,
                           Shape shape)

Set the shape of a curve. If the shape is null the display will use a line

Parameters:

serieName - name of the curve

secondaryYAxis - true if the curve is associated to the secondary axe, false otherwise.

shape - new shape of the curve

display

public void display()

Called when the element is to be displayed, so it can perform the actions required for its display, and the display of its inmmediate descendants.

Specified by:

display in interface GDisplay

getComponent

public Component getComponent()

Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.

Overrides:

getComponent in class GComponent

Returns:

the Swing Component encapsulated by the class if any, otherwise returns null.

getChartPanel

public org.jfree.chart.ChartPanel getChartPanel()

Get the underlying chartPanel.

Returns:

the underlying chartPanel.

showLegend

public final void showLegend(boolean show)

Show or hide the plot legend.

Parameters:

show - flag to show or hide the legend.

getPlot

public final org.jfree.chart.plot.XYPlot getPlot()

Returns the chart plot.

Returns:

the chart plot.

setXZoom

public void setXZoom(Double minValue,
                     Double maxValue)

Sets the minimum and maximum value of the displayed X axis, if any of the zoom values is null the zoom is reset.

Parameters:

minValue - minimum value for the X axis.

maxValue - maximum value for the X axis.

setYZoom

public void setYZoom(boolean secondaryAxis,
                     Double minValue,
                     Double maxValue)

Sets the minimum and maximum values of the displayed Y axis, if any of the zoom values is null the zoom is reset.

Parameters:

secondaryAxis - true if the minimum and max values shall be applied to the secondary axis.

minValue - minimum value for the Y axis.

maxValue - maximum value for the Y axis.

setXTickInterval

public void setXTickInterval(Double tickInterval)

Set the X tick interval in axis units.

Parameters:

tickInterval - if null the tickInterval will be defined automatically by the plot, else the value of units between 2 ticks.

setYTickInterval

public void setYTickInterval(boolean secondaryAxis,
                             Double tickInterval)

Set the Y tick interval in axis units.

Parameters:

secondaryAxis - true if the minimum and max values shall be applied to the secondary axis.

tickInterval - if null the tickInterval will be defined automatically by the plot, else the value of units between 2 ticks.

setXFormat

public void setXFormat(Format format)

Set the X axis format.

Parameters:

format - formatter for the X axis.

setYFormat

public void setYFormat(boolean secondaryAxis,
                       Format format)

Set the Y axis format.

Parameters:

secondaryAxis - true if the minimum and max values shall be applied to the secondary axis.

format - formatter for the Y axis.

isInteractive

public boolean isInteractive()

Method to know if the interactive mode is activated

Returns:

true if the mode is activated

setInteractive

public void setInteractive(boolean isInteractive)

Method to set the plot interactive or not

Parameters:

isInteractive - plot will be interactive if true

setInteractivePrecision

public void setInteractivePrecision(double eps)

Method to set the precision for interactive plots

Parameters:

eps - precision (relative to the axis length)

setForcedDrawLine

public void setForcedDrawLine(boolean forced)

Method to set if lines will be always drawn.

Parameters:

forced - lines will be always drawn if true

removeLegend

public void removeLegend()

Method to remove the legend

addLegend

public void addLegend(org.jfree.chart.title.LegendTitle legend)

Method to add a new legend

Parameters:

legend - new legend

getPlaneCoordinates

public GFreeChartXY.GFreeChartXYItem getPlaneCoordinates(boolean isSecondaryAxis)

Method to get the coordinates of the click regardless where the click is.

Parameters:

isSecondaryAxis - We consider secondary axis units

Returns:

coordinates of the point

getItemCoordinates

public GFreeChartXY.GFreeChartXYItem getItemCoordinates()

Method to get the coordinates of a drawn point.

Returns:

coordinates of the point

getItemEvent

public GFreeChartXY.GFreeChartXYItem getItemEvent()

Method to get the coordinates of a drawn point.

Returns:

coordinates of the point

chartMouseClicked

public void chartMouseClicked(org.jfree.chart.ChartMouseEvent event)

When the mouse button is clicked the last plot coordinates are stored so they can be recovered by the user.

Specified by:

chartMouseClicked in interface org.jfree.chart.ChartMouseListener

chartMouseMoved

public void chartMouseMoved(org.jfree.chart.ChartMouseEvent event)

Specified by:

chartMouseMoved in interface org.jfree.chart.ChartMouseListener

setEventTooltipList

public void setEventTooltipList(List<String> tooltipList)

Setter for the tooltipList

Parameters:

tooltipList - tool tip list

getChartEntity

public org.jfree.chart.entity.ChartEntity getChartEntity()

Getter for the Chart Entity.

Returns:

the chartEntity.

getLastClickPosition

public GFreeChartXY.GPlotPosition getLastClickPosition()

Returns the position of the last mouse click in plot coordinates.

Returns:

the position of the last mouse click in plot coordinates.

generateLabel

public String generateLabel(org.jfree.chart.plot.Crosshair crosshair)

Specified by:

generateLabel in interface org.jfree.chart.labels.CrosshairLabelGenerator

getXAxis

public GFreeChartXY.GAxis getXAxis()

Return X-axis.

Returns:

X-axis

getYAxis

public GFreeChartXY.GAxis getYAxis()

Return Y-axis.

Returns:

Y-axis