Package com.jfcbuilder.builders

Class OhlcPlotBuilder

java.lang.Object

com.jfcbuilder.builders.OhlcPlotBuilder

All Implemented Interfaces:

IXYTimeSeriesPlotBuilder<OhlcPlotBuilder>

Direct Known Subclasses:

VolumeXYPlotBuilder

public class OhlcPlotBuilder
extends Object
implements IXYTimeSeriesPlotBuilder<OhlcPlotBuilder>

Builder for producing stock market Open High Low Close (OHLC) plots using configured builder properties, series, and datasets.

Method Summary

Modifier and Type	Method	Description
OhlcPlotBuilder	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.
OhlcPlotBuilder	axisColor(Paint color)	Sets the axis color to use when building the plot.
OhlcPlotBuilder	axisFontColor(Paint color)	Sets the axis font color to use when building the plot.
OhlcPlotBuilder	backgroundColor(Paint color)	Sets the plot background color to use when building the plot.
org.jfree.chart.plot.XYPlot	build()	Builds the DOHLC plot.
static OhlcPlotBuilder	get()	Factory method for obtaining new instances of this class.
OhlcPlotBuilder	gridLines()	Deprecated. This facility is replaced by majorGrid(boolean) and minorGrid(boolean), and will be removed in a future release.
OhlcPlotBuilder	indexRange(ZeroBasedIndexRange indexRange)	Sets the zero-based index range used to index into all source data for building the XYPlot.
OhlcPlotBuilder	majorGrid(boolean enabled)	Toggles displaying major grid lines ON or OFF.
OhlcPlotBuilder	majorGridColor(Paint color)	Sets the major grid color to use when building the plot.
OhlcPlotBuilder	majorGridStyle(Stroke style)	Sets the major grid line style to use when building the plot.
OhlcPlotBuilder	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.
OhlcPlotBuilder	minorGrid(boolean enabled)	Toggles displaying minor grid lines ON or OFF.
OhlcPlotBuilder	minorGridColor(Paint color)	Sets the minor grid color to use when building the plot.
OhlcPlotBuilder	minorGridStyle(Stroke style)	Sets the minor grid line style to use when building the plot.
OhlcPlotBuilder	noGridLines()	Sets displaying all grid lines OFF.
int	plotWeight()	Gets the currently configured plot weight.
OhlcPlotBuilder	plotWeight(int weight)	Sets the plot weight to be attributed to the plot.
OhlcPlotBuilder	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.
OhlcPlotBuilder	series(IXYTimeSeriesDatasetBuilder<?> dataset)	Same as interface IXYTimeSeriesPlotBuilder<?>.series(IXYTimeSeriesDatasetBuilder<?>) but also checks that only one OhlcSeriesBuilder is ever added because only one is allowed per plot.
OhlcPlotBuilder	showTimeGaps(boolean showTimeGaps)	Toggle whether to show time gaps at x-values where there is no corresponding time instance.
OhlcPlotBuilder	timeData(long[] timeData)	Sets the date-time values to be used when building the plot.
OhlcPlotBuilder	xAxis(org.jfree.chart.axis.ValueAxis xAxis)	Sets the x-axis used when building the plot.
OhlcPlotBuilder	yAxisName(String name)	Sets the plot's y-axis name.
OhlcPlotBuilder	yAxisRange(double lower, double upper)	Sets an explicit y-axis value range to use instead of having the y-axis auto-calculate it.
OhlcPlotBuilder	yAxisTickSize(double size)	Sets the plot's y-axis tick size.
OhlcPlotBuilder	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 OhlcPlotBuilder get()

Factory method for obtaining new instances of this class.

Returns:

New instance of this class

indexRange

public OhlcPlotBuilder 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<OhlcPlotBuilder>

Parameters:

indexRange - The index range to be set

Returns:

Reference to this builder instance for method chaining

xAxis

public OhlcPlotBuilder 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<OhlcPlotBuilder>

Parameters:

xAxis - The axis to be set

Returns:

Reference to this builder instance for method chaining

timeData

public OhlcPlotBuilder 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<OhlcPlotBuilder>

Parameters:

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

Returns:

Reference to this builder instance for method chaining

showTimeGaps

public OhlcPlotBuilder 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<OhlcPlotBuilder>

Parameters:

showTimeGaps - True to show time gaps, false otherwise.

Returns:

Reference to this builder instance for method chaining

series

public OhlcPlotBuilder 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<OhlcPlotBuilder>

Parameters:

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

Returns:

Reference to this builder instance for method chaining

series

public OhlcPlotBuilder series(IXYTimeSeriesDatasetBuilder<?> dataset)

