Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## de.jstacs.classifier.assessment
Class ClassifierAssessmentAssessParameterSet

    java.lang.Object
      de.jstacs.parameters.ParameterSet
          de.jstacs.classifier.assessment.ClassifierAssessmentAssessParameterSet

All Implemented Interfaces:
  RangeIterator, Storable, Cloneable

Direct Known Subclasses:
  KFoldCVAssessParameterSet, RepeatedHoldOutAssessParameterSet, RepeatedSubSamplingAssessParameterSet, Sampled_RepeatedHoldOutAssessParameterSet

    public class ClassifierAssessmentAssessParameterSet

extends ParameterSet

This class is the super-class used by all `ClassifierAssessmentAssessParameterSet`s. It is a container of user-specified parameters necessary to define a run of an `ClassifierAssessment`. In contrast to `AssessmentAssessParameterSet`s that are necessary to start an `ClassifierAssessment`, `ClassifierAssessmentParameterSet`s are necessary to instantiate a `ClassifierAssessment`-object.

Author:
  andr|e gohr (a0coder (nospam:@) gmail (nospam:.) com)

Nested Class Summary

Nested classes/interfaces inherited from class de.jstacs.parameters.ParameterSet
`ParameterSet.ParameterList`

Field Summary

Fields inherited from class de.jstacs.parameters.ParameterSet
`alternativeInstanceClass, errorMessage, parameters, parent, ranged`

Constructor Summary
`` | `ClassifierAssessmentAssessParameterSet()` inherited from `ParameterSet`
`protected` | `ClassifierAssessmentAssessParameterSet(Class alternativeInstanceClass)` inherited from `ParameterSet`
`` | `ClassifierAssessmentAssessParameterSet(int elementLength, boolean exceptionIfMPNotComputable)`
`` | `ClassifierAssessmentAssessParameterSet(StringBuffer representation)` inherited from `ParameterSet`

Method Summary
`static ParameterSet[]` | `getAllClassifierAssessmentAssessParameterSets()`
`Collection<Result>` | `getAnnotation()`
`int` | `getElementLength()`
`boolean` | `getExceptionIfMPNotComputable()`
`String` | `getInstanceComment()` Returns a comment (a textual description) of the class that can be constructed using this `ParameterSet`.
`String` | `getInstanceName()` Returns the name of an instance of the class that can be constructed using this `ParameterSet`.
`protected void` | `initializeMyParametersArrayList()` Initializes the list of `Parameter`s in this `ParameterSet`.
`protected void` | `loadParameters()` Loads the parameters for this `ParameterSet`.

Methods inherited from class de.jstacs.parameters.ParameterSet
`clone, fromXML, getErrorMessage, getId, getInstance, getInstanceClass, getNumberOfParameters, getNumberOfValues, getParameterAt, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isRanged, makeRanged, next, parametersLoaded, propagateId, recieveId, replaceParametersWithRangedInstance, reset, resetToFirst, setAlternativeInstanceClass, setParent, simplify, toXML, valuesToString`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### ClassifierAssessmentAssessParameterSet

    protected ClassifierAssessmentAssessParameterSet(Class alternativeInstanceClass)

  inherited from `ParameterSet`

### ClassifierAssessmentAssessParameterSet

    public ClassifierAssessmentAssessParameterSet()
                                           throws UnsupportedOperationException

  inherited from `ParameterSet`

  Throws:
    `UnsupportedOperationException`

### ClassifierAssessmentAssessParameterSet

    public ClassifierAssessmentAssessParameterSet(StringBuffer representation)
                                           throws NonParsableException

  inherited from `ParameterSet`

  Throws:
    `NonParsableException`

### ClassifierAssessmentAssessParameterSet

    public ClassifierAssessmentAssessParameterSet(int elementLength,
                                                  boolean exceptionIfMPNotComputable)
                                           throws SimpleParameter.IllegalValueException

Parameters:
  `elementLength` - defines the length of elements (sequences) the classifiers to be assessed are able to classify
  `exceptionIfMPNotComputable` - a `ClassifierAssessmentAssessParameterSet` is used in combination with an `MeasureParameters`-object to call `assess`-methods of `CLassifierAssessment`s. If `exceptionIfMPNotComputable=true` then an expection is thrown in case of a selected measure-parameters that could not be computed.
Throws:
  `SimpleParameter.IllegalValueException` - is thrown in case of out-of-range or invalid given parameters

Method Detail

### getAllClassifierAssessmentAssessParameterSets

    public static final ParameterSet[] getAllClassifierAssessmentAssessParameterSets()

  Returns:
    all different yet implemented `ClassifierAssessmentAssessParameterSets`. This method is used by `ClassifierAssessmentTaskParameterSet` to allow a user to chose a certain assessment to assess user specified classifiers.

### initializeMyParametersArrayList

    protected void initializeMyParametersArrayList()

  Initializes the list of `Parameter`s in this `ParameterSet`.

### loadParameters

    protected void loadParameters()
                           throws Exception

  Description copied from class: `ParameterSet`
  Loads the parameters for this `ParameterSet`. This is in most cases done by simply creating a new `ArrayList<Parameter>` for the field `parameters/code> and filling it with instances of subclasses of `Parameter`

  `
  Specified by:
    `loadParameters` in class `ParameterSet`
  Throws:
    `Exception` - an `Exception` is thrown if the parameters could not be loaded
  See Also:
    `ParameterSet.parameters`, `Parameter`

### getInstanceName

    public String getInstanceName()

  Description copied from class: `ParameterSet`
  Returns the name of an instance of the class that can be constructed using this `ParameterSet`.

  Specified by:
    `getInstanceName` in class `ParameterSet`
  Returns:
    the name

### getInstanceComment

    public String getInstanceComment()

  Description copied from class: `ParameterSet`
  Returns a comment (a textual description) of the class that can be constructed using this `ParameterSet`.

  Specified by:
    `getInstanceComment` in class `ParameterSet`
  Returns:
    the comment

### getElementLength

    public int getElementLength()

  Returns:
    the elementLength defined by this `ClassifierAssessmentAssessParameterSet```

### getExceptionIfMPNotComputable

    public boolean getExceptionIfMPNotComputable()

  Returns:
    the flag defined by this `ClassifierAssessmentAssessParameterSet`(true: an exception is thrown if user selected measure-parameters that could not be computed. false: not)``

### getAnnotation

    public Collection<Result> getAnnotation()

  Returns:
    collection of parameters containing informations about this `ClassifierAssessmentAssessParameterSet`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD