| Package | Description |
|---|---|
| com.biomatters.geneious.publicapi.documents |
Provides interfaces and classes for defining documents in Geneious and related
interfaces and classes for dealing with XMLSerialization.
|
| 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 |
|---|---|
static AnnotatedPluginDocument |
DocumentUtilities.duplicateDocumentThrowingDocumentOperationExceptionOnFailure(AnnotatedPluginDocument document,
boolean duplicateReferencedDocuments)
Create a duplicate of document.
|
abstract PluginDocument |
AnnotatedPluginDocument.getDocument()
Returns the underlying document which is wrapped inside this AnnotatedPluginDocument.
|
void |
OperationRecordDocument.linkDocumentsInDatabase(ProgressListener progressListener)
Links the documents in this record together.
|
void |
OperationRecordDocument.rerunOperation(ProgressListener progressListener)
Reruns an operation, replacing all output documents of the operation with their corresponding new document
|
| Modifier and Type | Method and Description |
|---|---|
void |
SequenceListOnDisk.Builder.addAlignmentReferenceSequence(SequenceDocument referenceSequence,
ProgressListener progressListener)
Adds a reference sequence when building an alignment.
|
void |
DefaultSequenceListDocument.addAminoAcidSequence(AnnotatedPluginDocument document)
Adds an amino acid sequence to this list that is wrapped inside an
AnnotatedPluginDocument. |
void |
DefaultSequenceListDocument.addNucleotideSequence(AnnotatedPluginDocument document)
Adds a nucleotide sequence to this list that is wrapped inside an
AnnotatedPluginDocument. |
void |
SequenceListOnDisk.Builder.addSequence(SequenceDocument sequence,
ProgressListener progressListener)
Adds a new unpaired sequence.
|
void |
SequenceListOnDisk.Builder.addSequenceWithMate(SequenceDocument sequence,
SequenceDocument mateSequence,
int expectedDistance1,
int expectedDistance2,
ProgressListener progressListener)
Similar to
addSequence but this version adds 2 sequences which are paired |
Alignment |
SequenceAlignmentDocument.asJeblAlignmentIfMemoryAllows(boolean silentlyStripDuplicates)
This method calls #asJeblAlignment(boolean) and re-throws any OutOfMemoryError as a DocumentOperationException
|
abstract void |
SequenceListOnDisk.cacheSequencesInMemory(ProgressListener progressListener)
Loads all sequences in this list into memory so that they can be quickly retrieved later using
AbstractList.get(int) |
static <T extends SequenceDocument> |
SequenceListOnDisk.create(List<T> sequences,
boolean tryCompressingSequences,
ProgressListener progressListener)
Creates a new SequenceListOnDisk from an existing list of ungapped sequences.
|
static <T extends SequenceDocument> |
SequenceListOnDisk.createInterlaced(SequenceListOnDisk<T> sequences1,
SequenceListOnDisk<T> sequences2,
ProgressListener progressListener)
Creates a new SequenceListOnDisk by interlacing a pair of existing SequenceListOnDisks.
|
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)
|
DefaultAlignmentDocument |
SequenceListOnDisk.Builder.toAlignmentDocument(ProgressListener progressListener)
Creates an Alignment document from this builder.
|
SequenceListOnDisk<T> |
SequenceListOnDisk.Builder.toSequenceList(ProgressListener progressListener)
Creates a SequenceListOnDisk from this builder.
|
DefaultSequenceListDocument |
SequenceListOnDisk.Builder.toSequenceListDocument(ProgressListener progressListener)
Creates a new SequenceListDocument from this builder.
|
abstract SequenceDocument |
SequenceDocument.Transformer.transformSequence(SequenceDocument sequence)
Transforms a sequence
|
| 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
|
| Modifier and Type | Method and Description |
|---|---|
void |
PairedReadManager.Builder.addSequenceWithMate(int mateIndex,
int expectedDistance)
Records the mateIndex and expected distance to the mate for the current sequence in the alignment or list.
|
void |
PairedReadManager.Builder.addSequenceWithoutMate()
Adds a new sequence which doesn't have a mate in this data set.
|
static DefaultSequenceDocument |
SequenceExtractionUtilities.extractIntervalsOrThrow(SequenceDocument sourceDocument,
SequenceExtractionUtilities.ExtractionOptions extractionOptions)
Extracts one or more intervals from a sequence as a new sequence document.
|
static SequenceDocument |
SequenceExtractionUtilities.extractOrThrow(SequenceDocument sourceDocument,
SequenceExtractionUtilities.ExtractionOptions extractionOptions)
Extracts one or more intervals from a sequence as a new sequence document.
|
PairedReadManager |
PairedReadManager.Builder.toPairedReadManager()
Creates a new PairedReadManager from this builder.
|
| Constructor and Description |
|---|
PairedReadManager.Builder()
Creates a new
PairedReadManager.Builder |
| Modifier and Type | Class and Description |
|---|---|
static class |
DocumentOperationException.Canceled
Represents a
DocumentOperation
or SequenceAnnotationGenerator
that has failed because it has been canceled. |
static class |
SequenceSelectionWithDocuments.DocumentsInvalidException
Thrown to indicate that a group of documents is not valid to have a SequenceSelectionWithDocuments upon.
|
| Modifier and Type | Method and Description |
|---|---|
DocumentOperationException |
RuntimeDocumentOperationException.getCause() |
| Modifier and Type | Method and Description |
|---|---|
abstract void |
Assembler.Callback.addContigDocument(SequenceAlignmentDocument contig,
NucleotideSequenceDocument contigConsensus,
boolean isThisTheOnlyContigGeneratedByDeNovoAssembly,
ProgressListener progressListener)
Adds a contig generated by this assembler.
|
AnnotatedPluginDocument |
DocumentOperation.OperationCallback.addDocument(AnnotatedPluginDocument doc,
boolean dontSelectDocumentWhenComplete,
ProgressListener progress)
returns a document from the operation while the operation is still in progress.
|
AnnotatedPluginDocument |
DocumentOperation.OperationCallback.Wrapper.addDocument(AnnotatedPluginDocument doc,
boolean dontSelectDocumentWhenComplete,
ProgressListener progress) |
void |
Assembler.Callback.addDocument(AnnotatedPluginDocument document,
ProgressListener progressListener)
Adds a document generated by this assembler.
|
AnnotatedPluginDocument |
DocumentOperation.OperationCallback.addDocument(PluginDocument doc,
boolean dontSelectDocumentWhenComplete,
ProgressListener progress)
returns a document from the operaiton while the operation is still in progress.
|
abstract void |
Assembler.Callback.addUnusedRead(AssemblerInput.Read read,
ProgressListener progressListener)
Adds a read that was not assembled.
|
void |
Assembler.Callback.addUnusedReads(SequenceListDocument unusedReads,
ProgressListener progressListener)
Adds a list of reads that were not assembled.
|
void |
Assembler.Callback.addUsedRead(AssemblerInput.Read read,
ProgressListener progressListener)
Adds a read that was assembled.
|
abstract List<CharSequence> |
AlignmentOperation.align(SequenceDocument.Alphabet alphabet,
List<CharSequence> sequences,
Options options,
ProgressListener progressListener)
Align the given sequences
|
abstract void |
Assembler.assemble(Options options,
AssemblerInput assemblyInput,
ProgressListener progressListener,
Assembler.Callback callback)
Called to actually perform the assembly.
|
static SequenceAlignmentDocument |
PluginUtilities.doAlignment(List<SequenceDocument> sequences,
ProgressListener progressListener)
Prompts the user to perform an alignment using any of the available alignment plugins.
|
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)
|
List<SequenceAnnotationGenerator.AnnotationGeneratorResultOnAlignment> |
SequenceAnnotationGenerator.generateOnAlignments(AnnotatedPluginDocument[] documents,
ProgressListener progressListener,
Options options)
Create annotations (and/or deletes annotations and/or modifies residues and/or modifies field values) on a set of alignments.
|
String |
AlignmentOperation.getAlignmentOptionsDescription(List<CharSequence> alignedSequences,
Options options)
Deprecated.
this functionality is now supplied by operation history
|
Options |
AlignmentOperation.getGeneralOptions()
Gets some Options that work for this operation when invoked on any type and number of input sequences
|
Options |
DocumentOperation.getGeneralOptions()
Gets some Options that work for this document operation when invoked on any set of input sequences.
|
Options |
DocumentOperation.Wrapper.getGeneralOptions() |
Options |
GeneiousGridDocumentOperation.getGeneralOptions() |
Options |
SequenceAnnotationGenerator.getGeneralOptions()
Gets some Options that work for this annotation generator when invoked on any set of input sequences.
|
abstract GeneiousGridDocumentOperation.GridInput |
GeneiousGridDocumentOperation.getGridInput(AnnotatedPluginDocument[] documents,
Options programOptions,
Options fullOptions)
Returns a
GeneiousGridDocumentOperation.GridInput object representing
all the files and command-line inputs needed to run a job on the grid |
AssemblerInput.Read |
AssemblerInput.Reads.getNextReadPair()
Gets the next read or pair of reads.
|
Options |
AlignmentOperation.getOptions(AlignmentOperation.InputProperties inputProperties)
A more powerful alternative to
AlignmentOperation.getOptions(com.biomatters.geneious.publicapi.documents.sequence.SequenceDocument.Alphabet, boolean, boolean)
that may provide the properties of the input to the operation. |
Options |
DocumentOperation.getOptions(AnnotatedPluginDocument... documents)
Provides some options applicable to this document operation to the user.
|
Options |
DocumentOperation.Wrapper.getOptions(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 |
DocumentOperation.getOptions(DocumentOperationInput operationInput)
More powerful alternative to
DocumentOperation.getOptions(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[])
which may provide additional values such as the location the operation is run and the
currently selected region of any sequence in the documents. |
Options |
DocumentOperation.Wrapper.getOptions(DocumentOperationInput operationInput) |
Options |
GeneiousGridDocumentOperation.getOptions(DocumentOperationInput operationInput)
Returns options for running the full grid operation (an almagimation of the options given by
GeneiousGridDocumentOperation.getProgramOptions(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[]),
and some extra options describing where the job will run. |
Options |
DocumentOperation.getOptions(org.jdom.Element optionsElement,
List<AnnotatedPluginDocument> inputDocuments,
List<AnnotatedPluginDocument> additionalParentDocuments)
Recreates some options for rerunning an earlier operation to recreate descendant documents.
|
Options |
DocumentOperation.Wrapper.getOptions(org.jdom.Element optionsElement,
List<AnnotatedPluginDocument> inputDocuments,
List<AnnotatedPluginDocument> additionalParentDocuments) |
Options |
DocumentOperation.getOptions(List<AnnotatedPluginDocument> documents)
A convenience method for calling
DocumentOperation.getOptions(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[])
This method may be invoked from either the swing thread or a non-swing thread. |
abstract Options |
Assembler.getOptions(OperationLocationOptions locationOptions,
AssemblerInput.Properties inputProperties)
Gets some options to display to the user before performing assembly.
|
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. |
Options |
AlignmentOperation.getOptions(SequenceDocument.Alphabet alphabet,
boolean pairwise,
boolean isSingleAlignment)
Get the options appropriate for aligning these sequences
|
Options |
DocumentOperation.getOptions(SequenceSelection sequenceSelection,
AnnotatedPluginDocument... documents)
More powerful alternative to
DocumentOperation.getOptions(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[])
which may provide the currently selected region of any sequence in the documents. |
Options |
DocumentOperation.Wrapper.getOptions(SequenceSelection sequenceSelection,
AnnotatedPluginDocument... documents) |
abstract Options |
GeneiousGridDocumentOperation.getProgramOptions(AnnotatedPluginDocument... documents)
This method returns options for running the program
|
NucleotideSequenceDocument |
AssemblerInput.getReferenceSequence(int referenceSequenceIndex,
ProgressListener progressListener)
Gets one of the reference sequences for this assembly.
|
SequenceAlignmentDocument.ReferencedSequence |
AssemblerInput.getReferenceSequenceReference(int referenceSequenceIndex)
Gets a reference to the document that the reference sequence came from.
|
SequenceDocument |
SequenceSelection.SequenceIndex.getSequence(List<AnnotatedPluginDocument> selectedDocuments)
Gets the selected sequence corresponding to this sequence index for these documents
|
NucleotideSequenceDocument |
AssemblerInput.ReferenceSequence.getSequenceDocument(ProgressListener progressListener)
Gets the SequenceDocument corresponding to this reference sequence, loading it from disk if necessary.
|
List<AnnotatedPluginDocument> |
DocumentOperation.performOperation(AnnotatedPluginDocument[] annotatedDocuments,
ProgressListener progressListener,
Options options)
Create document(s) from a set of documents.
|
List<AnnotatedPluginDocument> |
DocumentOperation.Wrapper.performOperation(AnnotatedPluginDocument[] annotatedDocuments,
ProgressListener progressListener,
Options options) |
List<AnnotatedPluginDocument> |
DocumentOperation.performOperation(AnnotatedPluginDocument[] annotatedDocuments,
ProgressListener progressListener,
Options options,
SequenceSelection sequenceSelection)
|
List<AnnotatedPluginDocument> |
DocumentOperation.Wrapper.performOperation(AnnotatedPluginDocument[] annotatedDocuments,
ProgressListener progressListener,
Options options,
SequenceSelection sequenceSelection) |
void |
DocumentOperation.performOperation(AnnotatedPluginDocument[] annotatedDocuments,
ProgressListener progressListener,
Options options,
SequenceSelection sequenceSelection,
DocumentOperation.OperationCallback callback)
Do not use.
|
void |
DocumentOperation.Wrapper.performOperation(AnnotatedPluginDocument[] annotatedDocuments,
ProgressListener progressListener,
Options options,
SequenceSelection sequenceSelection,
DocumentOperation.OperationCallback callback) |
void |
GeneiousGridDocumentOperation.performOperation(AnnotatedPluginDocument[] documents,
ProgressListener progress,
Options _options,
SequenceSelection sequenceSelection,
DocumentOperation.OperationCallback callback) |
List<AnnotatedPluginDocument> |
DocumentOperation.performOperation(List<AnnotatedPluginDocument> documents,
ProgressListener progressListener,
Options options)
|
List<AnnotatedPluginDocument> |
DocumentOperation.performOperation(ProgressListener progressListener,
Options options,
AnnotatedPluginDocument... documents)
|
List<AnnotatedPluginDocument> |
GeneiousGridDocumentOperation.runLocally(AnnotatedPluginDocument[] documents,
ProgressListener progressListener,
Options programOptions,
Options fullOptions,
String executableLocation)
GeneiousGridDocumentOperations that support local runs must implement either this method or
#runLocally(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[], jebl.util.ProgressListener, Options, Options, String, OperationCallback)
Performs a local run of the program, and returns any documents that are generated. |
void |
GeneiousGridDocumentOperation.runLocally(AnnotatedPluginDocument[] documents,
ProgressListener progressListener,
Options programOptions,
Options fullOptions,
String executableLocation,
DocumentOperation.OperationCallback callback)
GeneiousGridDocumentOperations that support local runs must implement either this method or
GeneiousGridDocumentOperation.runLocally(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[], jebl.util.ProgressListener, Options, Options, String)
Performs a local run of the program, and adds any documents that are generated to an OperationCallback. |
List<AnnotatedPluginDocument> |
GeneiousGridDocumentOperation.runLocally(List<AnnotatedPluginDocument> documents,
ProgressListener progressListener,
Options programOptions,
Options fullOptions,
String executableLocation)
GeneiousGridDocumentOperations that support local runs should implement this method.
|
void |
DocumentOperation.OperationCallback.setOptionsForActivelyLinkedDescendants(org.jdom.Element optionsElement,
List<AnnotatedPluginDocument> inputDocuments,
List<AnnotatedPluginDocument> additionalParentDocuments)
This method will only have an effect if
DocumentOperation.OperationCallback.isInterestedInParentDescendants() returns true. |
void |
DocumentOperation.OperationCallback.Wrapper.setOptionsForActivelyLinkedDescendants(org.jdom.Element optionsElement,
List<AnnotatedPluginDocument> inputDocuments,
List<AnnotatedPluginDocument> additionalParentDocuments) |
void |
DocumentOperation.OperationCallback.stopCreatingOperationRecords()
Stops any
operation records from being created for subsequent documents added using addDocument. |
void |
DocumentOperation.OperationCallback.Wrapper.stopCreatingOperationRecords() |
void |
RuntimeDocumentOperationException.throwCause()
Rethrows the cause of this exception
|
| Constructor and Description |
|---|
RuntimeDocumentOperationException(DocumentOperationException cause) |
| Constructor and Description |
|---|
SequenceSelectionWithDocuments(org.jdom.Element element)
Construct a SequenceSelectionWithDocuments from the results of
SequenceSelectionWithDocuments.toXML() |
SequenceSelectionWithDocuments(List<AnnotatedPluginDocument> documents)
|
SequenceSelectionWithDocuments(List<AnnotatedPluginDocument> documents,
SequenceSelection selection)
|
SequenceSelectionWithDocuments(List<AnnotatedPluginDocument> documents,
SequenceSelection selection,
SequenceSelectionWithDocuments.ExtractionStrategy extractionStrategy)
Constructs an SequenceSelectionWithDocuments for the given documents and given SelectionSelection on those documents.
|
SequenceSelectionWithDocuments(List<AnnotatedPluginDocument> documents,
SequenceSelectionWithDocuments.ExtractionStrategy extractionStrategy)
Constructor which "selects all" from the given documents.
It infers the SequenceType and SequenceSelection.SequenceDocumentType
from the documents.If the documents contain a mixture of nucleotide and amino acid sequences, this will throw an DocumentsInvalidException. |
| Modifier and Type | Method and Description |
|---|---|
void |
MultiThreadedProcessingSystem.add(T entry)
Adds a new entry to be processed.
|
static Sequence |
SequenceUtilities.asJeblSequence(SequenceAlignmentDocument.ReferencedSequence referencedSequence,
SequenceDocument sequence)
Convert from a Geneious sequence to a jebl sequence.
|
protected void |
MultiThreadedProcessingSystem.batchProcess(List<T> values)
Processes multiple values in a single thread.
|
static List<AnnotatedPluginDocument> |
SequenceUtilities.createNewDocumentsByTransformingSequences(List<AnnotatedPluginDocument> sourceDocuments,
SequenceDocument.Transformer transformer,
ProgressListener progressListener,
String newSequenceOrDocumentNamePrefix)
Transforms the sequence(s) in each input document and returns a new document corresponding to each input document.
|
void |
MultiThreadedProcessingSystem.finishedProcessing(T entry)
An implementation may optionally override this to perform any additional cleanup.
|
static SequenceDocument |
SequenceUtilities.generateConsensus(SequenceAlignmentDocument alignment,
ProgressListener progressListener)
Generates a consensus sequence for an alignment using default consensus settings.
|
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. |
abstract void |
MultiThreadedProcessingSystem.process(T t)
Processes a single entry previously added using
MultiThreadedProcessingSystem.add(Object) |
void |
MultiThreadedProcessingSystem.waitForCompletion()
Waits until all items added using
MultiThreadedProcessingSystem.add(Object) have been processed by MultiThreadedProcessingSystem.process(Object) and have returned from MultiThreadedProcessingSystem.finishedProcessing(Object) |