| 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 |
|---|---|
SequenceAlignmentDocument.ReferencedSequence |
SequenceAlignmentDocument.getReferencedSequence(int sequenceIndexInAlignment)
Get an original sequence document that this alignment was made from.
|
| Modifier and Type | Method and Description |
|---|---|
static List<SequenceAlignmentDocument.ReferencedSequence> |
SequenceAlignmentDocument.ReferencedSequence.forSequenceDocuments(AnnotatedPluginDocument... documents)
Creates a list of ReferencedSequence, with 1 entry in the list for each given document (each of which must be a
SequenceDocument) or null. |
List<SequenceAlignmentDocument.ReferencedSequence> |
SequenceAlignmentDocument.getReferencedSequences()
Return the results of
SequenceAlignmentDocument.getReferencedSequence(int) for each sequence in the
alignment. |
| Modifier and Type | Method and Description |
|---|---|
static SequenceDocument |
SequenceAlignmentDocument.ReferencedSequence.getSequenceDocument(SequenceAlignmentDocument.ReferencedSequence referencedSequence,
SequenceDocument.Alphabet alphabet)
Get the sequence document referenced by a ReferencedSequence (if it references a SequenceDocument or SequenceListDocument)
|
boolean |
SequenceAlignmentDocument.setReferencedSequence(int sequenceIndexInAlignment,
SequenceAlignmentDocument.ReferencedSequence referencedSequence)
|
boolean |
SequenceAlignmentDocument.setReferencedSequence(int sequenceIndexInAlignment,
SequenceAlignmentDocument.ReferencedSequence referencedSequence,
int referencedDocumentRevisionNumberSequenceWasCopiedFrom)
Sets the sequence at the given index in this alignment to refer to the given document as if it is the original source.
|
| Modifier and Type | Method and Description |
|---|---|
SequenceAlignmentDocument.ReferencedSequence |
DefaultAlignmentDocument.getReferencedSequence(int sequenceIndexInAlignment) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
DefaultAlignmentDocument.setReferencedSequence(int sequenceIndexInAlignment,
SequenceAlignmentDocument.ReferencedSequence referencedSequence,
int referencedDocumentRevisionNumberSequenceWasCopiedFrom) |
| Constructor and Description |
|---|
DefaultAlignmentDocument(SequenceDocument[] unalignedSequences,
List<SequenceAlignmentDocument.ReferencedSequence> referencedSequences,
CharSequence[] alignedSequenceCharacters,
String alignmentOptions,
Double alignmentScore,
String proposedName,
ProgressListener progressListener)
This is the constructor that should be used in most situations.
|
| Modifier and Type | Method and Description |
|---|---|
SequenceAlignmentDocument.ReferencedSequence |
CombinedAlignmentAndSequenceDocument.getReferencedSequence(int sequenceIndexInAlignment) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
CombinedAlignmentAndSequenceDocument.setReferencedSequence(int sequenceIndexInAlignment,
SequenceAlignmentDocument.ReferencedSequence referencedSequence) |
| Modifier and Type | Method and Description |
|---|---|
SequenceAlignmentDocument.ReferencedSequence |
AssemblerInput.Read.getMateReferencedDocument()
Gets the referenced document (not the same thing as a reference sequence) for the read returned from
AssemblerInput.Read.getMate(). |
SequenceAlignmentDocument.ReferencedSequence |
AssemblerInput.Read.getMateReferencedDocumentNormalized()
Gets the referenced document (not the same thing as a reference sequence) for the read returned from
AssemblerInput.Read.getMateNormalized(). |
SequenceAlignmentDocument.ReferencedSequence |
AssemblerInput.Read.getReadReferencedDocument()
Gets the referenced document (not the same thing as a reference sequence) for the read returned from
AssemblerInput.Read.getRead(). |
SequenceAlignmentDocument.ReferencedSequence |
AssemblerInput.Read.getReadReferencedDocumentNormalized()
Gets the referenced document (not the same thing as a reference sequence) for the read returned from
AssemblerInput.Read.getReadNormalized(). |
SequenceAlignmentDocument.ReferencedSequence |
AssemblerInput.getReferenceSequenceReference(int referenceSequenceIndex)
Gets a reference to the document that the reference sequence came from.
|
| Modifier and Type | Method and Description |
|---|---|
List<SequenceAlignmentDocument.ReferencedSequence> |
SequenceSelectionWithDocuments.getReferenceSequences()
If everything in the documents in this SequenceSelection is selected, return a list of the ReferencedSequences
representing the AnnotatedPluginDocument which each sequence in the selection appears in and its index therein.
|
| Constructor and Description |
|---|
AssemblerInput.Read(NucleotideSequenceDocument read,
NucleotideSequenceDocument mate,
int expectedMateDistanceForRead,
int expectedMateDistanceForMate,
SequenceAlignmentDocument.ReferencedSequence referencedSequence,
SequenceAlignmentDocument.ReferencedSequence mateReferencedSequence)
Constructs a read consisting of a pair of sequences.
|
AssemblerInput.Read(NucleotideSequenceDocument read,
SequenceAlignmentDocument.ReferencedSequence referencedDocument)
Constructs a new read consisting of a single unpaired sequence.
|
| Constructor and Description |
|---|
AssemblerInput(List<NucleotideSequenceDocument> referenceSequences,
List<NucleotideSequenceDocument> sequences,
List<SequenceAlignmentDocument.ReferencedSequence> referencedDocuments)
Constructs some assembly input from sequences that are all in memory.
|
| Modifier and Type | Method and Description |
|---|---|
static Sequence |
SequenceUtilities.asJeblSequence(SequenceAlignmentDocument.ReferencedSequence referencedSequence,
SequenceDocument sequence)
Convert from a Geneious sequence to a jebl sequence.
|