public static final class SequenceAnnotationGenerator.AnnotationGeneratorResult extends Object
SequenceAnnotationGenerator.generate(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[], com.biomatters.geneious.publicapi.plugin.SequenceAnnotationGenerator.SelectionRange, jebl.util.ProgressListener, Options)| Modifier and Type | Class and Description |
|---|---|
static class |
SequenceAnnotationGenerator.AnnotationGeneratorResult.ResidueAdjustment
An immutable class representing an insertion, deletion, or replacement of residues or bases in a sequence.
|
| Constructor and Description |
|---|
SequenceAnnotationGenerator.AnnotationGeneratorResult()
Constructs a new AnnotationGeneratorResult with no results.
|
SequenceAnnotationGenerator.AnnotationGeneratorResult(List<SequenceAnnotation> annotationsToAdd)
Constructs a new AnnotationGeneratorResult
|
| Modifier and Type | Method and Description |
|---|---|
void |
addAnnotationToAdd(SequenceAnnotation annotation)
Adds an annotation to be added to the sequence once this annotation generator finishes.
|
void |
addAnnotationToRemove(SequenceAnnotation annotation)
Adds an annotation to the list of annotations to be removed from the sequence once this annotation generator finishes.
|
void |
addDocumentFieldToSet(DocumentFieldAndValue documentFieldAndValue)
Adds a document field and value (or replaces an existing note with the same
Object.getClass()) to the sequence. |
void |
addDocumentNoteToSet(DocumentNote documentNote)
Adds (or replaces an existing note with the same
DocumentNote.getNoteTypeCode()) on the sequence. |
void |
addResidueAdjustment(SequenceAnnotationGenerator.AnnotationGeneratorResult.ResidueAdjustment adjustment)
Adds a residue insertion, deletion or adjustment to be applied to the sequence.
|
void |
addSequenceTrackToAdd(SequenceTrack track)
Adds a new sequence track to be added to the sequence once this annotation generator finishes.
|
SequenceDocument |
createNewSequenceWhenAppliedTo(SequenceDocument sourceSequence)
Returns the results of applying this annotation generator result to the given sequence.
|
List<SequenceAnnotation> |
getAnnotationsToAdd()
Get the annotations to be added to this sequence.
|
List<SequenceAnnotation> |
getAnnotationsToRemove()
Get the annotations to be removed from this sequence.
|
List<DocumentFieldAndValue> |
getDocumentFieldsToSet()
Get all document fields and values added using
addDocumentFieldToSet(com.biomatters.geneious.publicapi.documents.DocumentFieldAndValue). |
List<DocumentNote> |
getDocumentNotesToSet()
Get all notes added using
addDocumentNoteToSet(com.biomatters.geneious.publicapi.documents.DocumentNote). |
List<SequenceAnnotationGenerator.AnnotationGeneratorResult.ResidueAdjustment> |
getResidueAdjustments()
Get all residue adjustments added using
addResidueAdjustment(com.biomatters.geneious.publicapi.plugin.SequenceAnnotationGenerator.AnnotationGeneratorResult.ResidueAdjustment). |
List<SequenceTrack> |
getSequenceTracksToAdd()
Gets the sequence tracks to add to this sequence
|
boolean |
isEmpty() |
public SequenceAnnotationGenerator.AnnotationGeneratorResult()
public SequenceAnnotationGenerator.AnnotationGeneratorResult(List<SequenceAnnotation> annotationsToAdd)
annotationsToAdd - a list of annotations to add. This is equivalent to calling the empty constructor and then calling addAnnotationToAdd(com.biomatters.geneious.publicapi.documents.sequence.SequenceAnnotation) for each annotation in annotationsToAdd.public boolean isEmpty()
public void addAnnotationToAdd(SequenceAnnotation annotation)
annotation - an annotation generated for this sequence.public void addAnnotationToRemove(SequenceAnnotation annotation)
annotation - an to remove from this sequence. The annotation must already exist on the sequence.public void addSequenceTrackToAdd(SequenceTrack track)
track - the new track to add to the sequencepublic void addResidueAdjustment(SequenceAnnotationGenerator.AnnotationGeneratorResult.ResidueAdjustment adjustment)
new ResidueAdjustment(0,2,""), new ResidueAdjustment(3,5,"")new ResidueAdjustment(5,7,""), new ResidueAdjustment(0,2,"")adjustment - the adjustment to apply to the sequence.public List<SequenceAnnotationGenerator.AnnotationGeneratorResult.ResidueAdjustment> getResidueAdjustments()
addResidueAdjustment(com.biomatters.geneious.publicapi.plugin.SequenceAnnotationGenerator.AnnotationGeneratorResult.ResidueAdjustment).addResidueAdjustment(com.biomatters.geneious.publicapi.plugin.SequenceAnnotationGenerator.AnnotationGeneratorResult.ResidueAdjustment)public void addDocumentFieldToSet(DocumentFieldAndValue documentFieldAndValue)
Object.getClass()) to the sequence.documentFieldAndValue - the field and value to add (or to replace an existing field)public void addDocumentNoteToSet(DocumentNote documentNote)
DocumentNote.getNoteTypeCode()) on the sequence.documentNote - the new note to add (or to replace an existing node)public List<SequenceAnnotation> getAnnotationsToAdd()
addAnnotationToAdd(com.biomatters.geneious.publicapi.documents.sequence.SequenceAnnotation).public List<SequenceAnnotation> getAnnotationsToRemove()
addAnnotationToRemove(com.biomatters.geneious.publicapi.documents.sequence.SequenceAnnotation).public List<SequenceTrack> getSequenceTracksToAdd()
public List<DocumentFieldAndValue> getDocumentFieldsToSet()
addDocumentFieldToSet(com.biomatters.geneious.publicapi.documents.DocumentFieldAndValue).addDocumentFieldToSet(com.biomatters.geneious.publicapi.documents.DocumentFieldAndValue).public List<DocumentNote> getDocumentNotesToSet()
addDocumentNoteToSet(com.biomatters.geneious.publicapi.documents.DocumentNote).addDocumentNoteToSet(com.biomatters.geneious.publicapi.documents.DocumentNote).public SequenceDocument createNewSequenceWhenAppliedTo(SequenceDocument sourceSequence)
sourceSequence - the sequence to apply the results to. This will not be modified.