TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.chart.internal
Class CategoryScale

java.lang.Object
  extended by org.eclipse.tptp.platform.report.chart.internal.CategoryScale
All Implemented Interfaces:
IScale

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 class CategoryScale
extends java.lang.Object
implements IScale

Implementation of IScale for Object instance of Category (ie: Integer,Float,Double, ... VFloat,VDouble,... ). This scale can be used also using directly double primitive type.

See Also:
IScale.

Field Summary
protected  java.util.List categories
          Deprecated.  
protected  double dmax_
          Deprecated.  
protected  double dmin_
          Deprecated.  
protected  java.text.Format format_
          Deprecated.  
protected  double k_
          Deprecated.  
protected  java.util.Locale locale_
          Deprecated.  
protected  boolean reverse_
          Deprecated.  
protected  double vmax_
          Deprecated.  
protected  double vmin_
          Deprecated.  
 
Constructor Summary
CategoryScale(java.util.List cat)
          Deprecated.  
 
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(java.util.Locale _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 dmin, double dmax)
          Deprecated. Change double bounds, ie: range.
 void setTextFormat(java.text.Format _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.String toString()
          Deprecated.  
 java.lang.Object toValue(double dbl, java.lang.Object _value)
          Deprecated.  
 java.lang.String valueText(java.lang.Object _value)
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

dmin_

protected double dmin_
Deprecated. 

dmax_

protected double dmax_
Deprecated. 

vmin_

protected double vmin_
Deprecated. 

vmax_

protected double vmax_
Deprecated. 

k_

protected double k_
Deprecated. 

reverse_

protected boolean reverse_
Deprecated. 

format_

protected java.text.Format format_
Deprecated. 

categories

protected java.util.List categories
Deprecated. 

locale_

protected java.util.Locale locale_
Deprecated. 
Constructor Detail

CategoryScale

public CategoryScale(java.util.List cat)
Deprecated. 
Method Detail

setValueRange

public void setValueRange(java.lang.Object v1,
                          java.lang.Object v2)
Deprecated. 
Description copied from interface: IScale
Change values range

Specified by:
setValueRange in interface IScale

isValid

public boolean isValid()
Deprecated. 
Specified by:
isValid in interface IScale
Returns:
true is the scale is valid, and can be used to draw and convert...

setTextFormat

public void setTextFormat(java.text.Format _format)
Deprecated. 
Description copied from interface: IScale
Set the object formatter for text used by this scale.

Specified by:
setTextFormat in interface IScale

valueText

public java.lang.String valueText(java.lang.Object _value)
Deprecated. 
Specified by:
valueText in interface IScale
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

setReversed

public void setReversed(boolean b)
Deprecated. 
Description copied from interface: IScale
Change the "reversed" property value for this scale. @see isReversed().

Specified by:
setReversed in interface IScale

isReversed

public boolean isReversed()
Deprecated. 
Specified by:
isReversed in interface IScale
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 '<'.

getValueMax

public java.lang.Object getValueMax(java.lang.Object _value)
Deprecated. 
Description copied from interface: IScale
Store in _value the highest value scale can take.

Specified by:
getValueMax in interface IScale
Returns:
_value or new allocated object if _value is null (or have class that can be changed)

getValueMin

public java.lang.Object getValueMin(java.lang.Object _value)
Deprecated. 
Description copied from interface: IScale
Store in _value the lowest value scale can take.

Specified by:
getValueMin in interface IScale
Returns:
_value or new allocated object if _value is null (or have class that can be changed)

getScaleMin

public double getScaleMin()
Deprecated. 
Specified by:
getScaleMin in interface IScale
Returns:
minimal double value.

getScaleMax

public double getScaleMax()
Deprecated. 
Specified by:
getScaleMax in interface IScale
Returns:
maximal double value.

toScale

public double toScale(java.lang.Object _value)
Deprecated. 
Specified by:
toScale in interface IScale
Returns:
double value from object value

toValue

public java.lang.Object toValue(double dbl,
                                java.lang.Object _value)
Deprecated. 
Specified by:
toValue in interface IScale
Returns:
the value corresponding to double, allocate a new value if parameter is null or can't be modified with value.

setScaleRange

public void setScaleRange(double dmin,
                          double dmax)
Deprecated. 
Description copied from interface: IScale
Change double bounds, ie: range.

Specified by:
setScaleRange in interface IScale

stepFirst

public java.lang.Object stepFirst(java.lang.Object _step)
Deprecated. 
Specified by:
stepFirst in interface IScale
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

public java.lang.Object stepNext(java.lang.Object _step,
                                 java.lang.Object _last)
Deprecated. 
Specified by:
stepNext in interface IScale
Returns:
For given step and value, next 'scaled' value. (>vmax to stop)

getScaleForBar

public double getScaleForBar()
Deprecated. 
Specified by:
getScaleForBar in interface IScale
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.

toString

public java.lang.String toString()
Deprecated. 
Overrides:
toString in class java.lang.Object

setLocale

public void setLocale(java.util.Locale _locale)
Deprecated. 
Description copied from interface: IScale
Set the locale for the text format.

Specified by:
setLocale in interface IScale

TPTP 4.5.0 Platform Project
Internal API Specification