lt.monarch.chart.chart2D.series
Class VectorSeries

java.lang.Object
  extended by lt.monarch.chart.engine.AbstractChartObject<Tags>
      extended by lt.monarch.chart.AbstractChartSeries<Tags,ChartProjector>
          extended by lt.monarch.chart.chart2D.series.MarkerDecorableSeries<SeriesPaintTags,Projector2D>
              extended by lt.monarch.chart.chart2D.series.VectorSeries
All Implemented Interfaces:
java.io.Serializable, AbstractMarkerSeries, ChartEntity, ChartObject, ChartSeries, StyleEditorEntity

public class VectorSeries
extends MarkerDecorableSeries<SeriesPaintTags,Projector2D>

Vector series. This series draws line from one given point to the other drawing arrow symbol at the end. The default drawing strategy is VectorStrateiges.VECTOR_STRATEGY.

See Also:
Serialized Form

Nested Class Summary
Modifier and Type Class and Description
 
Nested classes/interfaces inherited from class lt.monarch.chart.chart2D.series.MarkerDecorableSeries
MarkerDecorableSeries.MarkerEntity
 
Field Summary
Modifier and Type Field and Description
protected  PlaneMapper mapper
          the plane mapper
 
Fields inherited from class lt.monarch.chart.chart2D.series.MarkerDecorableSeries
baseValue, colorMapper, markerPainter, markers, minMaxValues, pseudoModel
 
Fields inherited from class lt.monarch.chart.AbstractChartSeries
metaModel, 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 Summary
Constructor and Description
VectorSeries(ArrayDataModel model, AxisMapper xMapper, AxisMapper yMapper)
          Vector series constructor without a meta data model and default plane mapper is for Cartesian coordinates.
VectorSeries(ArrayDataModel model, MetaDataModel metaModel, AxisMapper xMapper, AxisMapper yMapper)
          Constructs a new Vector series.
VectorSeries(ArrayDataModel model, PlaneMapper mapper, AxisMapper xMapper, AxisMapper yMapper)
          Vector series constructor without a meta data model
VectorSeries(DataModel model, MetaDataModel metaModel, PlaneMapper mapper, AxisMapper xMapper, AxisMapper yMapper)
          Vector series constructor
 
Method Summary
Modifier and Type Method and Description
 void draw(AbstractGraphics g)
          Renders chart object on the Graphics context.
 void drawMarkers(AbstractGraphics g)
          Draws markers according to default layouting
 double getMarkerPosition()
          Returns marker's position on single vector
 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
protected  GeneralPoint getPointForConstraint(ArrayDataModel model, int index)
           
 Projector2D getProjector()
          Returns modified projector.
 AbstractVectorStrategy<Projector> getStrategy()
          Gets line drawing strategy.
protected  void initLegendSymbol()
          Initializes a new LegendVectorSymbol used for representing vector series in legend.
 void setMarkerPosition(double position)
          Sets marker's position on single vector in the range of [0; 1], where value 0 means the beginning of vector and 1 - the end.
 void setStrategy(VectorStrategies strategy)
          Sets line drawing strategy.
 
Methods inherited from class lt.monarch.chart.chart2D.series.MarkerDecorableSeries
addMarker, addMarker, addMarker, calculateNullValue, copy, dataConstraintExtraction, drawMarkers, generateConstaint, getBaseValue, getColorMapper, getKeyType, getMarkerConstraints, getMarkers, getMarkerStyle, getPaintMode, getSortPosition, layout, mapMinMaxValue, removeMarker, setBaseValue, setColorMapper, setPaintMode
 
Methods inherited from class lt.monarch.chart.AbstractChartSeries
activate, checkDataModelRequirements, createLegendEntries, createLegendEntry, createLegendSymbol, deactivate, fillEntitySheet, getChartObjectBounds, getDataModel, getDescription, getMetaDataModel, getModelValidator, getName, getNearestChildEntity, getParentEntity, getSeriesColor, getShortDescription, getShowNullValues, getXMapper, getYMapper, getZMapper, handleDataModelChangeEvent, 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, repaint, repaint, setChart, 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, repaint, repaint, setChart
 
