org.jplot2d.axtick

Class TickCalculator

java.lang.Object

org.jplot2d.axtick.TickCalculator

Direct Known Subclasses:

DoubleTickCalculator, LongTickCalculator

public abstract class TickCalculator
extends java.lang.Object

A calculator to calculate tick values and minor tick values

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO_MINORTICK_NUMBER
static double	DOUBLE_PRECISION_TOLERANCE The Tolerance error for double computing.

Constructor Summary

Constructors

Constructor and Description
TickCalculator()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	calcLabelFormatString(java.lang.Object values) Calculate a proper format string to format the labels on given values.
abstract java.text.Format	calcLabelTextFormat(java.lang.Object values) Calculate a proper text format to format the labels on given values.
abstract void	calcValuesByTickInterval(double interval, double offset, int minorTickNumber) Calculate the tick values by the given interval and minor ticks number.
abstract void	calcValuesByTickNumber(int tickNumber, int minorTickNumber) Calculate the tick values by the given tick number and minor ticks number.
MathElement[]	formatValues(java.text.Format format, java.lang.Object values) Returns a formatted string using the specified format string on the given value array.
MathElement[]	formatValues(java.lang.String format, java.lang.Object values) Returns a formatted string using the specified format string on the given value array.
abstract int[]	getInRangeValuesIdx(java.lang.Object v) Return all values within the range.
abstract double	getInterval()
abstract java.lang.String	getLabelFormate() Returns a proper format string to format the labels on ticks values returned by getValues().
abstract int	getMinorNumber()
abstract java.lang.Object	getMinorValues()
abstract Range	getRange()
abstract java.lang.Object	getValues()
abstract boolean	isValidFormat(java.lang.String format) Returns true if the given format is valid for this tick calculator
abstract void	setRange(Range range)

Methods inherited from class java.lang.Object

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

Field Detail

AUTO_MINORTICK_NUMBER

public static final int AUTO_MINORTICK_NUMBER

See Also:

Constant Field Values

DOUBLE_PRECISION_TOLERANCE

public static final double DOUBLE_PRECISION_TOLERANCE

The Tolerance error for double computing. doublePrecisionLimit is 0x1.0p-52

See Also:

Constant Field Values

Constructor Detail

TickCalculator

public TickCalculator()

Method Detail

getRange

public abstract Range getRange()

setRange

public abstract void setRange(Range range)

calcValuesByTickNumber

public abstract void calcValuesByTickNumber(int tickNumber,
                                            int minorTickNumber)

Calculate the tick values by the given tick number and minor ticks number. The minor ticks number is a proposed value, and may be different from actual minor ticks number returned by getMinorNumber().

Parameters:

tickNumber -

minorTickNumber - if the given number is AUTO_MINORTICK_NUMBER, the tick number is automatically chosen.

calcValuesByTickInterval

public abstract void calcValuesByTickInterval(double interval,
                                              double offset,
                                              int minorTickNumber)

Calculate the tick values by the given interval and minor ticks number. The minor ticks number is a proposed value, and may be different from actual minor ticks number returned by getMinorNumber().

Parameters:

interval -

offset -

minorTickNumber - if the given number is AUTO_MINORTICK_NUMBER, the tick number is derived from interval.

getInterval

public abstract double getInterval()

Returns:

the tick interval.

getMinorNumber

public abstract int getMinorNumber()

Returns:

the actual minor tick number.

getValues

public abstract java.lang.Object getValues()

Returns:

the tick values

getMinorValues

public abstract java.lang.Object getMinorValues()

Returns:

the minor tick values

getInRangeValuesIdx

public abstract int[] getInRangeValuesIdx(java.lang.Object v)

Return all values within the range.

Parameters:

v -

Returns:

calcLabelTextFormat

public abstract java.text.Format calcLabelTextFormat(java.lang.Object values)

Calculate a proper text format to format the labels on given values. A calculator can just returns a text format and do not provide a format string (returns a empty string). If The returned text format is null, a proper format string must be provided.

Parameters:

values -

Returns:

a text format object

calcLabelFormatString

public abstract java.lang.String calcLabelFormatString(java.lang.Object values)

Calculate a proper format string to format the labels on given values.

Parameters:

values -

Returns:

getLabelFormate

public abstract java.lang.String getLabelFormate()

Returns a proper format string to format the labels on ticks values returned by getValues(). Some calculator can derive format from its internal status directly.

isValidFormat

public abstract boolean isValidFormat(java.lang.String format)

Returns true if the given format is valid for this tick calculator

Parameters:

format -

formatValues

public MathElement[] formatValues(java.lang.String format,
                                  java.lang.Object values)

Returns a formatted string using the specified format string on the given value array.

Parameters:

format - A format string

v - the value array to be formatted.

Returns:

A formatted string.

formatValues

public MathElement[] formatValues(java.text.Format format,
                                  java.lang.Object values)

Returns a formatted string using the specified format string on the given value array.

Parameters:

format - A text format

v - the value array to be formatted.

Returns:

A formatted string.