lt.monarch.chart.chart2D.series
Class SupplementalPieSeries

java.lang.Object
  lt.monarch.chart.engine.AbstractChartObject<Tags>
      lt.monarch.chart.AbstractChartSeries<SeriesPaintTags,Projector>
          lt.monarch.chart.chart2D.series.SupplementalPieSeries

All Implemented Interfaces:

java.io.Serializable, ChartEntity, ChartObject, ChartSeries, StyleEditorEntity

public class SupplementalPieSeries
extends AbstractChartSeries<SeriesPaintTags,Projector>

Displays a supplemental pie series composed of two pie series. The second series is automatically generated from the first using it's smallest elements.

See Also:

Serialized Form

Field Summary

Modifier and Type	Field and Description

Fields inherited from class lt.monarch.chart.AbstractChartSeries

metaModel, model, modelValidator, seriesName, seriesTransform, showLegend, showNullValues, symbol, xMapper, yMapper, zMapper

Fields inherited from class lt.monarch.chart.engine.AbstractChartObject

AXIS_SORT_POSITION, BREAK_LINE_POSITION, DEFAULT_SORT_POSITION, GRID_SORT_POSITION, MARKER_SERIES_SORT_POSITION, MARKERS_SORT_POSITION, paintStyle, SERIES_SORT_POSITION, sortPosition, style

Constructor and Description

SupplementalPieSeries(DataModel model)
Constructor without a meta data model and default plane mapper is for Cartesian coordinates.

SupplementalPieSeries(DataModel model, MetaDataModel metaModel)
Constructor without a default plane mapper is for Cartesian coordinates.

SupplementalPieSeries(DataModel model, MetaDataModel metaModel, PlaneMapper mapper)
Constructor with specified model, meta model and mapper.

SupplementalPieSeries(DataModel model, PlaneMapper mapper)
Constructor without a meta data model

Method Summary

Modifier and Type	Method and Description
LegendEntry[]	createLegendEntries() Creates legend entries for the series.
void	draw(AbstractGraphics g) Renders chart object on the Graphics context.
PieSeries	getMainSeries() Returns main pie series.
java.lang.Object	getMaxValue(DataColumnType valType) Note: internal use only! Gets maximum value that is used by series to fit into the chart
java.lang.Object	getMinValue(DataColumnType valType) Note: internal use only! Gets minimum value that is used by series to fit into the chart
Projector	getProjector() Returns modified projector.
SupplementalPieStrategy<Projector>	getStrategy() Get series stategy.
SupplementalPieStrategy.SupplementalPiePosition	getSupplementalChartPosition() Returns position of supplemental pie.
PieSeries	getSupplementalSeries() Returns supplemental pie series.
double	getSupplementProjectionAreaRatio() Returns supplemental series projection area ratio relative to main pie.
double	getSupplementValueRatio() Return ratio of smallest elements used in supplement pie.
protected void	handleDataModelChangeEvent(DataModelChangeEvent ev) Invoked when data model has changed.
boolean	isSupplementVisible() Test whether supplement pie should be visible.
void	setChart(Chart chart) Associates this object with a chart.
void	setSupplementalChartPosition(SupplementalPieStrategy.SupplementalPiePosition position) Sets position of supplemental series.
void	setSupplementProjectionAreaRatio(double size) Sets supplement pie projection area ratio relative to main pie.
void	setSupplementValueRatio(double ratio) Sets ratio of smallest elements used in supplement pie.
void	setSupplementVisible(boolean visible) Sets whether supplement pie should be visible.

Methods inherited from class lt.monarch.chart.AbstractChartSeries

activate, checkDataModelRequirements, createLegendEntry, createLegendSymbol, deactivate, fillEntitySheet, getChartObjectBounds, getDataModel, getDescription, getMetaDataModel, getModelValidator, getName, getNearestChildEntity, getParentEntity, getSeriesColor, getShortDescription, getShowNullValues, getSortPosition, getXMapper, getYMapper, getZMapper, setLegendSymbol, setName, setShowNullValues, setValidateData, showLegend, updateClippingToProjector

Methods inherited from class lt.monarch.chart.engine.AbstractChartObject

chart, copy, dispose, finalize, getChart, getPaintStyle, getParent, getStyle, getStyle, invalidate, isVisible, layout, repaint, repaint, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface lt.monarch.chart.engine.ChartObject

dispose, getChart, getStyle, getStyle, invalidate, isVisible, layout, repaint, repaint

Methods inherited from interface lt.monarch.chart.engine.StyleEditorEntity

getParent, getStyle

Constructor Detail

SupplementalPieSeries

public SupplementalPieSeries(DataModel model,
                             MetaDataModel metaModel,
                             PlaneMapper mapper)

Constructor with specified model, meta model and mapper.

