SequenceDocument.Transformer (Geneious Public API)

java.lang.Object
- com.biomatters.geneious.publicapi.documents.sequence.SequenceDocument.Transformer

Enclosing interface:

SequenceDocument
```
public abstract static class SequenceDocument.Transformer
extends java.lang.Object
```
Provides a method for returning a new sequence which represents a transformation made to another sequence. This may be used for example with DefaultSequenceListDocument.createNewDocumentByTransformingSequences

Since:

API 4.40 (Geneious 5.4.0)

- Constructor Summary
  
  Constructors
  Constructor Description
  
  Transformer()
- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  abstract SequenceDocument transformSequence(SequenceDocument sequence)
  Transforms a sequence
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Transformer
```
public Transformer()
```
- Method Detail
  - transformSequence
```
public abstract SequenceDocument transformSequence(SequenceDocument sequence)
                                            throws com.biomatters.geneious.publicapi.plugin.DocumentOperationException
```
    Transforms a sequence
    
    Parameters:
    
    sequence - the sequence to be transformed. The original sequence must not be modified. Instead, a copy should be created first if necessary, for example using SequenceUtilities.createSequenceCopyEditable
    
    Returns:
    
    a new sequence, or the original sequence unmodified if the transformation does not want to change this particular sequence. Or null to exclude the sequence.
    
    Throws:
    
    com.biomatters.geneious.publicapi.plugin.DocumentOperationException - if the transformation fails for any reason.