ReversibleTranslationTable (biojava-legacy 1.9.5 API)

All Superinterfaces:

TranslationTable

All Known Implementing Classes:

AbstractReversibleTranslationTable, SimpleReversibleTranslationTable
```
public interface ReversibleTranslationTable
extends TranslationTable
```
A translation table that can also translate from the target to source alphabet.
I guess this is encapsulates an invertible function, and the untranslate method is the inverse operation to translate.
It is assumed that untranslate(translate(x)) = x for all x in the source alphabet, and that translate(untranslate(y)) = y for all y in the target alphabet. Note, one interesting sub-set of reversible transforms are of the form translate(x) = untranslate(x), and represent 'mirror image' transformations.

Author:

Matthew Pocock

- Field Summary
  - Fields inherited from interface org.biojava.bio.symbol.TranslationTable
    ALT_YEAST_NUC, ASCID_MITO, BACTERIAL, BLEPH_MNUC, CHLORO_MITO, CILIATE_NUC, ECHIN_MITO, EUPL_NUC, FWORM_MITO, INVERT_MITO, MOLD_MITO, SCENE_MITO, TREMA_MITO, UNIVERSAL, VERT_MITO, YEAST_MITO
- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  Symbol untranslate(Symbol sym)
  Translate a single symbol from target alphabet to the source alphabet.
  - Methods inherited from interface org.biojava.bio.symbol.TranslationTable
    getSourceAlphabet, getTargetAlphabet, translate

- Method Detail
  - untranslate
```
Symbol untranslate(Symbol sym)
            throws IllegalSymbolException
```
    Translate a single symbol from target alphabet to the source alphabet.
    
    Parameters:
    
    sym - the Symbol to translate (member of target alphabet)
    
    Returns:
    
    the translated version of sym (member of source alphabet)
    
    Throws:
    
    IllegalSymbolException - if sym is not a member of the target alphabet