Parameters:

model - series data model.

metaModel - meta data model.

mapper - mapper, used to map output to a plane in a n-dimensional space

SupplementalPieSeries

public SupplementalPieSeries(DataModel model,
                             PlaneMapper mapper)

Constructor without a meta data model

Parameters:

model - series data model

mapper - mapper, used to map output to a plane in a n-dimensional space

SupplementalPieSeries

public SupplementalPieSeries(DataModel model,
                             MetaDataModel metaModel)

Constructor without a default plane mapper is for Cartesian coordinates.

Parameters:

metaModel - meta data model.

model - series data model.

SupplementalPieSeries

public SupplementalPieSeries(DataModel model)

Constructor without a meta data model and default plane mapper is for Cartesian coordinates.

Parameters:

model - series data model

Method Detail

getMainSeries

public PieSeries getMainSeries()

Returns main pie series.

Returns:

main pie series.

getSupplementalSeries

public PieSeries getSupplementalSeries()

Returns supplemental pie series.

Returns:

supplemental pie series.

getStrategy

public SupplementalPieStrategy<Projector> getStrategy()

Get series stategy.

Returns:

series strategy.

getProjector

public Projector getProjector()

Description copied from class: AbstractChartSeries

Returns modified projector.

Overrides:

getProjector in class AbstractChartSeries<SeriesPaintTags,Projector>

Returns:

projector

draw

public void draw(AbstractGraphics g)

Description copied from interface: ChartObject

Renders chart object on the Graphics context.

Specified by:

draw in interface ChartObject

Overrides:

draw in class AbstractChartSeries<SeriesPaintTags,Projector>

Parameters:

g - graphics context

setSupplementValueRatio

public void setSupplementValueRatio(double ratio)

Sets ratio of smallest elements used in supplement pie.

Parameters:

ratio - ratio of smallest elements used in supplement pie.

getSupplementValueRatio

public double getSupplementValueRatio()

Return ratio of smallest elements used in supplement pie.

Returns:

ratio of smallest elements used in supplement pie.

setSupplementProjectionAreaRatio

public void setSupplementProjectionAreaRatio(double size)

Sets supplement pie projection area ratio relative to main pie.

Parameters:

ratio - supplement pie ratio relative to main pie.

getSupplementProjectionAreaRatio

public double getSupplementProjectionAreaRatio()

Returns supplemental series projection area ratio relative to main pie.

Returns:

projection area ratio.

setSupplementalChartPosition

public void setSupplementalChartPosition(SupplementalPieStrategy.SupplementalPiePosition position)

Sets position of supplemental series.

Parameters:

position - supplemental pie position.

getSupplementalChartPosition

public SupplementalPieStrategy.SupplementalPiePosition getSupplementalChartPosition()

Returns position of supplemental pie.

Returns:

position of supplemental pie.

setSupplementVisible

public void setSupplementVisible(boolean visible)

Sets whether supplement pie should be visible.

Parameters:

visible - should supplement pie should be visible.

isSupplementVisible

public boolean isSupplementVisible()

Test whether supplement pie should be visible.

Returns:

should show supplement pie.

handleDataModelChangeEvent

protected void handleDataModelChangeEvent(DataModelChangeEvent ev)

Invoked when data model has changed.

Overrides:

handleDataModelChangeEvent in class AbstractChartSeries<SeriesPaintTags,Projector>

Parameters:

ev - the chart data model change event

See Also:

DataModelChangeEvent

setChart

public void setChart(Chart chart)

Description copied from class: AbstractChartObject

Associates this object with a chart. This method is called automatically by a Chart object.

Specified by:

setChart in interface ChartObject

Overrides:

setChart in class AbstractChartObject<SeriesPaintTags>

Parameters:

chart - chart

createLegendEntries

public LegendEntry[] createLegendEntries()

Description copied from class: AbstractChartSeries

Creates legend entries for the series.

Specified by:

createLegendEntries in interface ChartSeries

Overrides:

createLegendEntries in class AbstractChartSeries<SeriesPaintTags,Projector>

Returns:

legend entries

getMaxValue

public java.lang.Object getMaxValue(DataColumnType valType)

Description copied from class: AbstractChartSeries

Note: internal use only! Gets maximum value that is used by series to fit into the chart

Specified by:

getMaxValue in class AbstractChartSeries<SeriesPaintTags,Projector>

Parameters:

valType - data value column

Returns:

maximum value needed

getMinValue

public java.lang.Object getMinValue(DataColumnType valType)

Description copied from class: AbstractChartSeries

Note: internal use only! Gets minimum value that is used by series to fit into the chart

Specified by:

getMinValue in class AbstractChartSeries<SeriesPaintTags,Projector>

Parameters:

valType - data value column

Returns:

minimum value needed