Class SingletonAlphabet
- All Implemented Interfaces:
Serializable
,Annotatable
,Alphabet
,FiniteAlphabet
,Changeable
- Author:
- Matthew Pocock
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.biojava.bio.Annotatable
Annotatable.AnnotationForwarder
-
Field Summary
Fields inherited from class org.biojava.bio.symbol.AbstractAlphabet
serialVersionUID
Fields inherited from interface org.biojava.bio.symbol.Alphabet
EMPTY_ALPHABET, PARSERS, SYMBOLS
Fields inherited from interface org.biojava.bio.Annotatable
ANNOTATION
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
protected boolean
Return an ordered List of the alphabets which make up a compound alphabet.Should return the associated annotation object.getName()
Get the name of the alphabet.protected AtomicSymbol
getSymbolImpl
(List symList) getTokenization
(String name) Get a SymbolTokenization by name.iterator()
Retrieve an Iterator over the AtomicSymbols in this FiniteAlphabet.void
removeSymbol
(Symbol sym) Remove a symbol from this alphabet.int
size()
The number of symbols in the alphabet.Methods inherited from class org.biojava.bio.symbol.AbstractAlphabet
addSymbol, contains, getAmbiguity, getAmbiguityImpl, getGapSymbol, getSymbol, putTokenization, readResolve, toString, validate
Methods inherited from class org.biojava.utils.AbstractChangeable
addChangeListener, addChangeListener, generateChangeSupport, getChangeSupport, hasListeners, hasListeners, isUnchanging, removeChangeListener, removeChangeListener
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.biojava.bio.symbol.Alphabet
contains, getAmbiguity, getGapSymbol, getSymbol, validate
Methods inherited from interface org.biojava.utils.Changeable
addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListener
Methods inherited from interface org.biojava.bio.symbol.FiniteAlphabet
addSymbol
-
Constructor Details
-
SingletonAlphabet
-
-
Method Details
-
getAlphabets
Description copied from interface:Alphabet
Return an ordered List of the alphabets which make up a compound alphabet. For simple alphabets, this will return a singleton list of itself. The returned list should be immutable.- Specified by:
getAlphabets
in interfaceAlphabet
- Returns:
- a List of alphabets
-
containsImpl
- Specified by:
containsImpl
in classAbstractAlphabet
-
getName
Description copied from interface:Alphabet
Get the name of the alphabet. -
getTokenization
Description copied from interface:Alphabet
Get a SymbolTokenization by name.
The parser returned is guaranteed to return Symbols and SymbolLists that conform to this alphabet.
Every alphabet should have a SymbolTokenzation under the name 'token' that uses the symbol token characters to translate a string into a SymbolList. Likewise, there should be a SymbolTokenization under the name 'name' that uses symbol names to identify symbols. Any other names may also be defined, but the behavior of the returned SymbolTokenization is not defined here.
A SymbolTokenization under the name 'default' should be defined for all sequences, that determines the behavior when printing out a sequence. Standard behavior is to define the 'token' SymbolTokenization as default if it exists, else to define the 'name' SymbolTokenization as the default, but others are possible.
- Specified by:
getTokenization
in interfaceAlphabet
- Overrides:
getTokenization
in classAbstractAlphabet
- Parameters:
name
- the name of the parser- Returns:
- a parser for that name
- Throws:
NoSuchElementException
- if the name is unknown
-
iterator
Description copied from interface:FiniteAlphabet
Retrieve an Iterator over the AtomicSymbols in this FiniteAlphabet.Each AtomicSymbol as for which this.contains(as) is true will be returned exactly once by this iterator in no specified order.
- Specified by:
iterator
in interfaceFiniteAlphabet
- Returns:
- an Iterator over the contained AtomicSymbol objects
-
size
Description copied from interface:FiniteAlphabet
The number of symbols in the alphabet.- Specified by:
size
in interfaceFiniteAlphabet
- Returns:
- the size of the alphabet
-
getAnnotation
Description copied from interface:Annotatable
Should return the associated annotation object.- Specified by:
getAnnotation
in interfaceAnnotatable
- Returns:
- an Annotation object, never null
-
addSymbolImpl
- Specified by:
addSymbolImpl
in classAbstractAlphabet
- Throws:
IllegalSymbolException
-
removeSymbol
Description copied from interface:FiniteAlphabet
Remove a symbol from this alphabet.If the symbol matches multiple AtomicSymbols, then each matching symbol it will be removed.
- Specified by:
removeSymbol
in interfaceFiniteAlphabet
- Parameters:
sym
- the Symbol to removeintGot- Throws:
IllegalSymbolException
- if the symbol is null, or if for any reason it can't be removed
-
getSymbolImpl
- Specified by:
getSymbolImpl
in classAbstractAlphabet
- Throws:
IllegalSymbolException
-