| Package | Description |
|---|---|
| com.biomatters.geneious.publicapi.plugin |
Provides the
GeneiousPlugin interface and plugin
related interfaces. |
| Modifier and Type | Method and Description |
|---|---|
SequenceAnnotationGenerator.SelectionRange |
SequenceAnnotationGenerator.SelectionRange.getNext() |
| Modifier and Type | Method and Description |
|---|---|
List<SequenceAnnotationGenerator.AnnotationGeneratorResult> |
SequenceAnnotationGenerator.generate(AnnotatedPluginDocument[] documents,
SequenceAnnotationGenerator.SelectionRange selectionRange,
ProgressListener progressListener,
Options options)
Create annotations (and/or deletes annotations and/or modifies residues and/or modifies field values) on a set of documents.
|
abstract SequenceAnnotationGenerator.AnnotationGeneratorResult |
SequenceAnnotationGenerator.SingleSequenceResultGenerator.generate(PluginDocument document,
SequenceAnnotationGenerator.SelectionRange selectionRange,
ProgressListener progressListener)
Generate annotations for a single sequence.
|
List<List<SequenceAnnotation>> |
SequenceAnnotationGenerator.generateAnnotations(AnnotatedPluginDocument[] documents,
SequenceAnnotationGenerator.SelectionRange selectionRange,
ProgressListener progressListener,
Options options)
Deprecated.
use
generate instead.
Create annotations from a set of documents.
Note: The operation will be run in a non AWT thread. If you need to perform user interface
interaction in addition to the options provided in the Options (for example prompting for user input)
then you need to place this inside a ThreadUtilities.invokeAndWait() function call.
WARNING: Geneious may call this method multiple times simultaneously.
Therefore, any implementation should not store its internal state
within instance fields.
WARNING: The default implementation of this method calls SequenceAnnotationGenerator.generate(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[], com.biomatters.geneious.publicapi.plugin.SequenceAnnotationGenerator.SelectionRange, jebl.util.ProgressListener, Options)
but returns only the list of annotations, so any tracks, residue additions or deletions, and annotation deletions will not be respected.
If you are invoking a SequenceAnnotationGenerator in another plugin, call
SequenceAnnotationGenerator.generate(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[], com.biomatters.geneious.publicapi.plugin.SequenceAnnotationGenerator.SelectionRange, jebl.util.ProgressListener, Options) instead. |
List<List<SequenceAnnotation>> |
SequenceAnnotationGenerator.generateAnnotations(SequenceAnnotationGenerator.SelectionRange selectionRange,
ProgressListener progressListener,
Options options,
AnnotatedPluginDocument... documents)
|
List<List<SequenceAnnotation>> |
SequenceAnnotationGenerator.generateAnnotations(SequenceAnnotationGenerator.SelectionRange selectionRange,
ProgressListener progressListener,
Options options,
List<AnnotatedPluginDocument> documents)
|
Options |
SequenceAnnotationGenerator.getOptions(AnnotatedPluginDocument[] documents,
SequenceAnnotationGenerator.SelectionRange selectionRange)
Provides some options applicable to this annotation generator to the user.
|
Options |
SequenceAnnotationGenerator.getOptions(AnnotatedPluginDocument[] documents,
SequenceAnnotationGenerator.SelectionRange selectionRange,
boolean compactOptions)
Similar to
SequenceAnnotationGenerator.getOptions(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[], com.biomatters.geneious.publicapi.plugin.SequenceAnnotationGenerator.SelectionRange)
except that if compactOptions==true then options returned may be more visually compact for rendering in a smaller region, such as in the sequence viewer controls in the case
where SequenceAnnotationGenerator.getNameInSequenceViewer() is not null. |
Options |
SequenceAnnotationGenerator.getOptions(SequenceAnnotationGenerator.SelectionRange selectionRange,
AnnotatedPluginDocument... documents)
A convenience method for calling
SequenceAnnotationGenerator.getOptions(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[], com.biomatters.geneious.publicapi.plugin.SequenceAnnotationGenerator.SelectionRange)
This method may be invoked from either the swing thread or a non-swing thread. |
Options |
SequenceAnnotationGenerator.getOptions(SequenceAnnotationGenerator.SelectionRange selectionRange,
List<AnnotatedPluginDocument> documents)
A convenience method for calling
SequenceAnnotationGenerator.getOptions(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[], com.biomatters.geneious.publicapi.plugin.SequenceAnnotationGenerator.SelectionRange)
This method may be invoked from either the swing thread or a non-swing thread. |
| Constructor and Description |
|---|
SequenceAnnotationGenerator.SelectionRange(int firstSelectedSequence,
int lastSelectedSequence,
int firstSelectedResidue,
int lastSelectedResidue,
SequenceAnnotationGenerator.SelectionRange next) |