| Package | Description |
|---|---|
| com.biomatters.geneious.publicapi.databaseservice |
Provides the interface and associated classes for
defining a database service which is a service that
appears on the left-hand side of the main Geneious window
and provides the user with access to a database, for example
NCBI or the local database for storing the user's documents.
|
| 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.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 |
|---|---|
SequenceDocument.Alphabet |
DatabaseService.SequenceSearchQueryType.getAlphabet() |
| Modifier and Type | Method and Description |
|---|---|
static SequenceDocument.Alphabet |
SequenceDocument.Alphabet.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static SequenceDocument.Alphabet[] |
SequenceDocument.Alphabet.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
| Modifier and Type | Method and Description |
|---|---|
DefaultSequenceListDocument |
DefaultSequenceListDocument.createNewDocumentByTransformingSequences(SequenceDocument.Alphabet alphabet,
SequenceDocument.Transformer transformer,
ProgressListener progressListener)
|
DefaultSequenceListDocument |
DefaultSequenceListDocument.createNewDocumentByTransformingSequences(SequenceDocument.Alphabet alphabet,
SequenceDocument.Transformer transformer,
ProgressListener progressListener,
boolean allowMultipleThreads)
Creates a new DefaultSequenceListDocument (whose sequences will be a
SequenceListOnDisk) by applying a transformation to each of the sequences in this list. |
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)
|
SequenceDocument |
SequenceAlignmentDocument.ReferencedSequence.getSequenceDocument(SequenceDocument.Alphabet alphabet)
Get the sequence document referenced by this ReferencedSequence (if it references a SequenceDocument or SequenceListDocument)
|
SequenceAnnotation |
SequenceAnnotation.reverse(int sequenceLength,
SequenceDocument.Alphabet alphabet)
Creates a new annotation that is either the reverse or the reverse complements this annotation.
|
| Constructor and Description |
|---|
SequenceListOnDisk.Builder(boolean tryCompressingSequences,
SequenceDocument.Alphabet alphabet,
boolean allowGaps)
Create a new builder
|
SequenceListOnDisk.Builder(boolean tryCompressingSequences,
SequenceDocument.Alphabet alphabet,
boolean allowGaps,
ProgressListener progressListenerForSortingAlignment,
int maximumNumberOfSequencesThatWillBeAdded)
Create a new builder
|
SequenceListOnDisk.Builder(boolean tryCompressingSequences,
SequenceDocument.Alphabet alphabet,
boolean allowGaps,
ProgressListener progressListenerForSortingAlignment,
int maximumNumberOfSequencesThatWillBeAdded,
boolean createMultipleThreads)
Create a new builder
|
SequenceListSummary(SequenceDocument.Alphabet alphabet,
int numberOfSequencesIfGapsAllowed)
Constructs a new summary.
|
SequenceListSummary(SequenceDocument.Alphabet alphabet,
int numberOfSequencesIfGapsAllowed,
int circularAlignmentLength)
Constructs a new summary.
|
SequenceListSummary(SequenceDocument.Alphabet alphabet,
int numberOfSequencesIfGapsAllowed,
int circularAlignmentLength,
boolean createMultipleThreads)
Constructs a new summary.
|
| Modifier and Type | Method and Description |
|---|---|
static SequenceGraphFactory |
DefaultSequenceGraphFactories.createSequenceAlignmentGraphFactory(String name,
String description,
boolean defaultVisibility,
int defaultHeight,
SequenceDocument.Alphabet alphabet,
DefaultSequenceGraphFactories.SequenceAlignmentScorer multipleSequenceScorer,
boolean lineGraph)
Create a SequenceGraphFactory for sequence alignments.
|
static SequenceGraphFactory |
DefaultSequenceGraphFactories.createSequenceAlignmentGraphFactory(String name,
String description,
boolean defaultVisibility,
int defaultHeight,
SequenceDocument.Alphabet alphabet,
DefaultSequenceGraphFactories.SingleSequenceScorer singleSequenceScorer,
boolean lineGraph)
Create a SequenceGraphFactory that is averaged over multiple sequences from a single sequence scorer.
|
static SequenceGraphFactory |
DefaultSequenceGraphFactories.createSingleSequenceGraphFactory(String name,
String description,
boolean defaultVisibility,
int defaultHeight,
SequenceDocument.Alphabet alphabet,
DefaultSequenceGraphFactories.SingleSequenceScorer singleSequenceScorer,
boolean lineGraph)
Create a SequenceGraphFactory for a single sequence where graph points
depend only on the residue at that point.
|
| Modifier and Type | Method and Description |
|---|---|
SequenceDocument.Alphabet |
AlignmentOperation.InputProperties.getAlphabet() |
abstract SequenceDocument.Alphabet |
SequenceGraph.SequencePropertyRetriever.getAlphabet()
Get the alphabet of the sequence(s)
|
| Modifier and Type | Method and Description |
|---|---|
abstract List<CharSequence> |
AlignmentOperation.align(SequenceDocument.Alphabet alphabet,
List<CharSequence> sequences,
Options options,
ProgressListener progressListener)
Align the given sequences
|
abstract SequenceGraph |
SequenceGraphFactory.createResidueBasedGraph(SequenceDocument.Alphabet alphabet,
boolean isAlignment,
boolean isChromatogram,
boolean isContig)
Create a new residue based SequenceGraph for a sequence or alignment.
|
static DocumentOperation |
PluginUtilities.getAlignmentOperation(String uniqueIdPrefix,
SequenceDocument.Alphabet alphabet)
Get a
DocumentOperation representation of an AlignmentOperation. |
Options |
AlignmentOperation.getOptions(SequenceDocument.Alphabet alphabet,
boolean pairwise,
boolean isSingleAlignment)
Get the options appropriate for aligning these sequences
|
abstract String |
AlignmentOperation.getSupportedCharacters(SequenceDocument.Alphabet alphabet)
Get the characters that are supported by this alignment operation.
|
abstract boolean |
AlignmentOperation.supportsAlphabet(SequenceDocument.Alphabet alphabet) |
| Constructor and Description |
|---|
AlignmentOperation.InputProperties(OperationLocationOptions locationOptions,
SequenceDocument.Alphabet alphabet,
boolean pairwise,
boolean isSingleAlignment)
Constructs new InputProperties.
|
| Modifier and Type | Method and Description |
|---|---|
static SequenceDocument.Alphabet |
SequenceUtilities.getAlphabet(SequenceDocument sequence)
Get the Alphabet of a sequence.
|
static SequenceDocument.Alphabet |
SequenceUtilities.getAlphabet(SequenceType sequenceType)
Gets a Geneious alphabet type that is equivalent to a jebl library SequenceType.
|
| Modifier and Type | Method and Description |
|---|---|
static String |
SequenceUtilities.containsInvalidResidues(CharSequence sequenceResidues,
SequenceDocument.Alphabet alphabet,
boolean allowGaps,
boolean fastIncompleteCheck)
Checks if a sequence contain invalid sequence residues.
|
static long |
SequenceUtilities.getNumberOfSequences(AnnotatedPluginDocument document,
SequenceDocument.Alphabet alphabet)
Gets the total number of nucleotide or amino acid sequences contained in the given document which may be an individual sequence, sequence list, or alignment/contig.
|
static long |
SequenceUtilities.getNumberOfSequences(List<AnnotatedPluginDocument> documents,
SequenceDocument.Alphabet alphabet)
Gets the total number of nucleotide or amino acid sequences contained in the given documents which may be individual sequences, sequence lists, or alignments/contigs.
|
static List<? extends SequenceDocument> |
SequenceUtilities.getSequences(AnnotatedPluginDocument[] documents,
SequenceDocument.Alphabet alphabet,
ProgressListener progressListener)
get all the sequences out of a set of AnnotatedPluginDocuments that may wrap SequenceDocuments, SequenceListDocuments or SequenceAlignmentDocuments.
|
static List<? extends SequenceDocument> |
SequenceUtilities.getSequences(List<AnnotatedPluginDocument> documents,
SequenceDocument.Alphabet alphabet,
ProgressListener progressListener)
get all the sequences out of a set of AnnotatedPluginDocuments that may wrap SequenceDocuments, SequenceListDocuments or SequenceAlignmentDocuments.
|
static Collection<? extends SequenceDocument> |
SequenceUtilities.getSequencesWithoutImmediateLoading(AnnotatedPluginDocument[] documents,
SequenceDocument.Alphabet alphabet)
Like
SequenceUtilities.getSequences(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[], com.biomatters.geneious.publicapi.documents.sequence.SequenceDocument.Alphabet, jebl.util.ProgressListener)
but doesn't require each plugin document to be in memory as long as this Collection is around. |
static SequenceType |
SequenceUtilities.getSequenceType(SequenceDocument.Alphabet alphabet)
Gets a jebl library SequenceType that is equivalent to a Geneious alphabet.
|
static void |
ImportUtilities.importDocuments(File file,
DocumentFileImporter.ImportCallback callback,
ImportUtilities.ActionWhenInvalid actionWhenInvalid,
ImportUtilities.ImportDocumentType importDocumentType,
SequenceDocument.Alphabet alphabet,
ProgressListener progressListener)
Imports the given file, using any available importer.
|
static SequenceAlignmentDocument |
ImportUtilities.importFastaAlignment(File fastaFile,
SequenceDocument.Alphabet alphabet,
ProgressListener progressListener)
Imports the given fasta file as a list of aligned sequences, padding the sequences with trailing gaps if necessary.
|
static List<SequenceDocument> |
ImportUtilities.importFastaSequences(File fastaFile,
SequenceDocument.Alphabet alphabet,
ProgressListener progressListener)
Imports the given fasta file as a list of unaligned sequences.
|