org.scilab.forge.scirenderer.ruler.graduations
Interface Graduations

All Known Implementing Classes:
AbstractGraduations, LinearGraduations, LogarithmicGraduations

public interface Graduations

Author:
Pierre Lando

Method Summary
 boolean contain(double value)
          Return true if the interval contain the given value.
 java.util.List<java.lang.Double> getAllValues()
          Return all values of this graduation.
 Graduations getAlternative()
          Return a child graduation with more values but less than getMore()
 java.text.DecimalFormat getFormat()
          Return an adapted number format.
 double getLowerBound()
          Return the lower bound.
 Graduations getMore()
          Return a child graduation with more values.
 java.util.List<java.lang.Double> getNewValues()
          Return values not present in parents graduations.
 Graduations getParentGraduations()
          Return the parent graduation.
 int getSubDensity()
          Return the density of sub ticks.
 Graduations getSubGraduations()
          Return a child graduation for sub ticks.
 java.util.List<java.lang.Double> getSubGraduations(int N)
          Get the list of subgraduations corresponding to N subticks between two main consecutives ticks
 double getUpperBound()
          Return the upper bound.
 boolean isLowerBoundIncluded()
          Return true if the lower bound is included.
 boolean isUpperBoundIncluded()
          Return true if the lower bound is included.
 

Method Detail

getLowerBound

double getLowerBound()
Return the lower bound.

Returns:
the lower bound.

isLowerBoundIncluded

boolean isLowerBoundIncluded()
Return true if the lower bound is included.

Returns:
true if the lower bound is included.

getUpperBound

double getUpperBound()
Return the upper bound.

Returns:
the upper bound.

isUpperBoundIncluded

boolean isUpperBoundIncluded()
Return true if the lower bound is included.

Returns:
true if the lower bound is included.

contain

boolean contain(double value)
Return true if the interval contain the given value.

Parameters:
value - the given value.
Returns:
true if the interval contain the given value.

getFormat

java.text.DecimalFormat getFormat()
Return an adapted number format.

Returns:
an adapted number format.

getAllValues

java.util.List<java.lang.Double> getAllValues()
Return all values of this graduation.

Returns:
all values of this graduation.

getNewValues

java.util.List<java.lang.Double> getNewValues()
Return values not present in parents graduations.

Returns:
values not present in parents graduations.

getParentGraduations

Graduations getParentGraduations()
Return the parent graduation.

Returns:
the parent graduation.

getMore

Graduations getMore()
Return a child graduation with more values.

Returns:
a child graduation with more values.

getAlternative

Graduations getAlternative()
Return a child graduation with more values but less than getMore()

Returns:
a child graduation with more values but less than getMore()

getSubGraduations

Graduations getSubGraduations()
Return a child graduation for sub ticks.

Returns:
a child graduation for sub ticks.

getSubGraduations

java.util.List<java.lang.Double> getSubGraduations(int N)
Get the list of subgraduations corresponding to N subticks between two main consecutives ticks

Parameters:
N - the number of graduations
Returns:
the corresponding list

getSubDensity

int getSubDensity()
Return the density of sub ticks.

Returns:
the density of sub ticks.