Methods inherited from interface lt.monarch.chart.engine.StyleEditorEntity
getParent, getStyle
 

Field Detail

mapper

protected final PlaneMapper mapper
the plane mapper

Constructor Detail

VectorSeries

public VectorSeries(DataModel model,
                    MetaDataModel metaModel,
                    PlaneMapper mapper,
                    AxisMapper xMapper,
                    AxisMapper yMapper)
Vector series constructor

Parameters:
model - chart data model
metaModel - meta data model
mapper - mapper, used to map output to a plane in a n-dimensional space
xMapper - x axis mapper
yMapper - y axis mapper

VectorSeries

public VectorSeries(ArrayDataModel model,
                    PlaneMapper mapper,
                    AxisMapper xMapper,
                    AxisMapper yMapper)
Vector series constructor without a meta data model

Parameters:
model - chart data model
mapper - mapper, used to map output to a plane in a n-dimensional space
xMapper - x axis mapper
yMapper - y axis mapper

VectorSeries

public VectorSeries(ArrayDataModel model,
                    MetaDataModel metaModel,
                    AxisMapper xMapper,
                    AxisMapper yMapper)
Constructs a new Vector series. The default plane mapper is used for Cartesian coordinate system.

Parameters:
model - chart data model
metaModel - meta data model
xMapper - x axis mapper
yMapper - y axis mapper

VectorSeries

public VectorSeries(ArrayDataModel model,
                    AxisMapper xMapper,
                    AxisMapper yMapper)
Vector series constructor without a meta data model and default plane mapper is for Cartesian coordinates.

Parameters:
model - chart data model
xMapper - x axis mapper
yMapper - y axis mapper
Method Detail

initLegendSymbol

protected void initLegendSymbol()
Initializes a new LegendVectorSymbol used for representing vector series in legend.


getProjector

public Projector2D getProjector()
Returns modified projector.

Overrides:
getProjector in class AbstractChartSeries<SeriesPaintTags,Projector2D>
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 MarkerDecorableSeries<SeriesPaintTags,Projector2D>
Parameters:
g - graphics context

drawMarkers

public void drawMarkers(AbstractGraphics g)
Draws markers according to default layouting

Specified by:
drawMarkers in interface AbstractMarkerSeries
Overrides:
drawMarkers in class MarkerDecorableSeries<SeriesPaintTags,Projector2D>
Parameters:
g - graphics context

getPointForConstraint

protected GeneralPoint getPointForConstraint(ArrayDataModel model,
                                             int index)
Overrides:
getPointForConstraint in class MarkerDecorableSeries<SeriesPaintTags,Projector2D>

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

Overrides:
getMaxValue in class MarkerDecorableSeries<SeriesPaintTags,Projector2D>
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

Overrides:
getMinValue in class MarkerDecorableSeries<SeriesPaintTags,Projector2D>
Parameters:
valType - data value column
Returns:
minimum value needed

setStrategy

public void setStrategy(VectorStrategies strategy)
Sets line drawing strategy. If you want to set your own custom strategy set it directly to the stylesheet, using tag "strategy", e.g. style.setObject("strategy", new MyStrategy());

Parameters:
strategy - drawing strategy

getStrategy

public AbstractVectorStrategy<Projector> getStrategy()
Gets line drawing strategy.

Returns:
line drawing strategy

getMarkerPosition

public double getMarkerPosition()
Returns marker's position on single vector

Returns:
Marker's position

setMarkerPosition

public void setMarkerPosition(double position)
Sets marker's position on single vector in the range of [0; 1], where value 0 means the beginning of vector and 1 - the end. Default is 1 (end of vector).

Parameters:
position - Marker position. Should pass value in the range [0; 1]