org.opentox.algorithm
Enum AlgorithmEnum

java.lang.Object
  extended by java.lang.Enum<AlgorithmEnum>
      extended by org.opentox.algorithm.AlgorithmEnum
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AlgorithmEnum>, java.lang.Iterable<java.lang.String>

public enum AlgorithmEnum
extends java.lang.Enum<AlgorithmEnum>
implements java.lang.Iterable<java.lang.String>

Enumeration of all available algorithms on the server. If one needs to extend the services to support one more algorithm,this is the place to start.

Version:
1.3.3 (Last update: Dec 20, 2009)
Author:
OpenTox - http://www.opentox.org/, Sopasakis Pantelis, Sarimveis Harry

Nested Class Summary
private  class AlgorithmEnum.IteratorImpl
           
 
Enum Constant Summary
mlr
          Multiple Linear Regression Algorithm.
svc
          Support Vector Machines Classification Algorithm.
svm
          Support Vector Machines Regression Algorithm.
unknown
          Unknown Algorithm.
 
Field Summary
private  java.lang.String name
          The name of the algorithm.
 
Method Summary
static AlgorithmEnum getAlgorithmEnum(java.lang.String name)
          Returns the AlgorithmEnum enumeration element which has a certain name.
 java.lang.String getAlgorithmName()
          Returns the name of the algorithm.
static java.util.Iterator<java.lang.String> getIterator()
           
 java.util.Iterator<java.lang.String> iterator()
          Iterator over all algorithm names.
static AlgorithmEnum valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AlgorithmEnum[] 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

svm

public static final AlgorithmEnum svm
Support Vector Machines Regression Algorithm.


svc

public static final AlgorithmEnum svc
Support Vector Machines Classification Algorithm.


mlr

public static final AlgorithmEnum mlr
Multiple Linear Regression Algorithm.


unknown

public static final AlgorithmEnum unknown
Unknown Algorithm.

Field Detail

name

private final java.lang.String name
The name of the algorithm.

Method Detail

values

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

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

valueOf

public static AlgorithmEnum valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getAlgorithmName

public java.lang.String getAlgorithmName()
Returns the name of the algorithm.

Returns:
the formal name of the algorithm.

getAlgorithmEnum

public static AlgorithmEnum getAlgorithmEnum(java.lang.String name)
Returns the AlgorithmEnum enumeration element which has a certain name. If the given name does not correspond to a registered algorithm, it returns unknown

Parameters:
name - Name of an algorithm (case sensitive)
Returns:
the AlgorithmEnum object for the given name.

iterator

public java.util.Iterator<java.lang.String> iterator()
Iterator over all algorithm names.

Specified by:
iterator in interface java.lang.Iterable<java.lang.String>
Returns:
Iterator.

getIterator

public static java.util.Iterator<java.lang.String> getIterator()