de.jstacs.data.alphabets
Class DiscreteAlphabet.DiscreteAlphabetParameterSet

java.lang.Object
  extended by de.jstacs.parameters.ParameterSet
      extended by de.jstacs.parameters.InstanceParameterSet<T>
          extended by de.jstacs.data.alphabets.Alphabet.AlphabetParameterSet
              extended by de.jstacs.data.alphabets.DiscreteAlphabet.DiscreteAlphabetParameterSet
All Implemented Interfaces:
GalaxyConvertible, Storable, Cloneable
Direct Known Subclasses:
GenericComplementableDiscreteAlphabet.GenericComplementableDiscreteAlphabetParameterSet
Enclosing class:
DiscreteAlphabet

public static class DiscreteAlphabet.DiscreteAlphabetParameterSet
extends Alphabet.AlphabetParameterSet

Class for the ParameterSet of a DiscreteAlphabet.

Author:
Jan Grau

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
errorMessage, parameters, parent
 
Constructor Summary
  DiscreteAlphabet.DiscreteAlphabetParameterSet()
          Creates a new DiscreteAlphabet.DiscreteAlphabetParameterSet with empty values.
  DiscreteAlphabet.DiscreteAlphabetParameterSet(char[] alphabet, boolean caseInsensitive)
          Creates a new DiscreteAlphabet.DiscreteAlphabetParameterSet from an alphabet of symbols given as a char array.
protected DiscreteAlphabet.DiscreteAlphabetParameterSet(Class<? extends DiscreteAlphabet> clazz)
          This constructor should only be used for parameter sets that are intended to created subclasses of DiscreteAlphabet.
  DiscreteAlphabet.DiscreteAlphabetParameterSet(String[] alphabet, boolean caseInsensitive)
          Creates a new DiscreteAlphabet.DiscreteAlphabetParameterSet from an alphabet given as a String array.
  DiscreteAlphabet.DiscreteAlphabetParameterSet(StringBuffer representation)
          The standard constructor for the interface Storable .
 
Method Summary
 String getInstanceComment()
          Returns a comment (a textual description) of the class that can be constructed using this ParameterSet.
 
Methods inherited from class de.jstacs.data.alphabets.Alphabet.AlphabetParameterSet
clone, getInstanceName
 
Methods inherited from class de.jstacs.parameters.InstanceParameterSet
fromXML, getInstance, getInstanceClass, toXML
 
Methods inherited from class de.jstacs.parameters.ParameterSet
fromGalaxy, getAllParameterNames, getComment, getComment, getErrorMessage, getIndex, getName, getName, getNumberOfParameters, getParameterAt, getParameterForName, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isComparable, parametersLoaded, reset, setParent, toGalaxy
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DiscreteAlphabet.DiscreteAlphabetParameterSet

protected DiscreteAlphabet.DiscreteAlphabetParameterSet(Class<? extends DiscreteAlphabet> clazz)
This constructor should only be used for parameter sets that are intended to created subclasses of DiscreteAlphabet.

Parameters:
clazz - the class the should be created with this parameter set

DiscreteAlphabet.DiscreteAlphabetParameterSet

public DiscreteAlphabet.DiscreteAlphabetParameterSet()
                                              throws ParameterException
Creates a new DiscreteAlphabet.DiscreteAlphabetParameterSet with empty values.

Throws:
ParameterException - if the parameters could not be created
See Also:
Alphabet.AlphabetParameterSet.Alphabet.AlphabetParameterSet(Class)

DiscreteAlphabet.DiscreteAlphabetParameterSet

public DiscreteAlphabet.DiscreteAlphabetParameterSet(String[] alphabet,
                                                     boolean caseInsensitive)
                                              throws Exception
Creates a new DiscreteAlphabet.DiscreteAlphabetParameterSet from an alphabet given as a String array.

Parameters:
alphabet - the alphabet as String array
caseInsensitive - indicates if the DiscreteAlphabet shall be case insensitive
Throws:
Exception - if the parameter set could not be created
See Also:
DiscreteAlphabet.DiscreteAlphabetParameterSet()

DiscreteAlphabet.DiscreteAlphabetParameterSet

public DiscreteAlphabet.DiscreteAlphabetParameterSet(char[] alphabet,
                                                     boolean caseInsensitive)
                                              throws Exception
Creates a new DiscreteAlphabet.DiscreteAlphabetParameterSet from an alphabet of symbols given as a char array.

Parameters:
alphabet - the array of symbols
caseInsensitive - indicates if the DiscreteAlphabet shall be case insensitive
Throws:
Exception - if the parameter set could not be created
See Also:
DiscreteAlphabet.DiscreteAlphabetParameterSet()

DiscreteAlphabet.DiscreteAlphabetParameterSet

public DiscreteAlphabet.DiscreteAlphabetParameterSet(StringBuffer representation)
                                              throws NonParsableException
The standard constructor for the interface Storable . Creates a new DiscreteAlphabet.DiscreteAlphabetParameterSet out of its XML representation.

Parameters:
representation - the XML representation as StringBuffer
Throws:
NonParsableException - if the DiscreteAlphabet.DiscreteAlphabetParameterSet could not be reconstructed out of the XML representation (the StringBuffer representation could not be parsed)
See Also:
Alphabet.AlphabetParameterSet.Alphabet.AlphabetParameterSet(StringBuffer), Storable
Method Detail

getInstanceComment

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

Specified by:
getInstanceComment in class InstanceParameterSet
Returns:
the comment of the class