Package eu.isas.reporter.calculation.normalization

Enum NormalizationType

java.lang.Object

java.lang.Enum<NormalizationType>

eu.isas.reporter.calculation.normalization.NormalizationType

All Implemented Interfaces:

Serializable, Comparable<NormalizationType>, java.lang.constant.Constable

public enum NormalizationType
extends Enum<NormalizationType>

Enum for the different normalization types supported.

Author:

Marc Vaudel

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
mean
median
mode
none
sum

Field Summary

Fields

Modifier and Type	Field	Description
final int	index	The index of the normalization type.
final String	name	The name of the normalization type.

Method Summary

Modifier and Type	Method	Description
static String	getCommandLineDescription()	Returns the different options as command line description.
static NormalizationType	getNormalizationType(int index)	Returns the normalization type corresponding to the given index.
static NormalizationType	getNormalizationType(String name)	Returns the normalization type corresponding to the given name.
static NormalizationType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static NormalizationType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

none

public static final NormalizationType none

median

public static final NormalizationType median

mean

public static final NormalizationType mean

sum

public static final NormalizationType sum

mode

public static final NormalizationType mode

Field Details

index

public final int index

The index of the normalization type.

name

public final String name

The name of the normalization type.

Method Details

values

public static NormalizationType[] values()

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

Returns:

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

valueOf

public static NormalizationType 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

getNormalizationType

public static NormalizationType getNormalizationType(int index)

Returns the normalization type corresponding to the given index.

Parameters:

index - the index of the normalization type

Returns:

the normalization type of interest.

getNormalizationType

public static NormalizationType getNormalizationType(String name)

Returns the normalization type corresponding to the given name.

Parameters:

name - the name of the normalization type

Returns:

the normalization type of interest.

getCommandLineDescription

public static String getCommandLineDescription()

Returns the different options as command line description.

Returns:

the different options as command line description