desmoj.extensions.grafic.util

Class Plotter

java.lang.Object

desmoj.extensions.grafic.util.Plotter

public class Plotter
extends java.lang.Object

Class to plot DesmoJ histogram, histogramAccumulater and time-series data in jFreeChart Plotter. When in DesmoJ dataset getShowTimeSpansInReport() is set, the data values are interpreted as a timespan in a appropriate time unit. The DesmoJ datasets are converted in jFreeChart Format. Onscreen and offscreen plots are supported. See also PaintPanel and TimeSeriesDataSetAdapter

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

christian.mueller@th-wildau.de and goebel@informatik.uni-hamburg.de modified at 4.12.2012 by christian.mueller@th-wildau.de Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TimeSeries_LineChart
static int	TimeSeries_ScatterPlot
static int	TimeSeries_StepChart

Constructor Summary

Constructors

Constructor and Description
Plotter(java.lang.String path, java.awt.Dimension size) Constructor to set the path of output directory and the size of created image.

Method Summary

Modifier and Type	Method and Description
void	makeHistogramAccumulatePlot(HistogramAccumulate histogram) make a histogramAccumulate plot with a desmoJ histogram dataset.
void	makeHistogramPlot(Histogram histogram) make a histogram plot with a desmoJ histogram dataset.
void	makeHistogramPlot(Histogram histogram, boolean onscreen) Deprecated.
void	makeTimeSeriesPlot(TimeSeries ts, boolean onscreen) Deprecated.
void	makeTimeSeriesPlot(TimeSeries ts, int plotType, boolean multipleValues) make a time-series plot with a desmoJ time-series dataset.
void	setLocale(java.util.Locale locale) set locale for both grafic axis
void	setOnScreen(boolean onScreen) Grafic is shown on screen, stored on file otherwise
void	setTimeRange(TimeInstant begin, TimeInstant end) set date range for timeseries dateaxis.
void	setTimeZone(java.util.TimeZone timeZone) set timeZone for timeseries dateaxis

Methods inherited from class java.lang.Object

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

Field Detail

TimeSeries_ScatterPlot

public static final int TimeSeries_ScatterPlot

See Also:

Constant Field Values

TimeSeries_StepChart

public static final int TimeSeries_StepChart

See Also:

Constant Field Values

TimeSeries_LineChart

public static final int TimeSeries_LineChart

See Also:

Constant Field Values

Constructor Detail

Plotter

public Plotter(java.lang.String path,
               java.awt.Dimension size)

Constructor to set the path of output directory and the size of created image. Default are onScreen = false, locale = Locale.getDefault, timeZone = TimeZone.getdefault

Parameters:

path -

size -

Method Detail

setOnScreen

public void setOnScreen(boolean onScreen)

Grafic is shown on screen, stored on file otherwise

Parameters:

onscreen -

setLocale

public void setLocale(java.util.Locale locale)

set locale for both grafic axis

Parameters:

locale -

setTimeZone

public void setTimeZone(java.util.TimeZone timeZone)

set timeZone for timeseries dateaxis

Parameters:

timeZone -

setTimeRange

public void setTimeRange(TimeInstant begin,
                         TimeInstant end)

set date range for timeseries dateaxis. When null its automaticly configured by observations.

Parameters:

begin -

end -

makeHistogramPlot

@Deprecated
public void makeHistogramPlot(Histogram histogram,
                                           boolean onscreen)

Deprecated.

make a histogram plot with a desmoJ histogram dataset. Deprecated, use setOnScreen(onScreen); makeHistogramPlot(histogram); In the case histogram.getShowTimeSpansInReport() the data values are interpreted as a timespan in a appropriate time unit.

Parameters:

histogram -

onScreen -

makeHistogramPlot

public void makeHistogramPlot(Histogram histogram)

make a histogram plot with a desmoJ histogram dataset. In the case histogram.getShowTimeSpansInReport() the data values are interpreted as a timespan in a appropriate time unit.

Parameters:

histogram -

makeHistogramAccumulatePlot

public void makeHistogramAccumulatePlot(HistogramAccumulate histogram)

make a histogramAccumulate plot with a desmoJ histogram dataset. In the case histogram.getShowTimeSpansInReport() the data values are interpreted as a timespan in a appropriate time unit.

Parameters:

histogram -

makeTimeSeriesPlot

@Deprecated
public void makeTimeSeriesPlot(TimeSeries ts,
                                            boolean onscreen)

Deprecated.

make a time-series plot with a desmoJ time-series dataset. Deprecated, use setOnScreen(onScreen); makeTimeSeriesPlot(ts, Plotter.TimeSeries_ScatterPlot, true); In the case histogram.getShowTimeSpansInReport() the data values are interpreted as a timespan in a appropriate time unit.

Parameters:

ts - DesmoJ time-series

onscreen - Grafic is shown on screen, stored on file otherwise

makeTimeSeriesPlot

public void makeTimeSeriesPlot(TimeSeries ts,
                               int plotType,
                               boolean multipleValues)

make a time-series plot with a desmoJ time-series dataset. In the case ts.getShowTimeSpansInReport() the data values are interpreted as a timespan in a appropriate time unit.

Parameters:

ts - DesmoJ time-series

plotType - possible Values: Plotter.TimeSeries_ScatterPlot, Plotter.TimeSeries_StepChart Plotter.TimeSeries_LinePlot

multipleValues - When multipleValues is set, multiple range values of a time value are allowed. In the opposite case only the last range value of a time value is accepted.