org.eclipse.tptp.platform.report.chart.internal
Interface IScale

All Known Implementing Classes:

CategoryScale, LinearDateScale, LinearNumberScale, LogNumberScale

Deprecated. As of TPTP 4.5.0, use the TPTP Business Intelligence and Reporting Tools (BIRT) reporting infrastructure (org.eclipse.tptp.platform.report.birt).

public interface IScale

Interface for class providing conversion between 'Object' value space and double space. 'Object' used as generic value, but a real world might use Float,Double,Date,... Ok, this is a good exercice for next templated class in java ... First use of this is to convert Object to pixels for various graphics type.

See Also:

Float, Double, Date, LinearNumberScale

Method Summary

double	getScaleForBar() Deprecated.
double	getScaleMax() Deprecated.
double	getScaleMin() Deprecated.
java.lang.Object	getValueMax(java.lang.Object _value) Deprecated. Store in _value the highest value scale can take.
java.lang.Object	getValueMin(java.lang.Object _value) Deprecated. Store in _value the lowest value scale can take.
boolean	isReversed() Deprecated.
boolean	isValid() Deprecated.
void	setLocale(com.ibm.icu.util.ULocale _locale) Deprecated. Set the locale for the text format.
void	setReversed(boolean b) Deprecated. Change the "reversed" property value for this scale.
void	setScaleRange(double _d_min, double _d_max) Deprecated. Change double bounds, ie: range.
void	setTextFormat(com.ibm.icu.text.UFormat _format) Deprecated. Set the object formatter for text used by this scale.
void	setValueRange(java.lang.Object v1, java.lang.Object v2) Deprecated. Change values range
java.lang.Object	stepFirst(java.lang.Object _step) Deprecated.
java.lang.Object	stepNext(java.lang.Object _step, java.lang.Object _last) Deprecated.
double	toScale(java.lang.Object _value) Deprecated.
java.lang.Object	toValue(double _dbl, java.lang.Object _value) Deprecated.
java.lang.String	valueText(java.lang.Object Value) Deprecated.

Method Detail

isValid

boolean isValid()

Deprecated.

Returns:

true is the scale is valid, and can be used to draw and convert...

toScale

double toScale(java.lang.Object _value)

Deprecated.

Returns:

double value from object value

toValue

java.lang.Object toValue(double _dbl,
                         java.lang.Object _value)

Deprecated.

Returns:

the value corresponding to double, allocate a new value if parameter is null or can't be modified with value.

getValueMax

java.lang.Object getValueMax(java.lang.Object _value)

Deprecated.

Store in _value the highest value scale can take.

Returns:

_value or new allocated object if _value is null (or have class that can be changed)

getValueMin

java.lang.Object getValueMin(java.lang.Object _value)

Deprecated.

Store in _value the lowest value scale can take.

Returns:

_value or new allocated object if _value is null (or have class that can be changed)

getScaleMin

double getScaleMin()

Deprecated.

Returns:

minimal double value.

getScaleMax

double getScaleMax()

Deprecated.

Returns:

maximal double value.

setScaleRange

void setScaleRange(double _d_min,
                   double _d_max)

Deprecated.

Change double bounds, ie: range.

setValueRange

void setValueRange(java.lang.Object v1,
                   java.lang.Object v2)

Deprecated.

Change values range

stepFirst

java.lang.Object stepFirst(java.lang.Object _step)

Deprecated.

Returns:

For given step, the first 'scaled' value. This method must be called once before scaleNext(). Or null if steps can't be handled.

stepNext

java.lang.Object stepNext(java.lang.Object _step,
                          java.lang.Object _last)

Deprecated.

Returns:

For given step and value (returned by scaleFirst, for scaleNext), the next 'scaled' value. or null if next step can't be done.

valueText

java.lang.String valueText(java.lang.Object Value)

Deprecated.

Returns:

the textual formatted text from a value, this text will be used for drawing. The text format depends on the locale which is used. If locale is null the current locale is used

See Also:

com.ibm.icu.Format

setTextFormat

void setTextFormat(com.ibm.icu.text.UFormat _format)

Deprecated.

Set the object formatter for text used by this scale.

setLocale

void setLocale(com.ibm.icu.util.ULocale _locale)

Deprecated.

Set the locale for the text format.

isReversed

boolean isReversed()

Deprecated.

Returns:

true is this scale is a "reversed" scale. A reversed scale is a scale where pixel for min. value is greate than pixel for max. value. in other words, for an horizontal scale, a reversed scale is right to left. This property is important when you want to compare locations, be care full of '>' and '<'.

setReversed

void setReversed(boolean b)

Deprecated.

Change the "reversed" property value for this scale. @see isReversed().

getScaleForBar

double getScaleForBar()

Deprecated.

Returns:

double to use as the base for Bars of an histogram. for example, if pixel scale deal with float values, this pixel correspond to value 0.0f in the scale, of closest pixel to 0 value.