| 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 |
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.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 |
|---|---|
List<AnnotatedPluginDocument> |
DatabaseService.retrieve(List<AnnotatedPluginDocument> summaryDocuments,
ProgressListener progressListener)
Convenience method to be used instead of the standard retrieve method
to avoid dealing with a callback method when downloading full documents given summary documents.
|
List<AnnotatedPluginDocument> |
DatabaseService.retrieve(Query query,
ProgressListener progressListener)
Convenience method to be used instead of the standard
DatabaseService.retrieve(Query, RetrieveCallback, com.biomatters.geneious.publicapi.documents.URN[])
method to avoid dealing with a callback method. |
List<AnnotatedPluginDocument> |
DatabaseService.retrieve(String searchText)
Convenience method to be used instead of the standard retrieve method
when doing a standard textbased search and ignoring failure (by returning
an empty list) and ignoring search properties (such as e-values).
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
CompositeRetrieveCallback._add(AnnotatedPluginDocument document,
Map<String,Object> searchResultProperties)
Report back one retrieved document.
|
protected abstract void |
RetrieveCallback._add(AnnotatedPluginDocument document,
Map<String,Object> searchResultProperties)
Report back one retrieved document.
|
protected abstract AnnotatedPluginDocument |
WritableDatabaseService._addDocumentCopy(AnnotatedPluginDocument annotatedDocument,
ProgressListener progress)
Implementaion method for
WritableDatabaseService.addDocumentCopy(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, jebl.util.ProgressListener)
that subclasses should implement. |
protected AnnotatedPluginDocument |
WritableDatabaseService.DummyService._addDocumentCopy(AnnotatedPluginDocument annotatedDocument,
ProgressListener progress) |
protected AnnotatedPluginDocument |
WritableDatabaseService._addDocumentCopyWithProperties(AnnotatedPluginDocument document,
ProgressListener progress,
Map<String,Object> properties)
|
protected AnnotatedPluginDocument |
WritableDatabaseService._addDocumentCopyWithProperties(AnnotatedPluginDocument document,
ProgressListener progress,
Map<String,Object> properties,
URN urnToUseForAddedDocument)
|
protected abstract AnnotatedPluginDocument |
WritableDatabaseService._addReferencedOnlyDocumentCopy(AnnotatedPluginDocument annotatedDocument,
ProgressListener progress)
This method is only called from the helper method
WritableDatabaseService.duplicateDocumentAndDealWithReferencedDocuments(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, com.biomatters.geneious.publicapi.documents.ElementProvider, java.util.concurrent.atomic.AtomicReference, com.biomatters.geneious.publicapi.documents.URN). |
protected AnnotatedPluginDocument |
WritableDatabaseService.DummyService._addReferencedOnlyDocumentCopy(AnnotatedPluginDocument annotatedDocument,
ProgressListener progress) |
protected abstract boolean |
WritableDatabaseService._moveDocument(AnnotatedPluginDocument document,
ProgressListener progress)
Implementation method for
WritableDatabaseService.moveDocument(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, jebl.util.ProgressListener)
that subclasses should implement. |
protected boolean |
WritableDatabaseService.DummyService._moveDocument(AnnotatedPluginDocument document,
ProgressListener progress) |
protected abstract void |
WritableDatabaseService._removeDocument(AnnotatedPluginDocument document,
ProgressListener progress)
Implementation method for
WritableDatabaseService.removeDocument(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, jebl.util.ProgressListener)
that subclasses should implement. |
protected void |
WritableDatabaseService.DummyService._removeDocument(AnnotatedPluginDocument document,
ProgressListener progress) |
protected void |
WritableDatabaseService._retrieve(AnnotatedPluginDocument[] summaryDocuments,
RetrieveCallback callback,
URN[] urnsToNotRetrieve)
Implementaion method for
WritableDatabaseService.retrieve(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[], com.biomatters.geneious.publicapi.databaseservice.RetrieveCallback, com.biomatters.geneious.publicapi.documents.URN[])
that subclasses should implement. |
boolean |
RetrieveCallback.add(AnnotatedPluginDocument document,
Map<String,Object> searchResultProperties)
A wrapper method that forwards its arguments to
RetrieveCallback._add(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, java.util.Map)
only if this retrieval hasn't been canceled. |
void |
SequenceDatabaseSuperService.addDatabase(AnnotatedPluginDocument[] annotatedDocuments,
String name,
Options options,
ProgressListener progressListener)
Add a new sequence database to the service from a selection of documents in Geneious.
|
AnnotatedPluginDocument |
WritableDatabaseService.addDocumentCopy(AnnotatedPluginDocument document,
ProgressListener progress)
Add a copy of this document to this database.
|
AnnotatedPluginDocument |
WritableDatabaseService.addDocumentCopyWithProperties(AnnotatedPluginDocument document,
ProgressListener progress,
Map<String,Object> properties)
|
AnnotatedPluginDocument |
WritableDatabaseService.addDocumentCopyWithProperties(AnnotatedPluginDocument document,
ProgressListener progress,
Map<String,Object> properties,
URN urnToUseForAddedDocument)
Add a copy of this document to this database with additional properties that
will show up as associated with this document on any future queries while the document resides in this folder.
|
void |
WritableDatabaseService.SearchResultPropertiesAdjuster.adjustProperties(AnnotatedPluginDocument document,
Map<String,Object> searchResultProperties)
Adjust the contents of searchResultProperties based on the given document.
|
boolean |
PartiallyWritableDatabaseService.canEditDocumentField(AnnotatedPluginDocument document,
DocumentField field)
Returns true if it is possible to edit the given document field for the given document.
|
WritableDatabaseService |
WritableDatabaseService.createFolderViewFolder(String folderName,
AnnotatedPluginDocument folderViewDocument)
Creates a new child folder that contains a document that may be displayed for representing an entire view of the folder.
|
void |
DatabaseServiceListener.documentCopyAboutToBeAdded(AnnotatedPluginDocument document)
Called when a document is about to be added to a
WritableDatabaseService. |
void |
DatabaseServiceListener.documentMoved(AnnotatedPluginDocument document,
DatabaseService source)
Called when a document is moved using
WritableDatabaseService.moveDocument(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, jebl.util.ProgressListener). |
protected AnnotatedPluginDocument |
WritableDatabaseService.duplicateDocumentAndDealWithReferencedDocuments(AnnotatedPluginDocument document,
ElementProvider pluginDocumentElementProvider,
AtomicReference<org.jdom.Element> returnedPluginDocumentElement)
Deprecated.
use #duplicateDocumentAndDealWithReferencedDocuments
|
protected AnnotatedPluginDocument |
WritableDatabaseService.duplicateDocumentAndDealWithReferencedDocuments(AnnotatedPluginDocument document,
ElementProvider pluginDocumentElementProvider,
AtomicReference<org.jdom.Element> returnedPluginDocumentElement,
URN urnOfNewDocument)
This as a helper method to facilitate implementing
WritableDatabaseService._addDocumentCopy(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument,jebl.util.ProgressListener). |
void |
PartiallyWritableDatabaseService.editDocumentField(AnnotatedPluginDocument document,
DocumentFieldAndValue newValue)
Edits a field value on a document.
|
Map<String,ElementProvider> |
WritableDatabaseService.getAdditionalPerDocumentXml(AnnotatedPluginDocument document,
List<String> keys,
boolean isPerUser,
ProgressListener progressListener)
Get some additional XML associated with a particular document that has been saved using
WritableDatabaseService.saveAdditionalPerDocumentXml(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, String, boolean, org.jdom.Element, jebl.util.ProgressListener)
or WritableDatabaseService.saveAdditionalPerDocumentXml(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, boolean, java.util.Map, jebl.util.ProgressListener)
This method is similar to WritableDatabaseService.getAdditionalPerDocumentXml(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, String, boolean, jebl.util.ProgressListener)
except that this method allows retrieving multiple additional XML entries with a single method invocation, potentially allowing the database to handle
it more efficiently than multiple calls to WritableDatabaseService.getAdditionalPerDocumentXml(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, java.util.List, boolean, jebl.util.ProgressListener) |
org.jdom.Element |
WritableDatabaseService.getAdditionalPerDocumentXml(AnnotatedPluginDocument document,
String key,
boolean isPerUser,
ProgressListener progressListener)
Get some additional XML associated with a particular document that has been saved using
WritableDatabaseService.saveAdditionalPerDocumentXml(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, String, boolean, org.jdom.Element, jebl.util.ProgressListener). |
int |
DatabaseService.locateSummaryDocument(AnnotatedPluginDocument actualDocument,
AnnotatedPluginDocument[] summaryDocuments)
Locate summary document of fully downloaded documents.
|
int |
DatabaseService.locateSummaryDocument(AnnotatedPluginDocument actualDocument,
AnnotatedPluginDocument[] summaryDocuments)
Locate summary document of fully downloaded documents.
|
boolean |
WritableDatabaseService.moveDocument(AnnotatedPluginDocument document,
ProgressListener progress)
Move a document that currently reside elsewhere in this database to this folder.
|
void |
RetrieveCallback.remove(AnnotatedPluginDocument document)
Remove a document previously added using
RetrieveCallback.add(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument,java.util.Map). |
void |
WritableDatabaseService.removeDocument(AnnotatedPluginDocument document,
ProgressListener progress)
Remove a document from this database.
|
void |
DatabaseService.retrieve(AnnotatedPluginDocument[] summaryDocuments,
RetrieveCallback callback,
URN[] urnsToNotRetrieve)
Retrieves full documents corresponding to the given summary documents from the
database.
|
void |
WritableDatabaseService.retrieve(AnnotatedPluginDocument[] documents,
RetrieveCallback callback,
URN[] urnsToNotRetrieve) |
void |
WritableDatabaseService.saveAdditionalPerDocumentXml(AnnotatedPluginDocument document,
boolean isPerUser,
Map<String,ElementProvider> elementProviders,
ProgressListener progressListener)
Save some additional XML associated with a particular document.
|
void |
WritableDatabaseService.saveAdditionalPerDocumentXml(AnnotatedPluginDocument document,
String key,
boolean isPerUser,
org.jdom.Element element,
ProgressListener progressListener)
Save some additional XML associated with a particular document.
|
abstract boolean |
WritableDatabaseService.saveDocument(AnnotatedPluginDocument document,
boolean onlyAnnotatedDocumentHasChanged,
ProgressListener progress)
A document that is already in this database has been modified in memory and should now be saved to permanent storage.
|
boolean |
WritableDatabaseService.DummyService.saveDocument(AnnotatedPluginDocument document,
boolean onlyAnnotatedDocumentHasChanged,
ProgressListener progress) |
void |
DatabaseService.sequenceSearch(AnnotatedPluginDocument querySequence,
String program,
Options options,
RetrieveCallback callback)
If this is a Sequence Database (ie.
|
void |
RetrieveCallback.setFolderViewDocument(AnnotatedPluginDocument folderViewDocument)
Instead of calling
RetrieveCallback.setPropertyFields(java.util.List, com.biomatters.geneious.publicapi.documents.DocumentField)
this method may be called to provide a document that may be used to provide a document style view on the entire
results of the search. |
void |
WritableDatabaseService.setFolderViewDocument(AnnotatedPluginDocument folderViewDocument,
ProgressListener progressListener)
Sets the folder view document on this folder.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DatabaseService.batchSequenceSearch(List<AnnotatedPluginDocument> querySequences,
String program,
Options options,
RetrieveCallback callback)
If this is a Sequence Database (ie.
|
boolean |
PartiallyWritableDatabaseService.canDeleteDocuments(List<AnnotatedPluginDocument> documents)
Return true if it is possible to delete all the documents in the list.
|
void |
PartiallyWritableDatabaseService.deleteDocuments(List<AnnotatedPluginDocument> documents)
Deletes documents in this database.
|
List<AnnotatedPluginDocument> |
DatabaseService.retrieve(List<AnnotatedPluginDocument> summaryDocuments,
ProgressListener progressListener)
Convenience method to be used instead of the standard retrieve method
to avoid dealing with a callback method when downloading full documents given summary documents.
|
| Modifier and Type | Method and Description |
|---|---|
static AnnotatedPluginDocument |
DocumentUtilities.createAnnotatedPluginDocument(org.jdom.Element annotatedDocumentElement,
ElementProvider pluginDocumentElementProvider,
boolean assignNewURN)
Deprecated.
use
DocumentUtilities.createAnnotatedPluginDocument(org.jdom.Element, ElementProvider, boolean) instead, where the final parameter of null is equivalent to assignNewURN==false or URN.generateUniqueLocalURN() for assignNewURN==true |
static AnnotatedPluginDocument |
DocumentUtilities.createAnnotatedPluginDocument(org.jdom.Element annotatedDocumentElement,
ElementProvider pluginDocumentElementProvider,
String assignerForUrn)
Deprecated.
|
static AnnotatedPluginDocument |
DocumentUtilities.createAnnotatedPluginDocument(org.jdom.Element annotatedDocumentElement,
ElementProvider pluginDocumentElementProvider,
URN urnForNewDocument)
Creates an AnnotatedPluginDocument without the internal PluginDocument included.
|
static AnnotatedPluginDocument |
DocumentUtilities.createAnnotatedPluginDocument(PluginDocument document)
|
static AnnotatedPluginDocument |
DocumentUtilities.createAnnotatedPluginDocument(PluginDocument document,
ProgressListener progressListener)
Creates an AnnotatedPluginDocument from a PluginDocument.
|
static AnnotatedPluginDocument |
DocumentUtilities.duplicateDocument(AnnotatedPluginDocument document,
boolean duplicateReferencedDocuments)
Create a duplicate of document.
|
static AnnotatedPluginDocument |
DocumentUtilities.duplicateDocumentThrowingDocumentOperationExceptionOnFailure(AnnotatedPluginDocument document,
boolean duplicateReferencedDocuments)
Create a duplicate of document.
|
static AnnotatedPluginDocument |
DocumentUtilities.getAnnotatedPluginDocumentThatContains(PluginDocument pluginDocument)
Gets the AnnotatedPluginDocument that contains the given PluginDocument.
|
static AnnotatedPluginDocument |
DocumentUtilities.getDocumentByURN(URN urn)
Fetches the specified document from either in memory or from the local or a shared database.
|
abstract AnnotatedPluginDocument |
AnnotatedPluginDocument.toSummaryDocument()
Generates a new AnnotatedPluginDocument that is identical to this
document, except that the internal PluginDocument to a lightweight
AnySummaryDocument.
|
| Modifier and Type | Method and Description |
|---|---|
static List<AnnotatedPluginDocument> |
DocumentUtilities.addAndReturnGeneratedDocuments(List<AnnotatedPluginDocument> documents,
boolean selectDocumentsImmediately,
List<AnnotatedPluginDocument> additionalDocumentsToSelect)
Adds a list of documents that have just been generated to Geneious so that appear in the users local database
and returns the newly added documents.
|
static List<AnnotatedPluginDocument> |
DocumentUtilities.addAndReturnGeneratedDocuments(List<AnnotatedPluginDocument> documents,
boolean selectDocumentsImmediately,
List<AnnotatedPluginDocument> additionalDocumentsToSelect,
WritableDatabaseService destination)
Adds a list of documents that have just been generated to Geneious so that appear in the users local database
and so that they become visible in the document table.
|
static List<AnnotatedPluginDocument> |
DocumentUtilities.createAnnotatedPluginDocuments(List<? extends PluginDocument> documents)
Creates a list of AnnotatedPluginDocuments from a list of PluginDocuments.
|
static List<AnnotatedPluginDocument> |
DocumentUtilities.createAnnotatedPluginDocuments(PluginDocument document)
creates a list of AnnotatedPluginDocuments from a single of PluginDocument.
|
List<AnnotatedPluginDocument> |
DocumentSearchCache.getDocuments() |
List<AnnotatedPluginDocument> |
DocumentCollection.getReferencedDocuments()
Any time, either during initial construction of the DocumentCollection, or
after this DocumentCollection has been reloaded from the local database,
this function can be called to retrieve the list of documents previously
remembered using the
DocumentCollection.addReferencedDocument(AnnotatedPluginDocument) function. |
static List<AnnotatedPluginDocument> |
DocumentUtilities.getSelectedDocuments()
Gets the currently selected documents in the Geneious document table.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
DocumentUtilities.addGeneratedDocument(AnnotatedPluginDocument document,
boolean selectDocumentImmediately)
Adds a newly generated document that will appear in the users local database.
|
void |
DocumentCollection.addReferencedDocument(AnnotatedPluginDocument document)
Adds the given document to a list of documents to be referenced.
|
void |
DocumentListener.documentChanged(AnnotatedPluginDocument document,
boolean repopulateDocumentViewers)
This method is fired by a document whenever it is changed.
|
static AnnotatedPluginDocument |
DocumentUtilities.duplicateDocument(AnnotatedPluginDocument document,
boolean duplicateReferencedDocuments)
Create a duplicate of document.
|
static AnnotatedPluginDocument |
DocumentUtilities.duplicateDocumentThrowingDocumentOperationExceptionOnFailure(AnnotatedPluginDocument document,
boolean duplicateReferencedDocuments)
Create a duplicate of document.
|
| Modifier and Type | Method and Description |
|---|---|
static List<AnnotatedPluginDocument> |
DocumentUtilities.addAndReturnGeneratedDocuments(List<AnnotatedPluginDocument> documents,
boolean selectDocumentsImmediately,
List<AnnotatedPluginDocument> additionalDocumentsToSelect)
Adds a list of documents that have just been generated to Geneious so that appear in the users local database
and returns the newly added documents.
|
static List<AnnotatedPluginDocument> |
DocumentUtilities.addAndReturnGeneratedDocuments(List<AnnotatedPluginDocument> documents,
boolean selectDocumentsImmediately,
List<AnnotatedPluginDocument> additionalDocumentsToSelect)
Adds a list of documents that have just been generated to Geneious so that appear in the users local database
and returns the newly added documents.
|
static List<AnnotatedPluginDocument> |
DocumentUtilities.addAndReturnGeneratedDocuments(List<AnnotatedPluginDocument> documents,
boolean selectDocumentsImmediately,
List<AnnotatedPluginDocument> additionalDocumentsToSelect,
WritableDatabaseService destination)
Adds a list of documents that have just been generated to Geneious so that appear in the users local database
and so that they become visible in the document table.
|
static List<AnnotatedPluginDocument> |
DocumentUtilities.addAndReturnGeneratedDocuments(List<AnnotatedPluginDocument> documents,
boolean selectDocumentsImmediately,
List<AnnotatedPluginDocument> additionalDocumentsToSelect,
WritableDatabaseService destination)
Adds a list of documents that have just been generated to Geneious so that appear in the users local database
and so that they become visible in the document table.
|
static void |
DocumentUtilities.addGeneratedDocuments(List<AnnotatedPluginDocument> documents,
boolean selectDocumentsImmediately)
Adds newly generated documents that will appear in the users local database.
|
static void |
DocumentUtilities.addGeneratedDocuments(List<AnnotatedPluginDocument> documents,
boolean selectDocumentsImmediately,
List<AnnotatedPluginDocument> additionalDocumentsToSelect)
Adds a list of documents that have just been generated to Geneious so that appear in the users local database
and so that they become visible in the document table.
|
static void |
DocumentUtilities.addGeneratedDocuments(List<AnnotatedPluginDocument> documents,
boolean selectDocumentsImmediately,
List<AnnotatedPluginDocument> additionalDocumentsToSelect)
Adds a list of documents that have just been generated to Geneious so that appear in the users local database
and so that they become visible in the document table.
|
static void |
DocumentUtilities.addGeneratedDocuments(List<AnnotatedPluginDocument> documents,
boolean selectDocumentsImmediately,
List<AnnotatedPluginDocument> additionalDocumentsToSelect,
WritableDatabaseService destination)
Adds a list of documents that have just been generated to Geneious so that appear in the users local database
and so that they become visible in the document table.
|
static void |
DocumentUtilities.addGeneratedDocuments(List<AnnotatedPluginDocument> documents,
boolean selectDocumentsImmediately,
List<AnnotatedPluginDocument> additionalDocumentsToSelect,
WritableDatabaseService destination)
Adds a list of documents that have just been generated to Geneious so that appear in the users local database
and so that they become visible in the document table.
|
static void |
DocumentUtilities.openDocumentsInNewWindow(List<AnnotatedPluginDocument> documents)
Opens a new Geneious window and displays these documents in all available
document viewers that match these documents.
|
abstract void |
DocumentHistoryEntry.setReferencedAnnotatedDocuments(String entryFieldName,
List<AnnotatedPluginDocument> documentsToReference)
Have this entry reference some other annotatedPluginDocuments that are relevant to this entry in some way.
|
| Modifier and Type | Method and Description |
|---|---|
AnnotatedPluginDocument |
SequenceAlignmentDocument.ReferencedSequence.getReferencedDocument()
Gets the document a sequence in the alignment was built from.
|
AnnotatedPluginDocument |
SequenceAlignmentDocument.getReferencedDocument(int sequenceIndexInAlignment)
Get an original sequence document that this alignment was made from.
|
| Modifier and Type | Method and Description |
|---|---|
List<AnnotatedPluginDocument> |
DefaultSequenceListDocument.getAnnotatedPluginDocumentsForAminoAcidSequences()
When a SequneceList is created for some existing sequences wrapped in
AnnotatedPluginDocument,
then the original AnnotatedPluginDocuments are stored in the sequence list. |
List<AnnotatedPluginDocument> |
DefaultSequenceListDocument.getAnnotatedPluginDocumentsForNucleotideSequences()
When a SequneceList is created for some existing sequences wrapped in
AnnotatedPluginDocument,
then the original AnnotatedPluginDocuments are stored in the sequence list. |
List<AnnotatedPluginDocument> |
SequenceAlignmentDocument.getReferencedDocuments()
Return the results of
SequenceAlignmentDocument.getReferencedDocument(int) for each sequence in the
alignment. |
| Modifier and Type | Method and Description |
|---|---|
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. |
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. |
static String |
SequenceAnnotation.getTranslation(AnnotatedPluginDocument document,
SequenceDocument sequence,
SequenceAnnotation annotation)
Returns the translation (if applicable) for the given annotation.
|
boolean |
SequenceAlignmentDocument.setReferencedDocument(int sequenceIndexInAlignment,
AnnotatedPluginDocument document)
Sets the sequence at the given sequenceIndexInAlignment in this alignment to refer to the given document as if it is the original source.
|
| Constructor and Description |
|---|
SequenceAlignmentDocument.ReferencedSequence(AnnotatedPluginDocument referencedDocument)
Construct a reference to a document that is a
SequenceDocument. |
SequenceAlignmentDocument.ReferencedSequence(AnnotatedPluginDocument referencedDocument,
int indexInSequenceListDocument) |
| Modifier and Type | Method and Description |
|---|---|
AnnotatedPluginDocument |
DefaultAlignmentDocument.getReferencedDocument(int sequenceIndexInAlignment) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
DefaultAlignmentDocument.setReferencedDocument(int index,
AnnotatedPluginDocument document) |
boolean |
DefaultAlignmentDocument.setReferencedSequenceListDocument(int sequenceIndexInAlignment,
AnnotatedPluginDocument sequenceListDocument,
int sequenceIndexInSequenceListDocument) |
| Constructor and Description |
|---|
DefaultAlignmentDocument(AnnotatedPluginDocument[] referencedDocuments,
CharSequence[] alignedSequenceCharacters,
String alignmentOptions,
Double alignmentScore)
Constructs an alignment with references to original sequence documents.
|
DefaultAlignmentDocument(SequenceDocument[] unalignedSequences,
AnnotatedPluginDocument[] referencedDocuments,
CharSequence[] alignedSequenceCharacters,
String alignmentOptions,
Double alignmentScore,
String proposedName)
This is the constructor that should be used in most situations.
|
DefaultPhylogenyDocument(List<? extends Tree> trees,
List<Sequence> inAlignedSequences,
String name,
String summary,
AnnotatedPluginDocument alignmentDocument,
boolean standardTranslation) |
DefaultPhylogenyDocument(List<? extends Tree> trees,
List<Sequence> inAlignedSequences,
String name,
String summary,
AnnotatedPluginDocument alignmentDocument,
boolean standardTranslation,
boolean allTreesWritable) |
| Modifier and Type | Method and Description |
|---|---|
AnnotatedPluginDocument |
CombinedAlignmentAndSequenceDocument.getReferencedDocument(int sequenceIndexInAlignment) |
| Modifier and Type | Method and Description |
|---|---|
static String |
SequenceTrack.getSuggestedTrackNameSuffixForAlignmentWithReferenceSequence(AnnotatedPluginDocument document,
SequenceAlignmentDocument alignment)
Returns a suggested track name suffix to use for tracks created on an alignment with a reference sequence.
|
boolean |
CombinedAlignmentAndSequenceDocument.setReferencedDocument(int sequenceIndexInAlignment,
AnnotatedPluginDocument document) |
| Modifier and Type | Method and Description |
|---|---|
abstract AnnotatedPluginDocument |
DocumentFileImporter.ImportCallback.addDocument(AnnotatedPluginDocument annotatedDocument)
Report back one imported AnnotatedPluginDocument.
|
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) |
AnnotatedPluginDocument |
DocumentFileImporter.ImportCallback.addDocument(AnnotatedPluginDocument annotatedDocument,
ProgressListener progress)
Report back one imported AnnotatedPluginDocument.
|
AnnotatedPluginDocument |
DocumentFileImporter.ImportCallback.addDocument(AnnotatedPluginDocument annotatedDocument,
ProgressListener progress,
String subFolderPath)
Report back one imported AnnotatedPluginDocument.
|
abstract AnnotatedPluginDocument |
DocumentFileImporter.ImportCallback.addDocument(PluginDocument document)
Report back one imported PluginDocument.
|
AnnotatedPluginDocument |
DocumentOperation.OperationCallback.addDocument(PluginDocument doc,
boolean dontSelectDocumentWhenComplete,
ProgressListener progress)
returns a document from the operaiton while the operation is still in progress.
|
abstract AnnotatedPluginDocument |
SequenceViewerExtension.PropertyRetrieverAndEditor.getAnnotatedPluginDocument(int sequenceIndex)
Get the current AnnotatedPluginDocument of one of the sequences being viewed.
|
AnnotatedPluginDocument |
SequenceSelectionWithDocuments.getContainingDocument(int index) |
AnnotatedPluginDocument[] |
DocumentOperationInput.getInputDocumentsArray() |
AnnotatedPluginDocument |
AssemblerInput.ReferenceSequence.getSourceAnnotatedPluginDocument()
Gets the annotated plugin document that contains this reference sequence.
|
| Modifier and Type | Method and Description |
|---|---|
List<AnnotatedPluginDocument> |
DocumentSelectionOption.getDocuments()
Get the list of selected documents.
|
List<AnnotatedPluginDocument> |
DocumentSelectionOption.FolderOrDocuments.getDocuments()
Get the selected documents or null if documents are not selected (a folder is selected).
|
List<AnnotatedPluginDocument> |
SequenceSelection.SequenceIndex.SelectionWrongForDocumentsException.getDocuments()
Deprecated.
|
List<AnnotatedPluginDocument> |
SequenceSelectionWithDocuments.getDocuments() |
List<AnnotatedPluginDocument> |
DocumentOperationInput.getInputDocumentsList() |
static List<AnnotatedPluginDocument> |
PluginUtilities.importDocuments(File file,
ProgressListener progress)
Imports documents from a file into an in memory list.
|
static List<AnnotatedPluginDocument> |
PluginUtilities.importDocumentsToDatabase(File file,
WritableDatabaseService destination,
ProgressListener progress)
Imports documents from a file into a database.
|
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) |
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. |
List<AnnotatedPluginDocument> |
GeneiousGridDocumentOperation.runLocally(List<AnnotatedPluginDocument> documents,
ProgressListener progressListener,
Options programOptions,
Options fullOptions,
String executableLocation)
GeneiousGridDocumentOperations that support local runs should implement this method.
|
| Modifier and Type | Method and Description |
|---|---|
abstract boolean |
DocumentFilter.accepts(AnnotatedPluginDocument document)
Returns true if this document is accepted by the filter.
|
abstract void |
DocumentAction.actionPerformed(AnnotatedPluginDocument[] documents)
Perform a document action.
|
abstract AnnotatedPluginDocument |
DocumentFileImporter.ImportCallback.addDocument(AnnotatedPluginDocument annotatedDocument)
Report back one imported AnnotatedPluginDocument.
|
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 |
DocumentFileImporter.ImportCallback.addDocument(AnnotatedPluginDocument annotatedDocument,
ProgressListener progress)
Report back one imported AnnotatedPluginDocument.
|
AnnotatedPluginDocument |
DocumentFileImporter.ImportCallback.addDocument(AnnotatedPluginDocument annotatedDocument,
ProgressListener progress,
String subFolderPath)
Report back one imported AnnotatedPluginDocument.
|
SequenceGraph |
SequenceGraphFactory.createDocumentBasedGraph(AnnotatedPluginDocument document)
Deprecated.
This method causes ambiguity about whether the Alignment of Sequence aspect of a
CombinedAlignmentAndSequenceDocument is required so is no longer used on CombinedAlignmentAndSequenceDocuments.
All implementations should instead implement SequenceGraphFactory.createDocumentBasedGraphForAlignment(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument) or SequenceGraphFactory.createDocumentBasedGraphForSequence(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument). |
SequenceGraph |
SequenceGraphFactory.createDocumentBasedGraphForAlignment(AnnotatedPluginDocument document)
Create a new document based Alignment Graph.
|
SequenceGraph |
SequenceGraphFactory.createDocumentBasedGraphForSequence(AnnotatedPluginDocument document)
Create a new document based SequenceGraph.
|
abstract Options.OptionValue |
DocumentSelectionOption.OptionValueCreator.createOptionValueForDocument(AnnotatedPluginDocument document) |
abstract SequenceViewerExtension |
SequenceViewerExtension.Factory.createSequenceViewerExtension(DocumentViewer sequenceViewer,
AnnotatedPluginDocument[] documents,
SequenceViewerExtension.PropertyRetrieverAndEditor propertyRetriever)
Creates an instance of a sequence viewer extension.
|
SequenceViewerExtension |
SequenceViewerExtension.StatisticsFactory.createSequenceViewerExtension(DocumentViewer sequenceViewer,
AnnotatedPluginDocument[] documents,
SequenceViewerExtension.PropertyRetrieverAndEditor propertyRetriever) |
TreeViewerExtension |
TreeViewerExtension.Factory.createTreeViewerExtension(AnnotatedPluginDocument annotatedPluginDocument)
|
TreeViewerExtension |
TreeViewerExtension.Factory.createTreeViewerExtension(DocumentViewer treeViewer,
AnnotatedPluginDocument annotatedPluginDocument)
Optionally create a TreeViewerExtension for a given AnnotatedPluginDocument.
|
abstract DocumentViewer |
DocumentViewerFactory.createViewer(AnnotatedPluginDocument[] annotatedDocuments)
Viewer as a Java component.
|
void |
DocumentFileExporter.export(File file,
AnnotatedPluginDocument[] documents,
ProgressListener progressListener,
Options options)
Do the actual exporting.
|
static void |
PluginUtilities.exportDocuments(File file,
AnnotatedPluginDocument... documentsToExport)
Exports these documents to this file in a format suitable for the given file's extension.
|
static void |
PluginUtilities.exportDocumentsInGeneiousFormat(File outputFile,
boolean useCompression,
AnnotatedPluginDocument... documents)
Exports the given documents in Geneious format (zip compressed), to the given file.
|
static void |
PluginUtilities.exportDocumentsInGeneiousFormat(File outputFile,
ProgressListener progressListener,
AnnotatedPluginDocument... documents)
Exports the given documents in Geneious format (zip compressed), to the given file.
|
static void |
PluginUtilities.exportDocumentsInGeneiousFormat(OutputStream outputStream,
ProgressListener progressListener,
AnnotatedPluginDocument... documents)
Exports the given documents in Geneious format (zip compressed), to the given output stream.
|
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.
|
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<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.
|
static List<DocumentViewerFactory> |
PluginUtilities.getDocumentViewerFactories(AnnotatedPluginDocument... documents)
Get a list of
DocumentViewerFactories provided by all currently installed plugins
or optionally restrict the returned list to those that can view a given set of documents. |
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 |
OperationLocationOptions |
DocumentOperation.getLocationOptions(AnnotatedPluginDocument... documents)
Returns
Options that can be used to set the location where this operation is run. |
static long |
AssemblerInput.getNumberOfNucleotideSequences(AnnotatedPluginDocument document)
Gets the total number of nucleotide sequences contained in the given document which may be an individual sequence, sequence list, or alignment/contig.
|
Options |
DocumentOperation.getOptions(AnnotatedPluginDocument... documents)
Provides some options applicable to this document operation to the user.
|
Options |
DocumentOperation.Wrapper.getOptions(AnnotatedPluginDocument... documents) |
Options |
DocumentFileExporter.getOptions(AnnotatedPluginDocument[] documentsToExport)
Provide some options to display to the user when exporting.
|
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 |
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) |
Options |
DocumentFileExporter.getOptionsForBatchExport(AnnotatedPluginDocument[] documentsToExport)
Provide some options to display to the user when batch exporting.
|
abstract Options |
GeneiousGridDocumentOperation.getProgramOptions(AnnotatedPluginDocument... documents)
This method returns options for running the program
|
static boolean |
DocumentType.isAlignment(AnnotatedPluginDocument annotatedPluginDocument) |
static boolean |
DocumentType.isAlignmentAndNotSequence(AnnotatedPluginDocument document) |
static boolean |
DocumentType.isAminoAcidSequence(AnnotatedPluginDocument annotatedPluginDocument) |
static boolean |
DocumentType.isNucleotideSequence(AnnotatedPluginDocument annotatedPluginDocument) |
static boolean |
DocumentType.isSequence(AnnotatedPluginDocument annotatedPluginDocument) |
static boolean |
DocumentType.isSequenceList(AnnotatedPluginDocument annotatedPluginDocument) |
boolean |
DocumentType.matches(AnnotatedPluginDocument document)
Checks if the given document matches this DocumentType
|
static boolean |
DocumentType.matches(Set<DocumentType> documentTypes,
AnnotatedPluginDocument document)
Returns true if the given document is at least one of the given document types.
|
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(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. |
| Modifier and Type | Method and Description |
|---|---|
DocumentSelectionOption |
Options.addDocumentSelectionOption(String name,
String label,
DocumentSelectionOption.FolderOrDocuments defaultValue,
DocumentType documentType,
List<DocumentField> fieldsToDisplay,
boolean allowMultipleSelections,
List<AnnotatedPluginDocument> additionalDocuments)
Equivalent to
addDocumentSelectionOption(name, label, defaultValue, Collections.singleton(documentType), null, null, fieldsToDisplay, allowMultipleSelections, additionalDocuments (which takes a Set of DocumentTypes instead of a single DocumentType) |
DocumentSelectionOption |
Options.addDocumentSelectionOption(String name,
String label,
DocumentSelectionOption.FolderOrDocuments defaultValue,
Set<DocumentType> documentTypes,
DocumentFilter documentFilter,
String documentTypeDescription,
List<DocumentField> fieldsToDisplay,
boolean allowMultipleSelections,
List<AnnotatedPluginDocument> additionalDocuments)
An option to allow the user to select a number of documents of a particular type from their local database.
|
DocumentSelectionOption |
Options.addPrimerSelectionOption(String name,
String label,
DocumentSelectionOption.FolderOrDocuments defaultValue,
boolean allowMultipleSelections,
List<AnnotatedPluginDocument> additionalDocuments)
A convenience method for adding a document selection option for primers.
|
static DocumentSelectionOption.FolderOrDocuments |
PluginUtilities.displayDocumentSearchDialog(String preferenceKey,
DocumentSearchCache searchCache,
Set<DocumentType> documentTypes,
DocumentFilter documentFilter,
String documentTypeDescription,
List<AnnotatedPluginDocument> extraDocuments,
DocumentSelectionOption.FolderOrDocuments initialSelection,
List<DocumentField> fieldsToDisplay,
boolean allowMultipleSelection,
boolean showUseAllButton,
JComponent owner)
Display a dialog allowing the user to choose document(s) from their local database (or connected shared databases).
|
List<List<SequenceAnnotation>> |
SequenceAnnotationGenerator.generateAnnotations(SequenceAnnotationGenerator.SelectionRange selectionRange,
ProgressListener progressListener,
Options options,
List<AnnotatedPluginDocument> documents)
|
int |
SequenceSelection.SequenceIndex.getContainingDocumentIndex(List<AnnotatedPluginDocument> selectedDocuments)
Given a the List of AnnotatedPluginDocument on which this SequenceIndex was defined, returns the index of the document that this
SequenceIndex refers to, in that list
|
static long |
AssemblerInput.getNumberOfNucleotideSequences(List<AnnotatedPluginDocument> documents)
Gets the total number of nucleotide sequences contained in the given documents which may be individual sequences, sequence lists, or alignments/contigs.
|
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.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.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. |
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. |
SequenceDocument |
SequenceSelection.SequenceIndex.getSequence(List<AnnotatedPluginDocument> selectedDocuments)
Gets the selected sequence corresponding to this sequence index for these documents
|
static SequenceSelection |
SequenceSelection.getTotalSelection(List<AnnotatedPluginDocument> documents,
SequenceType type,
SequenceSelection.SequenceDocumentType sequenceDocumentType)
For a List of AnnotatedPluginDocument, creates a selection that represents a "Select all" on each of the documents.
|
static boolean |
DocumentSelectionSignature.matches(DocumentSelectionSignature[] signatures,
List<? extends AnnotatedPluginDocument> documents) |
boolean |
DocumentSelectionSignature.matches(List<? extends AnnotatedPluginDocument> documents)
Check whether this selection signature matches these documents.
|
List<AnnotatedPluginDocument> |
DocumentOperation.performOperation(List<AnnotatedPluginDocument> documents,
ProgressListener progressListener,
Options options)
|
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.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.Wrapper.setOptionsForActivelyLinkedDescendants(org.jdom.Element optionsElement,
List<AnnotatedPluginDocument> inputDocuments,
List<AnnotatedPluginDocument> additionalParentDocuments) |
| Constructor and Description |
|---|
AssemblerInput.Read(NucleotideSequenceDocument read,
AnnotatedPluginDocument referencedAnnotatedDocument,
int indexInReferencedDocument)
Constructs a new read consisting of a single unpaired sequence.
|
AssemblerInput.Read(NucleotideSequenceDocument read,
NucleotideSequenceDocument mate,
int expectedMateDistanceForRead,
int expectedMateDistanceForMate,
AnnotatedPluginDocument referencedAnnotatedDocument,
int indexOfReadInReferencedAnnotatedDocument,
AnnotatedPluginDocument mateReferencedAnnotatedDocument,
int indexOfMateInReferencedAnnotatedDocument)
Constructs a read consisting of a pair of sequences.
|
AssemblerInput.ReferenceSequence(AnnotatedPluginDocument annotatedPluginDocument,
int indexOfSequenceInDocument)
Constructs a reference sequence.
|
DocumentOperationInput(AnnotatedPluginDocument... inputDocuments)
Constructs new DocumentOperationInput.
|
DocumentSelectionOption.FolderOrDocuments(AnnotatedPluginDocument document)
Create a FolderOrDocuments for a selection of one document
|
| Constructor and Description |
|---|
AssemblerInput(List<AnnotatedPluginDocument> annotatedPluginDocuments,
List<AssemblerInput.ReferenceSequence> referenceSequences,
boolean extractSequencesFromContigs)
Constructs some assembly input from documents that need not be loaded into memory.
|
AssemblerInput(List<AnnotatedPluginDocument> annotatedPluginDocuments,
List<AssemblerInput.ReferenceSequence> referenceSequences,
boolean extractSequencesFromContigs,
double fractionOfDataToUse)
Constructs some assembly input from documents that need not be loaded into memory.
|
DocumentOperationInput(List<AnnotatedPluginDocument> inputDocuments)
Constructs new DocumentOperationInput.
|
DocumentSelectionOption.FolderOrDocuments(List<AnnotatedPluginDocument> documents)
Create a FolderOrDocuments for a selection of documents
|
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 |
|---|---|
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.
|
static List<AnnotatedPluginDocument> |
ImportUtilities.importDocuments(File file,
DocumentFileImporter importer,
ImportUtilities.ActionWhenInvalid actionWhenInvalid,
ProgressListener progressListener)
Imports the given file with a specific importer and default options.
|
| Modifier and Type | Method and Description |
|---|---|
static Sequence |
SequenceUtilities.asJeblSequence(AnnotatedPluginDocument referenceDocument,
SequenceDocument sequence)
|
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 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 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 List<SequenceType> |
SequenceUtilities.getSequenceType(AnnotatedPluginDocument document)
Examines a document and determines what the (jebl) sequence type (or types) of the document is (or are), and returns it (or them).
Always returns a List<SequenceType> of size 0, 1 or 2. |
| Modifier and Type | Method and Description |
|---|---|
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.
|
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(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.
|