de.toem.impulse.domain

Enum IndexBase

java.lang.Object

java.lang.Enum<IndexBase>

de.toem.impulse.domain.IndexBase

All Implemented Interfaces:

IDomainBase, IReaderDomainBaseProvider, Serializable, Comparable<IndexBase>

public enum IndexBase
extends Enum<IndexBase>
implements IDomainBase

Enum Constant Summary

Enum Constants

Enum Constant and Description
n

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOMAIN_LABEL

Fields inherited from interface de.toem.impulse.domain.IDomainBase

STYLE_ALLOW_0_WITHOUT_UNITS, STYLE_AUTO_UNIT, STYLE_DEFAULT, STYLE_DELTA, STYLE_PREFFERED_UNIT, STYLE_REMOVE_TRAILING_ZEROS, UL0, UL1, UL2

Method Summary

Modifier and Type	Method and Description
static IndexBase	bestFit(double diff)
long	convertTo(IDomainBase base, long unit)
long[]	convertTo(IDomainBase base, long[] units)
String	getDomainLabel()
BigDecimal	getQuantum()
IDomainBase	getReaderBase(IDomainBase samplesBase)
boolean	isCompatible(IDomainBase base)
boolean	isFinerThan(IDomainBase base)
boolean	isPreferred()
static IndexBase	parse(String text)
long	parseUnits(String value)
void	setPreferred(boolean preferred)
double	toCommonBase()
double	toCommonBase(long units)
String	toString() Returns the name of this enum constant, as contained in the declaration.
String	toString(long units)
String	toString(long units, int style)
int	userLevel()
static IndexBase	valueOf(int ordinal)
static IndexBase	valueOf(String name) Returns the enum constant of this type with the specified name.
static IndexBase[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.toem.impulse.domain.IDomainBase

ordinal

Enum Constant Detail

n

public static final IndexBase n

Field Detail

DOMAIN_LABEL

public static final String DOMAIN_LABEL

See Also:

Constant Field Values

Method Detail

values

public static IndexBase[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IndexBase c : IndexBase.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IndexBase valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

userLevel

public int userLevel()

Specified by:

userLevel in interface IDomainBase

setPreferred

public void setPreferred(boolean preferred)

Specified by:

setPreferred in interface IDomainBase

isPreferred

public boolean isPreferred()

Specified by:

isPreferred in interface IDomainBase

toString

public String toString()

Description copied from class: Enum

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum type should override this method when a more "programmer-friendly" string form exists.

Overrides:

toString in class Enum<IndexBase>

Returns:

the name of this enum constant

toString

public String toString(long units)

Specified by:

toString in interface IDomainBase

toString

public String toString(long units,
                       int style)

Specified by:

toString in interface IDomainBase

getQuantum

public BigDecimal getQuantum()

Specified by:

getQuantum in interface IDomainBase

toCommonBase

public double toCommonBase()

Specified by:

toCommonBase in interface IDomainBase

toCommonBase

public double toCommonBase(long units)

Specified by:

toCommonBase in interface IDomainBase

parse

public static IndexBase parse(String text)

bestFit

public static IndexBase bestFit(double diff)

valueOf

public static IndexBase valueOf(int ordinal)

isCompatible

public boolean isCompatible(IDomainBase base)

Specified by:

isCompatible in interface IDomainBase

convertTo

public long[] convertTo(IDomainBase base,
                        long[] units)

Specified by:

convertTo in interface IDomainBase

convertTo

public long convertTo(IDomainBase base,
                      long unit)

Specified by:

convertTo in interface IDomainBase

getDomainLabel

public String getDomainLabel()

Specified by:

getDomainLabel in interface IDomainBase

parseUnits

public long parseUnits(String value)

Specified by:

parseUnits in interface IDomainBase

isFinerThan

public boolean isFinerThan(IDomainBase base)

Specified by:

isFinerThan in interface IDomainBase

getReaderBase

public IDomainBase getReaderBase(IDomainBase samplesBase)

Specified by:

getReaderBase in interface IReaderDomainBaseProvider