Package com.jfcbuilder.builders

Class VolumeXYPlotBuilder

java.lang.Object

com.jfcbuilder.builders.OhlcPlotBuilder

com.jfcbuilder.builders.VolumeXYPlotBuilder

All Implemented Interfaces:

IXYTimeSeriesPlotBuilder<OhlcPlotBuilder>

public class VolumeXYPlotBuilder
extends OhlcPlotBuilder

Builder for producing stock market volume plots using configured builder properties, series, and datasets. Extends OhlcPlotBuilder to leverage it's bar drawing logic and to ensure bars in the volume plot align with the corresponding ones in the price OHLC plot if one is configured. Accomplishes this by overriding the generation of the XYDataset representing the OHLC series by using volume OHLC values instead of price ones. Also allows superimposing other line series on top like a moving average line. Also supports the ability to produce different series for rendering "close up" and "close down" colors or rendering with a single color without consideration of close up/down days.

Method Summary

Modifier and Type	Method	Description
static VolumeXYPlotBuilder	get()	Factory method for obtaining new instances of this class.
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.

Methods inherited from class com.jfcbuilder.builders.OhlcPlotBuilder

annotation, axisColor, axisFontColor, backgroundColor, build, gridLines, indexRange, majorGrid, majorGridColor, majorGridStyle, marker, minorGrid, minorGridColor, minorGridStyle, noGridLines, plotWeight, plotWeight, series, showTimeGaps, timeData, xAxis, yAxisName, yAxisRange, yAxisTickSize, yTickFormat

Methods inherited from class java.lang.Object

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

Method Details

get

public static VolumeXYPlotBuilder get()

Factory method for obtaining new instances of this class.

Returns:

New instance of this class

series

public OhlcPlotBuilder series(IXYTimeSeriesDatasetBuilder<?> dataset)

Description copied from class: OhlcPlotBuilder

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>

Overrides:

series in class OhlcPlotBuilder

Parameters:

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

Returns:

Reference to this builder instance for method chaining