| Package | Description |
|---|---|
| com.biomatters.geneious.publicapi.documents.sequence |
Provides interfaces specifying the types of
sequence and
alignment
documents in Geneious, together with concrete classes used by sequence documents
such as SequenceAnnotation
and SequenceCharSequence. |
| com.biomatters.geneious.publicapi.implementations |
Provides implementations for many of the document interfaces defined
in the package com.biomatters.geneious.publicapi.documents.types
together with some utility classes for dealing with some of these
document types.
|
| com.biomatters.geneious.publicapi.implementations.sequence |
Provides
SequenceDocument
implementations for nucelotide, amino acid, and nucleotide graph (chromatogram) sequences. |
| com.biomatters.geneious.publicapi.plugin |
Provides the
GeneiousPlugin interface and plugin
related interfaces. |
| com.biomatters.geneious.publicapi.utilities |
Provides various utility methods and classes, none of which
are necessary for creating a plugin, but many plugins implentations
will find these methods useful.
|
| Modifier and Type | Method and Description |
|---|---|
SequenceAnnotation |
SequenceAnnotation.copyWithoutIntervals()
Creates a copy of this annotation, without any intervals.
|
static SequenceAnnotation |
SequenceAnnotation.createTrimAnnotation(int minimumIndexInclusive,
int maximumIndexInclusive)
Creates a new
TYPE_TRIMMED annotation |
SequenceAnnotation |
SequenceAnnotation.getAnnotationAdjustedForDeletion(int deletionStart,
int deletionLength,
boolean isDeletionAllGaps,
int newSequenceLengthIfCircular)
Handles a deletion from the sequence which this annotation is for, by either returning a new annotation adjusted to take the deletion into account, or this
annotation if it doesn't change, or null if the annotation should be deleted (for example the user deletes nucleotides from a primer annotation)
|
SequenceAnnotation |
SequenceAnnotation.getAnnotationAdjustedForInsertion(int indexToInsertAt,
int lengthOfInsertion,
boolean isInsertionAllGaps,
int newSequenceLengthIfCircular)
Handles an insertion into the sequence which this annotation is for, by either returning a new annotation adjusted to take the insertion into account, or this
annotation if it doesn't change, or null if the annotation should be deleted (for example the user inserts nucleotides into a primer annotation)
|
SequenceAnnotation |
SequenceAnnotation.getAnnotationAdjustedForReplacement(int replacementPosition,
int replacementLength,
int sequenceLengthIfCircular)
Handles a non-gap replacement in the sequence which this annotation is for, by either returning this
annotation if it doesn't change, or null if the annotation should be deleted (for example the user replaces nucleotides in a primer annotation)
|
static SequenceAnnotation |
SequenceAnnotation.readObject(DataInput in)
Reads data previously created using
writeObject(java.io.DataOutput) |
static SequenceAnnotation |
SequenceAnnotation.readObject(GeneiousObjectInputStream in)
Reads data previously created using
writeObject(GeneiousObjectOutputStream)
It is a good idea to use a GeneiousObjectInputStream when deserializing
lots of annotations. |
SequenceAnnotation |
SequenceAnnotation.reverse(int sequenceLength,
SequenceDocument.Alphabet alphabet)
Creates a new annotation that is either the reverse or the reverse complements this annotation.
|
| Modifier and Type | Method and Description |
|---|---|
static List<SequenceAnnotation> |
SequenceAnnotation.copyOf(List<SequenceAnnotation> sequenceAnnotationsToCopy)
Creates a deep copy of a list of SequenceAnnotations.
|
List<SequenceAnnotation> |
SequenceAlignmentDocument.getAnnotationsOnConsensus()
Gets annotations that are associated with the consensus sequence.
|
List<SequenceAnnotation> |
ImmutableSequenceImplementation.getSequenceAnnotations() |
List<SequenceAnnotation> |
SequenceDocument.getSequenceAnnotations()
Gets sequence annotations which are directly on the sequence.
|
| Modifier and Type | Method and Description |
|---|---|
static String |
SequenceAnnotation.getTranslation(AnnotatedPluginDocument document,
SequenceDocument sequence,
SequenceAnnotation annotation)
Returns the translation (if applicable) for the given annotation.
|
| Modifier and Type | Method and Description |
|---|---|
static List<SequenceAnnotation> |
SequenceAnnotation.copyOf(List<SequenceAnnotation> sequenceAnnotationsToCopy)
Creates a deep copy of a list of SequenceAnnotations.
|
void |
SequenceAlignmentDocument.setAnnotations(int index,
List<SequenceAnnotation> annotations,
boolean allowModifyingReferencedDocuments)
Updates just the annotations on a sequence.
|
void |
SequenceDocumentWithEditableAnnotations.setAnnotations(List<SequenceAnnotation> annotations)
Sets new annotations on this document, replacing the existing ones.
|
void |
SequenceAlignmentDocument.setAnnotationsOnConsensus(List<SequenceAnnotation> annotations)
Sets the annotations on the consensus sequence that will be returned from a later call to
SequenceAlignmentDocument.getAnnotationsOnConsensus(). |
void |
EditableSequenceDocument.setSequenceAndAnnotations(CharSequence sequence,
List<SequenceAnnotation> annotations)
Sets the sequence and annotations of this document.
|
void |
EditableNucleotideGraphSequenceDocument.setSequenceAndAnnotationsAndGraph(CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph)
Replaces
EditableSequenceDocument.setSequenceAndAnnotations(CharSequence,java.util.List)
which you must not call on a NucleotideGraphSequenceDocument. |
void |
SequenceAlignmentDocument.updateSequence(int index,
CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph,
boolean allowModifyingReferencedDocuments)
Set new residues and related data for one sequence.
|
| Constructor and Description |
|---|
SequenceAnnotation(SequenceAnnotation annotation)
creates a copy of the given annotation
|
SequenceAnnotation(SequenceAnnotation annotation,
int offset)
creates a copy of the given annotation offset by a certain amount
|
| Modifier and Type | Method and Description |
|---|---|
List<SequenceAnnotation> |
SequenceGapInformation.adjustAnnotationsForGapInsertion(List<SequenceAnnotation> annotations)
Creates a new list of annotations by adjusting their locations
to compensate for adding gaps into the sequence.
|
static List<SequenceAnnotation> |
SequenceExtractionUtilities.adjustAnnotationsForGapRemoval(CharSequence sequenceWithGaps,
List<SequenceAnnotation> annotations)
Creates a new list of annotations by adjusting their locations
to compensate for removing all the gaps in the sequence.
|
List<SequenceAnnotation> |
SequenceGapInformation.adjustAnnotationsForGapRemoval(List<SequenceAnnotation> annotations)
Creates a new list of annotations by adjusting their locations
to compensate for removing all the gaps in the sequence.
|
static List<SequenceAnnotation> |
SequenceExtractionUtilities.adjustAnnotationsForGaps(CharSequence sequenceWithGaps,
List<SequenceAnnotation> annotations)
Creates a new list of annotations by adjusting their locations
to compensate for adding gaps into the sequence.
|
List<SequenceAnnotation> |
DefaultAlignmentDocument.getAnnotationsOnConsensus() |
| Modifier and Type | Method and Description |
|---|---|
static GeneticCode |
SequenceExtractionUtilities.getGeneticCode(SequenceAnnotation annotation) |
static String |
SequenceExtractionUtilities.translate(SequenceDocument sequence,
SequenceAnnotation annotation)
|
| Modifier and Type | Method and Description |
|---|---|
List<SequenceAnnotation> |
SequenceGapInformation.adjustAnnotationsForGapInsertion(List<SequenceAnnotation> annotations)
Creates a new list of annotations by adjusting their locations
to compensate for adding gaps into the sequence.
|
static List<SequenceAnnotation> |
SequenceExtractionUtilities.adjustAnnotationsForGapRemoval(CharSequence sequenceWithGaps,
List<SequenceAnnotation> annotations)
Creates a new list of annotations by adjusting their locations
to compensate for removing all the gaps in the sequence.
|
List<SequenceAnnotation> |
SequenceGapInformation.adjustAnnotationsForGapRemoval(List<SequenceAnnotation> annotations)
Creates a new list of annotations by adjusting their locations
to compensate for removing all the gaps in the sequence.
|
static List<SequenceAnnotation> |
SequenceExtractionUtilities.adjustAnnotationsForGaps(CharSequence sequenceWithGaps,
List<SequenceAnnotation> annotations)
Creates a new list of annotations by adjusting their locations
to compensate for adding gaps into the sequence.
|
void |
DefaultAlignmentDocument.setAnnotations(int index,
List<SequenceAnnotation> annotations,
boolean allowModifyingReferencedDocuments) |
void |
DefaultAlignmentDocument.setAnnotationsOnConsensus(List<SequenceAnnotation> annotations) |
void |
SequenceExtractionUtilities.ExtractionOptions.setPotentialAnnotationsToExtract(Set<SequenceAnnotation> potentialAnnotationsToExtract)
Tells the extract code which annotations are allowed to end up on the extracted sequence.
|
void |
DefaultAlignmentDocument.updateSequence(int index,
CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph,
boolean allowModifyingOriginals) |
void |
DefaultPhylogenyDocument.updateSequence(int index,
CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph,
boolean allowModifyingOriginals) |
| Modifier and Type | Method and Description |
|---|---|
SequenceAnnotation |
OligoSequenceDocument.getPrimerAnnotation() |
| Modifier and Type | Method and Description |
|---|---|
static List<SequenceAnnotation> |
DefaultSequenceDocument.annotationsFromXML(org.jdom.Element annotationsElement)
Return a List of SequenceAnnotations from a JDOM XML Element.
|
List<SequenceAnnotation> |
CombinedAlignmentAndSequenceDocument.getAnnotationsOnConsensus() |
List<SequenceAnnotation> |
CombinedAlignmentAndSequenceDocument.getSequenceAnnotations() |
List<SequenceAnnotation> |
DefaultSequenceDocument.getSequenceAnnotations() |
List<SequenceAnnotation> |
SequencePropertiesStorage.getSequenceAnnotations() |
List<SequenceAnnotation> |
SequenceTrack.getSequenceAnnotations(ProgressListener progressListener)
Gets the annotations for this track, loading them if necessary.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DefaultSequenceDocument.addSequenceAnnotation(SequenceAnnotation annotation)
Add a sequence annotation to this document.
|
void |
OligoSequenceDocument.addSequenceAnnotation(SequenceAnnotation annotation) |
static SequenceDocument |
OligoSequenceDocument.createExtensionForPrimerAnnotation(SequenceAnnotation primerAnnotation)
Deprecated.
this method no longer works and there is no replacement in the API. Sorry!
|
| Modifier and Type | Method and Description |
|---|---|
static org.jdom.Element |
DefaultSequenceDocument.sequenceAnnotationsToXML(Geneious.MajorVersion version,
String elementName,
List<SequenceAnnotation> annotations)
Return a list of sequence annotations as XML in the specified version of Geneious
|
static org.jdom.Element |
DefaultSequenceDocument.sequenceAnnotationsToXML(String elementName,
List<SequenceAnnotation> annotations)
Return a list of sequence annotations as XML.
|
void |
CombinedAlignmentAndSequenceDocument.setAnnotations(int index,
List<SequenceAnnotation> annotations,
boolean allowModifyingReferencedDocuments) |
void |
CombinedAlignmentAndSequenceDocument.setAnnotations(List<SequenceAnnotation> annotations) |
void |
DefaultSequenceDocument.setAnnotations(List<SequenceAnnotation> annotations) |
void |
OligoSequenceDocument.setAnnotations(List<SequenceAnnotation> annotations) |
void |
SequencePropertiesStorage.setAnnotations(List<SequenceAnnotation> annotations)
|
SequenceTrack |
SequenceTrack.setAnnotations(List<SequenceAnnotation> annotations)
Sets the annotations stored in this track
|
void |
CombinedAlignmentAndSequenceDocument.setAnnotationsOnConsensus(List<SequenceAnnotation> annotations) |
void |
CombinedAlignmentAndSequenceDocument.setSequenceAndAnnotations(CharSequence sequence,
List<SequenceAnnotation> annotations) |
void |
DefaultNucleotideGraphSequence.setSequenceAndAnnotations(CharSequence sequence,
List<SequenceAnnotation> annotations) |
void |
DefaultSequenceDocument.setSequenceAndAnnotations(CharSequence sequence,
List<SequenceAnnotation> annotations) |
void |
OligoSequenceDocument.setSequenceAndAnnotations(CharSequence sequence,
List<SequenceAnnotation> annotations) |
void |
SequencePropertiesStorage.setSequenceAndAnnotations(CharSequence sequence,
List<SequenceAnnotation> annotations)
|
void |
CombinedAlignmentAndNucleotideGraphSequenceDocument.setSequenceAndAnnotationsAndGraph(CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph) |
void |
DefaultNucleotideGraphSequence.setSequenceAndAnnotationsAndGraph(CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph) |
void |
SequencePropertiesStorage.setSequenceAndAnnotationsAndGraph(CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph)
|
void |
CombinedAlignmentAndSequenceDocument.updateSequence(int index,
CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph,
boolean allowModifyingReferencedDocuments) |
| Modifier and Type | Method and Description |
|---|---|
SequenceAnnotation |
SequenceSelection.getAnnotation()
Get the selected annotation if there is one
|
abstract SequenceAnnotation |
SequenceViewerExtension.SequenceAnnotationWrapper.getSequenceAnnotation() |
| Modifier and Type | Method and Description |
|---|---|
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)
|
List<SequenceAnnotation> |
SequenceAnnotationGenerator.AnnotationGeneratorResult.getAnnotationsToAdd()
Get the annotations to be added to this sequence.
|
List<SequenceAnnotation> |
SequenceAnnotationGenerator.AnnotationGeneratorResult.getAnnotationsToRemove()
Get the annotations to be removed from this sequence.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SequenceAnnotationGenerator.AnnotationGeneratorResult.addAnnotationToAdd(SequenceAnnotation annotation)
Adds an annotation to be added to the sequence once this annotation generator finishes.
|
void |
SequenceAnnotationGenerator.AnnotationGeneratorResult.addAnnotationToRemove(SequenceAnnotation annotation)
Adds an annotation to the list of annotations to be removed from the sequence once this annotation generator finishes.
|
boolean |
SequenceAnnotationGenerator.isSimilarAnnotation(SequenceAnnotation annotationGeneratedByThisGenerator,
SequenceAnnotation existingAnnotationOfSameType)
Determines whether an annotation generated by this generator is similar enough to an existing annotation on a sequence such that the generated annotation should not be displayed to the user.
|
| Constructor and Description |
|---|
SequenceSelection(SequenceDocument sequence,
SequenceAnnotation annotation)
|
SequenceSelection(SequenceSelection.SequenceIndex sequenceIndex,
SequenceAnnotation annotation)
Construct for a selected SequenceAnnotation on the specified sequence.
|
| Constructor and Description |
|---|
SequenceAnnotationGenerator.AnnotationGeneratorResult(List<SequenceAnnotation> annotationsToAdd)
Constructs a new AnnotationGeneratorResult
|
| Modifier and Type | Method and Description |
|---|---|
static List<SequenceAnnotation> |
SequenceUtilities.getAnnotationsOfType(List<SequenceAnnotation> annotations,
String type)
Get all annotations in list matching the given type
|
static List<SequenceAnnotation> |
SequenceUtilities.getAnnotationsOfType(SequenceDocument document,
String type)
|
static List<SequenceAnnotation> |
SequenceUtilities.getAnnotationsOfType(SequenceDocument document,
String type,
boolean returnAnnotationsInTracks)
Get all annotations in document matching the given type.
WARNING: this list may not include all SequenceAnnotations represented as annotations in the sequence viewer.
|
static Iterable<SequenceAnnotation> |
SequenceUtilities.getSequenceAndTrackAnnotations(SequenceDocument sequence)
A convenience method to get all annotations on the sequence and all annotations on all
SequenceTracks on this sequence. |
static List<SequenceAnnotation> |
SequenceUtilities.getSequenceAnnotationsIncludingImmutableSequencesTrims(SequenceDocument sequence)
Gets all the annotations on the given sequence.
|
| Modifier and Type | Method and Description |
|---|---|
static List<SequenceAnnotation> |
SequenceUtilities.getAnnotationsOfType(List<SequenceAnnotation> annotations,
String type)
Get all annotations in list matching the given type
|