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.results
Class CategoricalResult

    java.lang.Object
      de.jstacs.AnnotatedEntity
          de.jstacs.results.Result
              de.jstacs.results.SimpleResult
                  de.jstacs.results.CategoricalResult

All Implemented Interfaces:
  Storable, Comparable<SimpleResult>

    public class CategoricalResult

extends SimpleResult

A class for categorical results (i.e. non-numerical results) for primitives and `String`s.

Author:
  Jan Grau

Field Summary

Fields inherited from class de.jstacs.results.SimpleResult
`result`

Fields inherited from class de.jstacs.AnnotatedEntity
`comment, datatype, name`

Constructor Summary
`CategoricalResult(DataType datatype, String name, String comment, Comparable result)` Creates a result of a primitive categorical data type or a `String` .
`CategoricalResult(StringBuffer representation)` The standard constructor for the interface `Storable`.
`CategoricalResult(String name, String comment, boolean result)` Creates a result of a `boolean`.
`CategoricalResult(String name, String comment, String result)` Creates a result of a `String`.

Method Summary
`String` | `getXMLTag()` This method returns a tag used as outer tag of the XML description.

Methods inherited from class de.jstacs.results.SimpleResult
`appendFurtherInfos, compareTo, equals, extractFurtherInfos, getValue, toString`

Methods inherited from class de.jstacs.results.Result
`checkDatatype, createResult, isCastableResult, isComparableResult`

Methods inherited from class de.jstacs.AnnotatedEntity
`getComment, getDatatype, getName, toXML`

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

Constructor Detail

### CategoricalResult

    public CategoricalResult(StringBuffer representation)
                      throws NonParsableException

  The standard constructor for the interface `Storable`. Creates a new `CategoricalResult` from its XML representation.

  Parameters:
    `representation` - the XML representation as `StringBuffer`
  Throws:
    `NonParsableException` - if the `StringBuffer` `representation` could not be parsed

### CategoricalResult

    public CategoricalResult(DataType datatype,
                             String name,
                             String comment,
                             Comparable result)
                      throws SimpleParameter.IllegalValueException

  Creates a result of a primitive categorical data type or a `String` .

  Parameters:
    `datatype` - the primitive data type
    `name` - the name of the result
    `comment` - a comment on the result
    `result` - the result itself
  Throws:
    `SimpleParameter.IllegalValueException` - if the result value is not of the expected data type

### CategoricalResult

    public CategoricalResult(String name,
                             String comment,
                             String result)

  Creates a result of a `String`.

  Parameters:
    `name` - the name of the result
    `comment` - a comment on the result
    `result` - the result itself

### CategoricalResult

    public CategoricalResult(String name,
                             String comment,
                             boolean result)

  Creates a result of a `boolean`.

  Parameters:
    `name` - the name of the result
    `comment` - a comment on the result
    `result` - the result itself

Method Detail

### getXMLTag

    public String getXMLTag()

  Description copied from class: `AnnotatedEntity`
  This method returns a tag used as outer tag of the XML description.

  Specified by:
    `getXMLTag` in class `AnnotatedEntity`
  Returns:
    a tag used as outer tag of the XML description

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