Package com.inet.report.chart.plot

Class StockPlot

java.lang.Object

com.inet.report.chart.plot.AbstractPlot

com.inet.report.chart.plot.StockPlot

All Implemented Interfaces:

ChartPlot, Serializable

public class StockPlot
extends AbstractPlot

A general class for plotting data in the form of an open and close value or an open, close, high an low value. This plot can use data from any class that implements the StockDataset interface.

Since:

8.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inet.report.chart.plot.AbstractPlot

AbstractPlot.GradientSetting

Field Summary

Fields

Modifier and Type	Field	Description
static final StockStyle	DEFAULT_STYLE	Default chart style with this plot.

Fields inherited from class com.inet.report.chart.plot.AbstractPlot

DEFAULT_COLOR_SEQUENCE, DEFAULT_FOREGROUND_ALPHA, DEFAULT_ITEM_LABEL_COLOR, DEFAULT_ITEM_LABEL_FONT, DEFAULT_OUTLINE_COLOR, DEFAULT_OUTLINE_STYLE, DEFAULT_OUTLINE_WIDTH, TOKEN_PLOT

Constructor Summary

Constructors

Constructor	Description
StockPlot()	Creates a stock plot with default properties.
StockPlot(StockStyle style)	Creates a stock plot with defined chart style.

Method Summary

Modifier and Type	Method	Description
GroupAxis	getCategoryAxis()	Returns the category axis for this plot.
ContinuousNumberAxis	getDataAxis()	Returns the data axis for this plot.
StockDataset	getDataset()	Returns a dataset of type StockDataset.
int	getItemLabelAlignment()	Returns the label alignment of the items on this plot.
int	getItemLabelPosition()	Returns the item label position on the chart item.
List	getReferencedObject()	Returns a list of referenced i-net Clear Reports objects: Field or Group
ChartStyle	getStyle()	Returns the style of this chart, ie. the general category this plot belongs to.
protected StringBuilder	getSubProperties(int depth)	Returns the serialized simple properties of subclasses.
void	readProperties(Element element, Chart2 chart)	Reads the chart properties from the DOMParser Element.
void	refreshAutoTitles(Chart2 chart)	Reads out the data column names from dataset and refreshes the chart labels.
protected void	saveSubProperties(PrintWriter out, int depth)	Writes the intern properties to output.
void	setCategoryAxis(GroupAxis categoryAxis)	Sets the category axis for this plot.
void	setDataAxis(ContinuousNumberAxis dataAxis)	Sets the data axis for this plot.
void	setDataset(StockDataset dataset)	Sets the data container for this plot.
void	setItemLabelAlignment(int itemLabelAlignment)	Sets the item label alignment.
void	setItemLabelPosition(int itemLabelPosition)	Sets the item label position on the chart item.
void	setStyle(StockStyle style)	Sets the chart style of this plot.

Methods inherited from class com.inet.report.chart.plot.AbstractPlot

getBackColor, getColorFormula, getColorSequence, getForegroundAlpha, getGradientSetting, getItemLabelColor, getItemLabelFont, getItemLabelFormat, getItemLabelFormatFormula, getItemShape, getOutlineColor, getOutlineStyle, getOutlineWidth, isColorBySeries, isDrawOutline, isSameColorsForSameGroups, isShowLabel, isShowValue, saveProperties, setBackColor, setColorBySeries, setColorFormula, setColorSequence, setDrawOutline, setForegroundAlpha, setGradientSetting, setItemLabelColor, setItemLabelFont, setItemLabelFormat, setItemLabelFormatFormula, setItemShape, setOutlineColor, setOutlineStyle, setOutlineWidth, setSameColorsForSameGroups, setShowLabel, setShowValue

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_STYLE

public static final StockStyle DEFAULT_STYLE

Default chart style with this plot.

Constructor Details

StockPlot

public StockPlot()

Creates a stock plot with default properties.

Since:

8.0

StockPlot

public StockPlot(StockStyle style)

Creates a stock plot with defined chart style. Initializes all properties with default values.

Parameters:

style - the chart style (null not permitted)

Since:

8.0

See Also:

• StockStyle

Method Details

getDataset

public StockDataset getDataset()

Returns a dataset of type StockDataset.

Returns:

the dataset

Since:

8.0

See Also:

• setDataset(StockDataset)
• StockForAllRecordsDataset
• StockForEachRecordDataset
• StockOneGroupDataset

setDataset

public void setDataset(StockDataset dataset)

Sets the data container for this plot.

Parameters:

dataset - the dataset to set (null not permitted)

Since:

8.0

See Also:

• getDataset()
• StockDataset
• StockForAllRecordsDataset
• StockForEachRecordDataset
• StockOneGroupDataset

getCategoryAxis

public GroupAxis getCategoryAxis()

Returns the category axis for this plot. The category axis shows the values of the first group field.

Returns:

the categoryAxis

Since:

8.0

See Also:

• setCategoryAxis(GroupAxis)
• GroupAxis

setCategoryAxis

public void setCategoryAxis(GroupAxis categoryAxis)

Sets the category axis for this plot. The category axis shows the values of the first group field.

Parameters:

categoryAxis - the category axis (null not permitted)

Since:

8.0

See Also:

• getCategoryAxis()
• GroupAxis

getDataAxis

public ContinuousNumberAxis getDataAxis()

Returns the data axis for this plot. The data axis shows the summarized values of data fields.

Returns:

the dataAxis

Since:

8.0

See Also:

• setDataAxis(ContinuousNumberAxis)
• ContinuousNumberAxis

setDataAxis

public void setDataAxis(ContinuousNumberAxis dataAxis)

Sets the data axis for this plot. The data axis shows the summarized values of data fields.

Parameters:

dataAxis - the data axis (null not permitted)

Since:

8.0

See Also:

• getDataAxis()
• ContinuousNumberAxis

getStyle

public ChartStyle getStyle()

Returns the style of this chart, ie. the general category this plot belongs to.

Specified by:

getStyle in class AbstractPlot

Returns:

the style

See Also:

• BarStyle.BAR2D
• LineStyle.LINE_MARKER
• AreaStyle.AREA2D_STACKED

setStyle

public void setStyle(StockStyle style)

Sets the chart style of this plot.

Parameters:

style - the style (null not permitted)

Since:

8.0

See Also:

• getStyle()
• StockStyle

getItemLabelAlignment

public int getItemLabelAlignment()

Returns the label alignment of the items on this plot.

Returns:

the alignment.

Since:

8.0

See Also:

• setItemLabelAlignment(int)
• BarPlot.ITEM_LABEL_ALIGNMENT_AUTO
• BarPlot.ITEM_LABEL_ALIGNMENT_HORIZONTAL
• BarPlot.ITEM_LABEL_ALIGNMENT_VERTICAL

setItemLabelAlignment

public void setItemLabelAlignment(int itemLabelAlignment)

Sets the item label alignment. An item label is a label with name and value on each chart item. Default alignment is BarPlot.ITEM_LABEL_ALIGNMENT_AUTO.

Parameters:

itemLabelAlignment - the item label alignment

Throws:

IllegalArgumentException - by unknown alignment.

Since:

8.0

See Also:

• getItemLabelAlignment()
• BarPlot.ITEM_LABEL_ALIGNMENT_AUTO
• BarPlot.ITEM_LABEL_ALIGNMENT_HORIZONTAL
• BarPlot.ITEM_LABEL_ALIGNMENT_VERTICAL

getItemLabelPosition

public int getItemLabelPosition()

Returns the item label position on the chart item.

Returns:

the item label position.

Since:

8.0

See Also:

• setItemLabelPosition(int)
• StandardPlot.ITEM_LABEL_POSITION_BASE
• StandardPlot.ITEM_LABEL_POSITION_CENTER
• StandardPlot.ITEM_LABEL_POSITION_INSIDE_OF_MAX
• StandardPlot.ITEM_LABEL_POSITION_OUTSIDE_OF_MAX

setItemLabelPosition

public void setItemLabelPosition(int itemLabelPosition)

Sets the item label position on the chart item. An item label is a label with name and value on each chart item. Default position is StandardPlot.ITEM_LABEL_POSITION_OUTSIDE_OF_MAX.

Parameters:

itemLabelPosition - the itemLabelPosition to set

Throws:

IllegalArgumentException - by unknown position.

Since:

8.0

See Also:

• setItemLabelPosition(int)
• StandardPlot.ITEM_LABEL_POSITION_BASE
• StandardPlot.ITEM_LABEL_POSITION_CENTER
• StandardPlot.ITEM_LABEL_POSITION_INSIDE_OF_MAX
• StandardPlot.ITEM_LABEL_POSITION_OUTSIDE_OF_MAX

refreshAutoTitles

public void refreshAutoTitles(Chart2 chart)

Reads out the data column names from dataset and refreshes the chart labels. Please use this function to refresh the chart labels if the data was be changed.

Specified by:

refreshAutoTitles in interface ChartPlot

Specified by:

refreshAutoTitles in class AbstractPlot

Parameters:

chart - the chart

saveSubProperties

protected void saveSubProperties(PrintWriter out,
 int depth)

Writes the intern properties to output. Overwrites this to save intern properties direct to PrintWriter without building a StringBuilder.

Overrides:

saveSubProperties in class AbstractPlot

Parameters:

out - the output

depth - the depth of XML indent

getSubProperties

protected StringBuilder getSubProperties(int depth)

Returns the serialized simple properties of subclasses.

Overrides:

getSubProperties in class AbstractPlot

Parameters:

depth - the depth of XML indent

Returns:

the properties.

readProperties

public void readProperties(Element element,
 Chart2 chart)

Reads the chart properties from the DOMParser Element.

Specified by:

readProperties in interface ChartPlot

Overrides:

readProperties in class AbstractPlot

Parameters:

element - the DOMParser Element

chart - the chart

getReferencedObject

public List getReferencedObject()

Returns a list of referenced i-net Clear Reports objects: Field or Group

Specified by:

getReferencedObject in interface ChartPlot

Overrides:

getReferencedObject in class AbstractPlot

Returns:

the list of objects.