| 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 | Class and Description |
|---|---|
static class |
WritableDatabaseService.DummyService
A dummy implementation of WritableDatabaseService that provides no functionality apart from a name and icons
|
| Modifier and Type | Method and Description |
|---|---|
protected abstract WritableDatabaseService |
WritableDatabaseService._getHiddenFolder(String folderName,
boolean isPerUserFolder)
The implementation method for
getHiddenFolder(String, boolean) |
protected WritableDatabaseService |
WritableDatabaseService.DummyService._getHiddenFolder(String folderName,
boolean isPerUserFolder) |
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.
|
WritableDatabaseService |
WritableDatabaseService.getChildService(String name)
Gets a child service whose
getFolderName() == name. |
WritableDatabaseService |
WritableDatabaseService.getDatabaseRoot()
Get the root folder of this database folder hierarchy.
|
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) |
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.
|
WritableDatabaseService |
WritableDatabaseService.getPrimaryDatabaseRoot()
Returns the database root (see
getDatabaseRoot()) for the primary database in this collection. |
| Modifier and Type | Method and Description |
|---|---|
abstract boolean |
WritableDatabaseService.canMoveTo(WritableDatabaseService destination)
Can this entire database folder be moved to this new location?
The default implementation always returns false.
|
boolean |
WritableDatabaseService.DummyService.canMoveTo(WritableDatabaseService destination) |
abstract void |
WritableDatabaseService.moveTo(WritableDatabaseService destination)
Move this entire database folder to a new location.
|
void |
WritableDatabaseService.DummyService.moveTo(WritableDatabaseService destination) |
| Modifier and Type | Method and Description |
|---|---|
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,
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 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 |
|---|---|
WritableDatabaseService |
DocumentSelectionOption.FolderOrDocuments.getFolder()
Get the selected folder or null if a folder was not selected (documents are selected).
|
static WritableDatabaseService |
ServiceUtilities.getResultsDestination()
Get the service to which results of the current operation will be saved.
|
WritableDatabaseService |
DocumentOperationInput.getResultsLocation() |
WritableDatabaseService |
WritableDatabaseServiceTree.getSelectedService()
returns the currently selected service.
|
static WritableDatabaseService |
ServiceUtilities.getUserSelectedFolder(Component anyComponentInParentFrame)
Opens a dialog in which the user can choose one of their local database folders.
|
| Modifier and Type | Method and Description |
|---|---|
Options.Option<WritableDatabaseService,JComponent> |
Options.addServiceOption(String name,
String label,
WritableDatabaseService defaultValue)
Add an option that allows the user to select a WtiableDatabaseService which appears under one of the services returned from
PluginUtilities.getWritableDatabaseServiceRoots(). |
static List<WritableDatabaseService> |
PluginUtilities.getWritableDatabaseServiceRoots()
Returns the root services of all installed WritableDatabaseServices.
|
| Modifier and Type | Method and Description |
|---|---|
Options.Option<WritableDatabaseService,JComponent> |
Options.addServiceOption(String name,
String label,
WritableDatabaseService defaultValue)
Add an option that allows the user to select a WtiableDatabaseService which appears under one of the services returned from
PluginUtilities.getWritableDatabaseServiceRoots(). |
static List<AnnotatedPluginDocument> |
PluginUtilities.importDocumentsToDatabase(File file,
WritableDatabaseService destination,
ProgressListener progress)
Imports documents from a file into a database.
|
void |
PluginUtilities.WritableDatabaseServicesListener.serviceAdded(WritableDatabaseService service)
Called by Geneious when a new service has been added.
|
void |
PluginUtilities.WritableDatabaseServicesListener.serviceRemoved(WritableDatabaseService service)
Called by Geneious when a service has been removed.
|
DocumentOperationInput |
DocumentOperationInput.setResultsLocation(WritableDatabaseService resultsLocation)
Sets the results location to be used for this operation.
|
void |
WritableDatabaseServiceTree.setSelectedService(WritableDatabaseService service)
Sets the currently selected service.
|
| Constructor and Description |
|---|
DocumentSelectionOption.FolderOrDocuments(WritableDatabaseService folder)
Create a FolderOrDocuments for a folder selection
|
| Constructor and Description |
|---|
WritableDatabaseServiceTree(List<WritableDatabaseService> roots,
boolean showNumberOfDocumentsInFolder,
Map<WritableDatabaseService,Integer> documentCountsByService)
Create a new GUI component that lets the user choose a WritableDatabaseService from the root services supplied
|
WritableDatabaseServiceTree(List<WritableDatabaseService> roots,
boolean showNumberOfDocumentsInFolder,
Map<WritableDatabaseService,Integer> documentCountsByService)
Create a new GUI component that lets the user choose a WritableDatabaseService from the root services supplied
|