Package com.jfcbuilder.builders

Class XYTimeSeriesPlotBuilder

java.lang.Object

com.jfcbuilder.builders.XYTimeSeriesPlotBuilder

All Implemented Interfaces:

IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

public class XYTimeSeriesPlotBuilder
extends Object
implements IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Builder for producing general XYPlot plots using configured builder properties, series, and datasets.

Method Summary

Modifier and Type	Method	Description
XYTimeSeriesPlotBuilder	annotation(IXYAnnotationBuilder<?> annotation)	Registers an IXYAnnotationBuilder whose build() method will be called to generate its XYAnnotation when this plot builder's build() method is called.
XYTimeSeriesPlotBuilder	axisColor(Paint color)	Sets the axis color to use when building the plot.
XYTimeSeriesPlotBuilder	axisFontColor(Paint color)	Sets the axis font color to use when building the plot.
XYTimeSeriesPlotBuilder	backgroundColor(Paint color)	Sets the plot background color to use when building the plot.
org.jfree.chart.plot.XYPlot	build()	Builds the XYPlot from all configured data and properties.
static XYTimeSeriesPlotBuilder	get()	Factory method for obtaining new instances of this class.
XYTimeSeriesPlotBuilder	gridLines()	Deprecated. This facility is replaced by majorGrid(boolean) and minorGrid(boolean), and will be removed in a future release.
XYTimeSeriesPlotBuilder	indexRange(ZeroBasedIndexRange indexRange)	Sets the zero-based index range used to index into all source data for building the XYPlot.
XYTimeSeriesPlotBuilder	majorGrid(boolean enabled)	Toggles displaying major grid lines ON or OFF.
XYTimeSeriesPlotBuilder	majorGridColor(Paint color)	Sets the major grid color to use when building the plot.
XYTimeSeriesPlotBuilder	majorGridStyle(Stroke style)	Sets the major grid line style to use when building the plot.
XYTimeSeriesPlotBuilder	marker(MarkerBuilder line)	Registers a MarkerBuilder whose build() method will be called to generate its plot line when this plot builder'sbuild() method is called.
XYTimeSeriesPlotBuilder	minorGrid(boolean enabled)	Toggles displaying minor grid lines ON or OFF.
XYTimeSeriesPlotBuilder	minorGridColor(Paint color)	Sets the minor grid color to use when building the plot.
XYTimeSeriesPlotBuilder	minorGridStyle(Stroke style)	Sets the minor grid line style to use when building the plot.
XYTimeSeriesPlotBuilder	noGridLines()	Sets displaying all grid lines OFF.
int	plotWeight()	Gets the currently configured plot weight.
XYTimeSeriesPlotBuilder	plotWeight(int weight)	Sets the plot weight to be attributed to the plot.
XYTimeSeriesPlotBuilder	series(IXYTimeSeriesBuilder<?> series)	Registers an IXYTimeSeriesBuilder whose build() method will be called to generate its XYTimeSeries when this plot builder's build() method is called.
XYTimeSeriesPlotBuilder	series(IXYTimeSeriesDatasetBuilder<?> dataset)	Registers an IXYDatasetBuilder whose build() method will be called to generate its XYDataset when this plot builder's build() method is called.
XYTimeSeriesPlotBuilder	showTimeGaps(boolean showTimeGaps)	Toggle whether to show time gaps at x-values where there is no corresponding time instance.
XYTimeSeriesPlotBuilder	timeData(long[] timeData)	Sets the date-time values to be used when building the plot.
XYTimeSeriesPlotBuilder	xAxis(org.jfree.chart.axis.ValueAxis xAxis)	Sets the x-axis used when building the plot.
XYTimeSeriesPlotBuilder	yAxisName(String name)	Sets the plot's y-axis name.
XYTimeSeriesPlotBuilder	yAxisRange(double lower, double upper)	Sets an explicit y-axis value range to use instead of having the y-axis auto-calculate it.
XYTimeSeriesPlotBuilder	yAxisTickSize(double size)	Sets the plot's y-axis tick size.
XYTimeSeriesPlotBuilder	yTickFormat(NumberFormat format)	Sets the plot's y-axis tick format.

Methods inherited from class java.lang.Object

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