Same as interface IXYTimeSeriesPlotBuilder<?>.series(IXYTimeSeriesDatasetBuilder<?>) but also checks that only one OhlcSeriesBuilder is ever added because only one is allowed per plot.

Specified by:

series in interface IXYTimeSeriesPlotBuilder<OhlcPlotBuilder>

Parameters:

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

Returns:

Reference to this builder instance for method chaining

Throws:

IllegalArgumentException - If an OhlcSeriesBuilder was already added.

marker

public OhlcPlotBuilder 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<OhlcPlotBuilder>

Parameters:

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

Returns:

Reference to this builder instance for method chaining

annotation

public OhlcPlotBuilder 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<OhlcPlotBuilder>

Parameters:

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

Returns:

Reference to this builder instance for method chaining

plotWeight

public OhlcPlotBuilder 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<OhlcPlotBuilder>

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<OhlcPlotBuilder>

Returns:

The plot weight

yAxisName

public OhlcPlotBuilder yAxisName(String name)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the plot's y-axis name.

Specified by:

yAxisName in interface IXYTimeSeriesPlotBuilder<OhlcPlotBuilder>

Parameters:

name - The axis name to be set

Returns:

Reference to this builder instance for method chaining

yAxisRange

public OhlcPlotBuilder 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<OhlcPlotBuilder>

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 OhlcPlotBuilder yAxisTickSize(double size)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the plot's y-axis tick size.

Specified by:

yAxisTickSize in interface IXYTimeSeriesPlotBuilder<OhlcPlotBuilder>

Parameters:

size - The tick size to be set

Returns:

Reference to this builder instance for method chaining

yTickFormat

public OhlcPlotBuilder yTickFormat(NumberFormat format)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the plot's y-axis tick format.

Specified by:

yTickFormat in interface IXYTimeSeriesPlotBuilder<OhlcPlotBuilder>

Parameters:

format - The tick format to be set

Returns:

Reference to this builder instance for method chaining

backgroundColor

public OhlcPlotBuilder 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<OhlcPlotBuilder>

Parameters:

color - The color to set

Returns:

Reference to this builder instance for method chaining

axisFontColor

public OhlcPlotBuilder 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<OhlcPlotBuilder>

Parameters:

color - The color to set

Returns:

Reference to this builder instance for method chaining

axisColor

public OhlcPlotBuilder axisColor(Paint color)

Description copied from interface: IXYTimeSeriesPlotBuilder

Sets the axis color to use when building the plot.

Specified by:

axisColor in interface IXYTimeSeriesPlotBuilder<OhlcPlotBuilder>

Parameters:

color - The color to set

Returns:

Reference to this builder instance for method chaining

gridLines

@Deprecated
public OhlcPlotBuilder 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<OhlcPlotBuilder>

Returns:

Reference to this builder instance for method chaining

noGridLines

public OhlcPlotBuilder 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<OhlcPlotBuilder>

Returns:

Reference to this builder instance for method chaining

majorGrid

public OhlcPlotBuilder majorGrid(boolean enabled)

Description copied from interface: IXYTimeSeriesPlotBuilder

Toggles displaying major grid lines ON or OFF.

Specified by:

majorGrid in interface IXYTimeSeriesPlotBuilder<OhlcPlotBuilder>

Parameters:

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

Returns:

Reference to this builder instance for method chaining

majorGridColor

public OhlcPlotBuilder 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<OhlcPlotBuilder>

Parameters:

color - The color to set

Returns:

Reference to this builder instance for method chaining

majorGridStyle

public OhlcPlotBuilder 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<OhlcPlotBuilder>

Parameters:

style - The style to set

Returns:

Reference to this builder instance for method chaining

minorGrid

public OhlcPlotBuilder minorGrid(boolean enabled)

Description copied from interface: IXYTimeSeriesPlotBuilder

Toggles displaying minor grid lines ON or OFF.

Specified by:

minorGrid in interface IXYTimeSeriesPlotBuilder<OhlcPlotBuilder>

Parameters:

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

Returns:

Reference to this builder instance for method chaining

minorGridColor

public OhlcPlotBuilder 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<OhlcPlotBuilder>

Parameters:

color - The color to set

Returns:

Reference to this builder instance for method chaining

minorGridStyle

public OhlcPlotBuilder 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<OhlcPlotBuilder>

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

Builds the DOHLC plot. The DOHLC series is shown behind all other series that were added.

Specified by:

build in interface IXYTimeSeriesPlotBuilder<OhlcPlotBuilder>

Returns:

New instance of an plot corresponding to all configured data sets and settings

Throws:

IllegalStateException - If an OhlcSeriesBuilder was not set, if time axis was not set, or if time data was not set.