| 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.plugin |
Provides the
GeneiousPlugin interface and plugin
related interfaces. |
| Modifier and Type | Method and Description |
|---|---|
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 AnnotatedPluginDocument |
WritableDatabaseService._getFolderViewDocument()
The implementation method for
WritableDatabaseService.getFolderViewDocument(). |
protected abstract WritableDatabaseService |
WritableDatabaseService._getHiddenFolder(String folderName,
boolean isPerUserFolder)
The implementation method for
WritableDatabaseService.getHiddenFolder(String, boolean) |
protected WritableDatabaseService |
WritableDatabaseService.DummyService._getHiddenFolder(String folderName,
boolean isPerUserFolder) |
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. |
protected abstract void |
WritableDatabaseService._retrieve(Query query,
RetrieveCallback callback,
URN[] urnsToNotRetrieve)
Implementaion method for
WritableDatabaseService.retrieve(com.biomatters.geneious.publicapi.databaseservice.Query, com.biomatters.geneious.publicapi.databaseservice.RetrieveCallback, com.biomatters.geneious.publicapi.documents.URN[])
that subclasses should implement. |
protected void |
WritableDatabaseService.DummyService._retrieve(Query query,
RetrieveCallback callback,
URN[] urnsToNotRetrieve) |
protected abstract void |
WritableDatabaseService._retrieve(URN[] urnsToRetrieve,
RetrieveCallback callback)
Implementaion method for
WritableDatabaseService.retrieve(com.biomatters.geneious.publicapi.documents.URN[], com.biomatters.geneious.publicapi.databaseservice.RetrieveCallback)
that subclasses should implement. |
protected void |
WritableDatabaseService.DummyService._retrieve(URN[] urnsToRetrieve,
RetrieveCallback callback) |
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.
|
void |
SequenceDatabaseSuperService.addDatabase(File file,
String name,
Options options,
ProgressListener progressListener,
DatabaseService.SequenceSearchQueryType expectedDatabaseType)
Add a new sequence database to the service from a file on disk.
|
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.
|
abstract String |
WritableDatabaseService.addHiddenElement(org.jdom.Element newElement,
ProgressListener progress)
Adds a new hidden element to this database and generates a new unique name
which is returned.
|
String |
WritableDatabaseService.DummyService.addHiddenElement(org.jdom.Element newElement,
ProgressListener progress) |
abstract void |
WritableDatabaseService.addHiddenElement(String name,
org.jdom.Element newElement,
ProgressListener progress)
adds a new hidden element to this database using the given name.
|
void |
WritableDatabaseService.DummyService.addHiddenElement(String name,
org.jdom.Element newElement,
ProgressListener progress) |
void |
SequenceDatabaseSuperService.applySetupOptions(Options setupOptions,
ProgressListener progressListener)
Apply and save the specified setup options to the service.
|
void |
DatabaseService.batchSequenceSearch(List<AnnotatedPluginDocument> querySequences,
String program,
Options options,
RetrieveCallback callback)
If this is a Sequence Database (ie.
|
abstract boolean |
WritableDatabaseService.containsDocumentAnywhereWithinDatabase(URN documentURN)
Determine if this database (including any other folders and any user invisible
folders) contains a document with this URN
This method should return the same information no matter where in the
DatabaseService tree it is called.
|
boolean |
WritableDatabaseService.DummyService.containsDocumentAnywhereWithinDatabase(URN documentURN) |
abstract WritableDatabaseService |
WritableDatabaseService.createChildFolder(String name)
Creates a child DatabaseService.
|
WritableDatabaseService |
WritableDatabaseService.DummyService.createChildFolder(String name) |
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 |
PartiallyWritableDatabaseService.deleteDocuments(List<AnnotatedPluginDocument> documents)
Deletes documents in this database.
|
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). |
List<String> |
WritableDatabaseService.getAdditionalPerDocumentXmlKeys(boolean isPerUser,
ProgressListener progressListener)
Get a list of all keys that additional XML has been stored under on any document.
|
AnnotatedPluginDocument |
WritableDatabaseService.getDocument(URN urn)
Get a document that exists anywhere within this database (including other folders) with a particular URN.
|
abstract WritableDatabaseService |
WritableDatabaseService.getDocumentLocation(URN documentURN)
If this database contains this document in any user visible folder returns
the WritableDatabaseService representing the folder that contains it.
|
WritableDatabaseService |
WritableDatabaseService.DummyService.getDocumentLocation(URN documentURN) |
AnnotatedPluginDocument |
WritableDatabaseService.getFolderViewDocument()
If this folder represents the results of a search, it must provide a
FolderViewDocument which stores all properties of that search.
|
abstract org.jdom.Element |
WritableDatabaseService.getHiddenElement(String elementName,
ProgressListener progress)
get(load) a special hidden element
|
org.jdom.Element |
WritableDatabaseService.DummyService.getHiddenElement(String elementName,
ProgressListener progress) |
abstract String[] |
WritableDatabaseService.getHiddenElementNames()
lists the hidden elements stored in this database.
|
String[] |
WritableDatabaseService.DummyService.getHiddenElementNames() |
WritableDatabaseService |
WritableDatabaseService.getHiddenFolder(String folderName,
boolean isPerUserFolder)
Gets an existing or creates a new hidden folder as an immediate child of the
root service of this database.
|
abstract String[] |
WritableDatabaseService.getHiddenFolderNames()
Get a list of hidden folders that can be used as parameters to the getHiddenFolder() method.
|
String[] |
WritableDatabaseService.DummyService.getHiddenFolderNames() |
boolean |
WritableDatabaseService.moveDocument(AnnotatedPluginDocument document,
ProgressListener progress)
Move a document that currently reside elsewhere in this database to this folder.
|
abstract void |
WritableDatabaseService.moveTo(WritableDatabaseService destination)
Move this entire database folder to a new location.
|
void |
WritableDatabaseService.DummyService.moveTo(WritableDatabaseService destination) |
abstract void |
WritableDatabaseService.removeChildFolder(String folderName)
Removes a child folder with this folder name.
|
void |
WritableDatabaseService.DummyService.removeChildFolder(String folderName) |
void |
WritableDatabaseService.removeChildFolder(String folderName,
ProgressListener progressListener)
Removes a child folder with this folder name.
|
void |
SequenceDatabaseSuperService.removeDatabase(String uniqueId)
Remove the database with the given uniqueID (returned from
GeneiousService.getUniqueID()). |
void |
SequenceDatabaseSuperService.removeDatabase(String uniqueId,
ProgressListener progressListener)
Remove the database with the given uniqueID (returned from
GeneiousService.getUniqueID()). |
void |
WritableDatabaseService.removeDocument(AnnotatedPluginDocument document,
ProgressListener progress)
Remove a document from this database.
|
abstract void |
WritableDatabaseService.removeHiddenElement(String name)
removes a hidden element.
|
void |
WritableDatabaseService.DummyService.removeHiddenElement(String name) |
abstract void |
WritableDatabaseService.renameFolder(String newName)
Rename this folder.
|
void |
WritableDatabaseService.DummyService.renameFolder(String newName) |
void |
DatabaseService.resumeSearch(String uniqueIdentifier,
RetrieveCallback callback)
Deprecated.
Geneious no longer supports resuming searches
|
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) |
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. |
abstract void |
DatabaseService.retrieve(Query query,
RetrieveCallback callback,
URN[] urnsToNotRetrieve)
Get documents by searching a database.
|
void |
WritableDatabaseService.retrieve(Query query,
RetrieveCallback callback,
URN[] urnsToNotRetrieve) |
void |
DatabaseService.retrieve(URN[] urnsToRetrieve,
RetrieveCallback callback)
Retrieve documents with the specified URNs.
|
void |
WritableDatabaseService.retrieve(URN[] urnsToRetrieve,
RetrieveCallback callback) |
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 |
WritableDatabaseService.setFolderViewDocument(AnnotatedPluginDocument folderViewDocument,
ProgressListener progressListener)
Sets the folder view document on this folder.
|
abstract void |
WritableDatabaseService.updateHiddenElement(String name,
org.jdom.Element newElement,
ProgressListener progress)
updates the contents of a hidden element.
|
void |
WritableDatabaseService.DummyService.updateHiddenElement(String name,
org.jdom.Element newElement,
ProgressListener progress) |
| Modifier and Type | Method and Description |
|---|---|
static String |
DocumentUtilities.getUniqueNameForDocument(String baseDocumentName,
WritableDatabaseService mustBeUniqueIn)
Generate a document name that is unique to the given folder, based on the original name passed in.
|
static String |
DocumentUtilities.getUniqueNameForDocument(String baseDocumentName,
WritableDatabaseService mustBeUniqueIn,
Collection<String> mustNotBe)
Generate a document name that is unique to the given folder, based on the original name passed in.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DocumentOperation.OperationCallback.setSubFolder(String name)
Specify the name of a subfolder that the results of the operation should go in.
|
void |
DocumentOperation.OperationCallback.Wrapper.setSubFolder(String name) |