Method Details

get

public static XYTimeSeriesPlotBuilder get()

Factory method for obtaining new instances of this class.

Returns:

New instance of this class

indexRange

public XYTimeSeriesPlotBuilder indexRange(ZeroBasedIndexRange indexRange)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the zero-based index range used to index into all source data for building the XYPlot. This is an optimization to allow clients to supply existing data without having to copy and/or crop it to match the desired size axis range in the chart.

Specified by:

indexRange in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

indexRange - The index range to be set

Returns:

Reference to this builder instance for method chaining

xAxis

public XYTimeSeriesPlotBuilder xAxis(org.jfree.chart.axis.ValueAxis xAxis)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the x-axis used when building the plot.

Specified by:

xAxis in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

xAxis - The axis to be set

Returns:

Reference to this builder instance for method chaining

timeData

public XYTimeSeriesPlotBuilder timeData(long[] timeData)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the date-time values to be used when building the plot.

Specified by:

timeData in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

timeData - The date-time values representing the milliseconds since the epoch start

Returns:

Reference to this builder instance for method chaining

showTimeGaps

public XYTimeSeriesPlotBuilder showTimeGaps(boolean showTimeGaps)

Description copied from interface: IXYTimeSeriesPlotBuilder

Toggle whether to show time gaps at x-values where there is no corresponding time instance.

Specified by:

showTimeGaps in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

showTimeGaps - True to show time gaps, false otherwise.

Returns:

Reference to this builder instance for method chaining

series

public XYTimeSeriesPlotBuilder series(IXYTimeSeriesBuilder<?> series)

Description copied from interface: IXYTimeSeriesPlotBuilder

Registers an IXYTimeSeriesBuilder whose build() method will be called to generate its XYTimeSeries when this plot builder's build() method is called.

Specified by:

series in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

series - The series builder representing the series that it will build

Returns:

Reference to this builder instance for method chaining

series

public XYTimeSeriesPlotBuilder series(IXYTimeSeriesDatasetBuilder<?> dataset)

Description copied from interface: IXYTimeSeriesPlotBuilder

Registers an IXYDatasetBuilder whose build() method will be called to generate its XYDataset when this plot builder's build() method is called.

Specified by:

series in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

dataset - The series builder representing the series that it will build

Returns:

Reference to this builder instance for method chaining

marker

public XYTimeSeriesPlotBuilder marker(MarkerBuilder line)

Description copied from interface: IXYTimeSeriesPlotBuilder

Registers a MarkerBuilder whose build() method will be called to generate its plot line when this plot builder'sbuild() method is called.

Specified by:

marker in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

line - The marker builder representing the marker that it will build

Returns:

Reference to this builder instance for method chaining

annotation

public XYTimeSeriesPlotBuilder annotation(IXYAnnotationBuilder<?> annotation)

Description copied from interface: IXYTimeSeriesPlotBuilder

Registers an IXYAnnotationBuilder whose build() method will be called to generate its XYAnnotation when this plot builder's build() method is called.

Specified by:

annotation in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

annotation - The annotation builder representing the annotation that it will build

Returns:

Reference to this builder instance for method chaining

plotWeight

public XYTimeSeriesPlotBuilder plotWeight(int weight)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the plot weight to be attributed to the plot. A default of 1 will be used if this is not set.

Specified by:

plotWeight in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

weight - The plot weight to be set

Returns:

Reference to this builder instance for method chaining

plotWeight

public int plotWeight()

Description copied from interface: IXYTimeSeriesPlotBuilder

Gets the currently configured plot weight.

Specified by:

plotWeight in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Returns:

The plot weight

yAxisName

public XYTimeSeriesPlotBuilder yAxisName(String name)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the plot's y-axis name.

Specified by:

yAxisName in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

name - The axis name to be set

Returns:

Reference to this builder instance for method chaining

yAxisRange

public XYTimeSeriesPlotBuilder yAxisRange(double lower,
 double upper)
                                   throws IllegalArgumentException

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets an explicit y-axis value range to use instead of having the y-axis auto-calculate it.

Specified by:

yAxisRange in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

lower - The lower bound to be set

upper - The upper bound to be set

Returns:

