org.eclipse.tptp.platform.report.core.internal
Class DCurve

java.lang.Object
  org.eclipse.tptp.platform.report.core.internal.DItem
      org.eclipse.tptp.platform.report.core.internal.DItemContainer
          org.eclipse.tptp.platform.report.core.internal.DCurve

All Implemented Interfaces:

IDItem, IDObject

Direct Known Subclasses:

DCurveLink

public class DCurve

extends DItemContainer

A curve is the parent of one or several points, can have a name. A curve have also type: BAR/LINE/POINTS/SECTOR, this type is only used in case of multi-curve-type graphic, and may be understand as a "preferred" type rather than "required" type.

See Also:

DPoint

Field Summary

static java.lang.String	P_COLOR Property key to set color used to draw the curve.
static java.lang.String	P_CS_FALL_COLOR Property key to set color used for candlestick body when the candlestick is known to be "falling" (ie: closing value is lower than opening one).
static java.lang.String	P_ID Property key as string to store the curve id.
static java.lang.String	P_SHIFT_SECTORS Property key for a positive double applyies on T_PIE3D graphic type, and requesting a shift of sectors.
static java.lang.String	P_SYMBOL Property key to associate a symbol to this curve. value is a string that symbol registry knows.
static java.lang.String	T_AREA_LINE curve is preferred to be a filled area (from this curve to axis).
static java.lang.String	T_AREA_LINE_POINTS same as T_AREA_LINE include symbol on each points of curve.
static java.lang.String	T_BAR curve is preferred to be bars, used by T_XY and T_SERIES3D graphic types.
static java.lang.String	T_BAR2 Used in T_SERIES3D graphic type.
static java.lang.String	T_BUBBLE Used in T_XY graphic type.
static java.lang.String	T_CANDLESTICK Used in T_XY graphic type.
static java.lang.String	T_CANDLESTICK_LINE Used in T_XY graphic type.
static java.lang.String	T_CIRCLE Used in T_XY graphic type.
static java.lang.String	T_CYLINDER Used in T_SERIES3D graphic type.
static java.lang.String	T_LINE curve is preferred to be line, used by T_XY and T_SERIES3D graphic types.
static java.lang.String	T_LINE_POINTS curve is preferred to be line and points, for T_XY graphic type, point shape can be redefined using P_SYMBOL property.
static java.lang.String	T_POINTS curve is preferred to be points, for T_XY and T_SERIES3D graphic type, point shape can be redefined using P_SYMBOL property (for T_XY only).
static java.lang.String	T_PYRAMID Used in T_SERIES3D graphic type.
static java.lang.String	T_SECTOR curve is preferred to be sectors
static java.lang.String	T_STACKED_AREA_LINE Same as T_STACKED_LINE and fill the area above this curve and previous one (or axis if it's the first curve).
static java.lang.String	T_STACKED_AREA_LINE_POINTS Same T_STACKED_AREA_LINE, including symbol on each points of curve.
static java.lang.String	T_STACKED_LINE Used in T_XY graphic type.
static java.lang.String	T_STACKED_LINE_POINTS Same as T_STACKED_LINE including symbols on each points of curve.
static java.lang.String	T_VBAR Used in T_XY graphic type.

Constructor Summary

DCurve()
Creates an empty unamed curve having preferred type LINE.

Method Summary

java.lang.String	getName()
DPropertyStore	getProperties()
ISymbol	getSymbol()
java.lang.String	getTooltip()
java.lang.String	getType()
boolean	isType(java.lang.String _ct)
void	setName(java.lang.String _name) Change the name of the curve.
void	setProperties(DPropertyStore s) Replaces current property store, with current one.
void	setStyle(IDStyle s) sets the style of the curve
void	setTooltip(java.lang.String tooltip_) sets the tooltip
void	setType(java.lang.String _type) Changes the preferred type for the curve.
boolean	useSymbol()

Methods inherited from class org.eclipse.tptp.platform.report.core.internal.DItemContainer

clear, getChildCount, getChildOfClass, getChildPosition, getChildrenOfClass, getFirstChild, getLastChild, insertChild, isContainer, removeChild

Methods inherited from class org.eclipse.tptp.platform.report.core.internal.DItem

addChild, getAppliedStyle, getIterator, getNext, getParent, getRoot, getStyle, setNext, setParent

Methods inherited from class java.lang.Object

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

Field Detail

T_BAR

public static final java.lang.String T_BAR

curve is preferred to be bars, used by T_XY and T_SERIES3D graphic types.

See Also:

Constant Field Values

T_LINE

public static final java.lang.String T_LINE

curve is preferred to be line, used by T_XY and T_SERIES3D graphic types.

See Also:

Constant Field Values

T_POINTS

public static final java.lang.String T_POINTS

curve is preferred to be points, for T_XY and T_SERIES3D graphic type, point shape can be redefined using P_SYMBOL property (for T_XY only).

See Also:

Constant Field Values

T_LINE_POINTS

public static final java.lang.String T_LINE_POINTS

curve is preferred to be line and points, for T_XY graphic type, point shape can be redefined using P_SYMBOL property.

See Also:

Constant Field Values

T_SECTOR

public static final java.lang.String T_SECTOR

curve is preferred to be sectors

See Also:

Constant Field Values

T_STACKED_LINE

public static final java.lang.String T_STACKED_LINE

Used in T_XY graphic type. Curve is defined as a T_LINE curve but render cumulate values of stacked line which belongs from same Y axis. First stacked line define the base line, second one add it's value to base line defining a base line a third stacked line can use. This means that the order of stacked line is important (order in IDItem.getNext() chain ). This curve type require that Y axis use numbers (@see DAxis).

See Also:

Constant Field Values

T_STACKED_LINE_POINTS

public static final java.lang.String T_STACKED_LINE_POINTS

Same as T_STACKED_LINE including symbols on each points of curve.

See Also:

Constant Field Values

T_STACKED_AREA_LINE

public static final java.lang.String T_STACKED_AREA_LINE

Same as T_STACKED_LINE and fill the area above this curve and previous one (or axis if it's the first curve).

See Also:

Constant Field Values

T_STACKED_AREA_LINE_POINTS

public static final java.lang.String T_STACKED_AREA_LINE_POINTS

Same T_STACKED_AREA_LINE, including symbol on each points of curve.

See Also:

Constant Field Values

T_AREA_LINE

public static final java.lang.String T_AREA_LINE

curve is preferred to be a filled area (from this curve to axis). Line of curve is also displayed. This type can be used into T_XY and T_SERIES3D graphic types.

See Also:

Constant Field Values

T_AREA_LINE_POINTS

public static final java.lang.String T_AREA_LINE_POINTS

same as T_AREA_LINE include symbol on each points of curve.

See Also:

Constant Field Values

T_CANDLESTICK

public static final java.lang.String T_CANDLESTICK

Used in T_XY graphic type. Curve is defined with points using 5 coordinates. - one coordinate must belong from X axis. - four coordinate must belong from Y axis. The fourth Y coordinate are ordered: - first is the open value of candle - second is the highest value of candle - third is the lowest value of candle - fourth is the close value of candle. First and fourth value define the body of the candle. If close value is greater than open value the body is filled using style's background of curve and the candle lines use style's foreground color. If the close value is lower than open value the colors are reversed: the user can see the difference between raising or falling candle. Note that P_CS_FALL_COLOR property can be used to change falling body color of candlestick.

See Also:

Constant Field Values

T_CANDLESTICK_LINE

public static final java.lang.String T_CANDLESTICK_LINE

Used in T_XY graphic type. Curve is define exactly as T_CANDLESTICK, only the drawing differ. This curve use only foreground value to draw a vertical line between highest and lowest values. The open value is drawn on the left of vertical line using horizontal one, and close value is drawn on the right.

See Also:

Constant Field Values

T_VBAR

public static final java.lang.String T_VBAR

Used in T_XY graphic type. Curve rendered using vertical independant bar, the vertical center of bar is defined by X coordinate and Y coordinate define the height of the bar. The bar width is choosen by render and have no particular sense.

See Also:

Constant Field Values

T_BUBBLE

public static final java.lang.String T_BUBBLE

Used in T_XY graphic type. Each points are rendered using a filled circle (using background color), radius comes from a third DAxis which must not be "x" not "y" not "y2" axis.

See Also:

Constant Field Values

T_CIRCLE

public static final java.lang.String T_CIRCLE

Used in T_XY graphic type. Each points are rendered using an empty circle (transparent), circle color is set by point's style background color. a third DAxis which must not be "x" not "y" not "y2" axis.

See Also:

Constant Field Values

T_BAR2

public static final java.lang.String T_BAR2

Used in T_SERIES3D graphic type. Curve use for each point a bar with 45 degree rotation.

See Also:

Constant Field Values

T_PYRAMID

public static final java.lang.String T_PYRAMID

Used in T_SERIES3D graphic type. Curve use for each point a pyramid.

See Also:

Constant Field Values

T_CYLINDER

public static final java.lang.String T_CYLINDER

Used in T_SERIES3D graphic type. Curve use for each point a faceted cylinder.

See Also:

Constant Field Values

P_SYMBOL

public static final java.lang.String P_SYMBOL

Property key to associate a symbol to this curve. value is a string that symbol registry knows. Symbol are displayed in legend area of graphic, and can be used in T_POINTS curve.

See Also:

T_POINTS, Constant Field Values

P_COLOR

public static final java.lang.String P_COLOR

Property key to set color used to draw the curve. The object must be an instance of IDColor interface.

See Also:

Constant Field Values

P_CS_FALL_COLOR

public static final java.lang.String P_CS_FALL_COLOR

Property key to set color used for candlestick body when the candlestick is known to be "falling" (ie: closing value is lower than opening one). The object must be an instance of IDColor interface.

See Also:

Constant Field Values

P_SHIFT_SECTORS

public static final java.lang.String P_SHIFT_SECTORS

Property key for a positive double applyies on T_PIE3D graphic type, and requesting a shift of sectors. Obviously if there only one sector in graphic no shift can be processed. In other hand, all sectors of a curve are shifted same way (as property applies on curve and not on a point). By default no shift is applyied on sectors.

See Also:

Constant Field Values

P_ID

public static final java.lang.String P_ID

Property key as string to store the curve id. Only activated for the SVG generation

See Also:

Constant Field Values

Constructor Detail

DCurve

public DCurve()

Creates an empty unamed curve having preferred type LINE.

Method Detail

getName

public java.lang.String getName()

Returns:

the name of the curve, can be null.

setName

public void setName(java.lang.String _name)

Change the name of the curve.

Parameters:

_name - new name for the curve.

getType

public java.lang.String getType()

Returns:

the preferred type for the curve.

setType

public void setType(java.lang.String _type)

Changes the preferred type for the curve.

Parameters:

_type - new preferred type.

isType

public boolean isType(java.lang.String _ct)

Returns:

true is curve type is equals to given one.

getProperties

public DPropertyStore getProperties()

Returns:

property store associated with curve

setProperties

public void setProperties(DPropertyStore s)

Replaces current property store, with current one.

getSymbol

public ISymbol getSymbol()

Returns:

symbol associated with this curve, if none, a Square.

useSymbol

public boolean useSymbol()

Returns:

true if curve type is associated to a symbol.

getTooltip

public java.lang.String getTooltip()

Returns:

the tooltip

setTooltip

public void setTooltip(java.lang.String tooltip_)

sets the tooltip

setStyle

public void setStyle(IDStyle s)

sets the style of the curve

Specified by:

setStyle in interface IDItem

Overrides:

setStyle in class DItem

See Also:

DItem.getStyle()