Package chemaxon.descriptors

Enum MetricsType

java.lang.Object

java.lang.Enum<MetricsType>

chemaxon.descriptors.MetricsType

All Implemented Interfaces:

Serializable, Comparable<MetricsType>

@PublicAPI
public enum MetricsType
extends Enum<MetricsType>

Since:

jchem 5.2.5

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT
DICE
EUCLIDEAN
NORMALIZED_EUCLIDEAN
SUBSTRUCTURE
SUPERSTRUCTURE
TANIMOTO
TVERSKY

Field Summary

Fields

Modifier and Type	Field	Description
static String	SEPARATOR

Method Summary

Modifier and Type	Method	Description
String	getSimpleParamString()
static MetricsType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MetricsType[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TANIMOTO

public static final MetricsType TANIMOTO

TVERSKY

public static final MetricsType TVERSKY

DICE

public static final MetricsType DICE

EUCLIDEAN

public static final MetricsType EUCLIDEAN

NORMALIZED_EUCLIDEAN

public static final MetricsType NORMALIZED_EUCLIDEAN

SUBSTRUCTURE

public static final MetricsType SUBSTRUCTURE

SUPERSTRUCTURE

public static final MetricsType SUPERSTRUCTURE

DEFAULT

public static final MetricsType DEFAULT

Field Detail

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

Method Detail

values

public static MetricsType[] 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 (MetricsType c : MetricsType.values())
    System.out.println(c);

Returns:

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

valueOf

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

getSimpleParamString

public String getSimpleParamString()

Returns:

simple parameter string that can be used to parametrize the GUI. separator char between tokens currently is ":"
The default SEPARATOR is used ";" .
number of paramters:names of the parameters enumerated and separated with ";" : ranges for parameters separated with ";" : default values for parameters separated with ";" : default threshold for the metric: help text
eg:
2:queryWeight;targetWeight:0..1;0..1:0.5;0.5:0.5:help text here...