Reference to this builder instance for method chaining

Throws:

IllegalArgumentException - If the lower bound is greater than the upper one

yAxisTickSize

public XYTimeSeriesPlotBuilder yAxisTickSize(double size)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the plot's y-axis tick size.

Specified by:

yAxisTickSize in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

size - The tick size to be set

Returns:

Reference to this builder instance for method chaining

yTickFormat

public XYTimeSeriesPlotBuilder yTickFormat(NumberFormat format)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the plot's y-axis tick format.

Specified by:

yTickFormat in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

format - The tick format to be set

Returns:

Reference to this builder instance for method chaining

backgroundColor

public XYTimeSeriesPlotBuilder backgroundColor(Paint color)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the plot background color to use when building the plot.

Specified by:

backgroundColor in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

color - The color to set

Returns:

Reference to this builder instance for method chaining

axisFontColor

public XYTimeSeriesPlotBuilder axisFontColor(Paint color)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the axis font color to use when building the plot.

Specified by:

axisFontColor in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

color - The color to set

Returns:

Reference to this builder instance for method chaining

axisColor

public XYTimeSeriesPlotBuilder axisColor(Paint color)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the axis color to use when building the plot.

Specified by:

axisColor in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

color - The color to set

Returns:

Reference to this builder instance for method chaining

gridLines

@Deprecated
public XYTimeSeriesPlotBuilder gridLines()

Deprecated.

This facility is replaced by majorGrid(boolean) and minorGrid(boolean), and will be removed in a future release.

For removal since v1.5.7

Sets displaying grid lines ON.

Specified by:

gridLines in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Returns:

Reference to this builder instance for method chaining

noGridLines

public XYTimeSeriesPlotBuilder noGridLines()

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets displaying all grid lines OFF. Shorthand for calling both IXYTimeSeriesPlotBuilder.majorGrid(boolean) and IXYTimeSeriesPlotBuilder.minorGrid(boolean) with a value of false.

Specified by:

noGridLines in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Returns:

Reference to this builder instance for method chaining

majorGrid

public XYTimeSeriesPlotBuilder majorGrid(boolean enabled)

Description copied from interface: IXYTimeSeriesPlotBuilder

Toggles displaying major grid lines ON or OFF.

Specified by:

majorGrid in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

enabled - True to show major grid lines, false to turn them off.

Returns:

Reference to this builder instance for method chaining

majorGridColor

public XYTimeSeriesPlotBuilder majorGridColor(Paint color)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the major grid color to use when building the plot.

Specified by:

majorGridColor in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

color - The color to set

Returns:

Reference to this builder instance for method chaining

majorGridStyle

public XYTimeSeriesPlotBuilder majorGridStyle(Stroke style)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the major grid line style to use when building the plot.

Specified by:

majorGridStyle in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

style - The style to set

Returns:

Reference to this builder instance for method chaining

minorGrid

public XYTimeSeriesPlotBuilder minorGrid(boolean enabled)

Description copied from interface: IXYTimeSeriesPlotBuilder

Toggles displaying minor grid lines ON or OFF.

Specified by:

minorGrid in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

enabled - True to show minor grid lines, false to turn them off.

Returns:

Reference to this builder instance for method chaining

minorGridColor

public XYTimeSeriesPlotBuilder minorGridColor(Paint color)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the minor grid color to use when building the plot.

Specified by:

minorGridColor in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

color - The color to set

Returns:

Reference to this builder instance for method chaining

minorGridStyle

public XYTimeSeriesPlotBuilder minorGridStyle(Stroke style)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the minor grid line style to use when building the plot.

Specified by:

minorGridStyle in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Parameters:

style - The style to set

Returns:

Reference to this builder instance for method chaining

build

public org.jfree.chart.plot.XYPlot build()
                                  throws IllegalStateException

Description copied from interface: IXYTimeSeriesPlotBuilder

Builds the XYPlot from all configured data and properties.

Specified by:

build in interface IXYTimeSeriesPlotBuilder<XYTimeSeriesPlotBuilder>

Returns:

New instance of an XYPlot corresponding to all configured data and properties

Throws:

IllegalStateException - If the minimum needed configuration for building an XYPlot is not setup in the builder.