| 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.implementations.structure |
Provides
MolecularStructureDocument
implementations for many commonly used 3D structure documents. |
| Modifier and Type | Method and Description |
|---|---|
URN |
WritableDatabaseService.createUrnForDocumentSoonToBeAdded()
Returns a URN which can be specified as used for document later added to this database using
WritableDatabaseService.addDocumentCopyWithProperties(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, jebl.util.ProgressListener, java.util.Map, com.biomatters.geneious.publicapi.documents.URN). |
| Modifier and Type | Method and Description |
|---|---|
List<URN> |
FolderView.getDocumentUrns()
Get the URNs of all documents for which properties are stored in this folder view.
|
| Modifier and Type | Method and Description |
|---|---|
protected AnnotatedPluginDocument |
WritableDatabaseService._addDocumentCopyWithProperties(AnnotatedPluginDocument document,
ProgressListener progress,
Map<String,Object> properties,
URN urnToUseForAddedDocument)
|
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) |
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 |
FolderView.addDocumentProperties(URN documentUrn,
Map<String,Object> searchResultProperties)
Add a set of properties associated with a document.
|
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) |
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). |
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) |
Map<String,Object> |
FolderView.getPropertiesForDocument(URN documentUrn)
Get the stored properties for a document
|
void |
FolderView.removeDocumentProperties(URN documentUrn)
Removes any properties associated with this document.
|
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) |
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) |
| Modifier and Type | Method and Description |
|---|---|
void |
FolderView.addDocumentProperties(Map<URN,Map<String,Object>> searchResultProperties)
Update search properties for several documents at once.
|
| Modifier and Type | Method and Description |
|---|---|
static URN |
URN.fromXML(org.jdom.Element urnElement)
Convert back to URN from element generated by
toXML(String). |
static URN |
URN.generateUniqueLocalURN()
Generates a local unique URN with an
assigner of ".". |
static URN |
URN.generateUniqueLocalURN(String assigner)
Generates a unique URN
|
abstract URN |
AnnotatedPluginDocument.getParentOperationRecord() |
abstract URN |
UrnWithRevisionNumber.getUrn() |
URN |
AbstractPluginDocument.getURN() |
abstract URN |
AnnotatedPluginDocument.getURN()
A unique URN which serves as a primary database key for this document.
|
URN |
OperationRecordDocument.getURN() |
URN |
PluginDocument.getURN()
A Universal Resource Name.
|
| Modifier and Type | Method and Description |
|---|---|
List<URN> |
OperationRecordDocument.getActiveOutputDocuments() |
List<URN> |
OperationRecordDocument.getAdditionalParentDocuments() |
abstract List<URN> |
AnnotatedPluginDocument.getDescendantOperationRecords() |
List<URN> |
OperationRecordDocument.getInputDocuments() |
List<URN> |
OperationRecordDocument.getOutputDocuments() |
List<URN> |
OperationRecordDocument.getParentDocuments() |
abstract Set<URN> |
AnnotatedPluginDocument.getReferencedDocuments()
Get a set of document URNs referred to by this document.
|
List<URN> |
AbstractPluginDocument.getReferencedDocumentUrns()
This function can be called to retrieve the list of documents previously
remembered using the
AbstractPluginDocument.addReferencedDocumentUrn(URN) function. |
abstract Set<URN> |
AnnotatedPluginDocument.getStronglyReferencedDocuments()
Get a set of document URNs strongly referred to by this document.
|
abstract Set<URN> |
AnnotatedPluginDocument.getWeaklyReferencedDocuments()
Get a set of document URNs weakly referred to by this document.
|
| Modifier and Type | Method and Description |
|---|---|
abstract void |
AnnotatedPluginDocument.addDescendantOperationRecord(URN operationRecordUrn)
Adds a record of an operation where this document was an input document to the operation.
|
void |
OperationRecordDocument.addOutputDocument(URN outputDocument)
adds an output document that this operation produced.
|
void |
AbstractPluginDocument.addReferencedDocumentUrn(URN documentUrn)
Adds the given document URN to a list of documents to be referenced.
|
static AnnotatedPluginDocument |
DocumentUtilities.createAnnotatedPluginDocument(org.jdom.Element annotatedDocumentElement,
ElementProvider pluginDocumentElementProvider,
URN urnForNewDocument)
Creates an AnnotatedPluginDocument without the internal PluginDocument included.
|
static AnnotatedPluginDocument |
DocumentUtilities.getDocumentByURN(URN urn)
Fetches the specified document from either in memory or from the local or a shared database.
|
void |
OperationRecordDocument.removeOutputDocument(URN outputDocument)
Removes an output document from the record.
|
boolean |
OperationRecordDocument.replaceInputDocument(URN originalUrn,
URN newUrn)
Replaces the URN of an output document with a new one.
|
boolean |
OperationRecordDocument.replaceOutputDocument(URN originalUrn,
URN newUrn)
Replaces the URN of an output document with a new one.
|
static boolean |
DocumentUtilities.selectDocument(URN urn)
Changes the currently selected document in the Geneious document table.
|
boolean |
OperationRecordDocument.setOutputDocumentActive(URN urn,
boolean active)
Sets whether or not the output document with this URN is active.
|
abstract void |
AnnotatedPluginDocument.setParentOperationRecord(URN operationRecordUrn)
Sets a record of the operation that generated this document.
|
protected void |
AbstractPluginDocument.setURN(URN urn)
Set document URN.
|
| Modifier and Type | Method and Description |
|---|---|
abstract void |
AnnotatedPluginDocument.changeReferencedDocumentURNs(Map<URN,URN> URNsToChange)
Changes the URNs of any documents that the internal PluginDocument references.
|
abstract void |
AnnotatedPluginDocument.changeReferencedDocumentURNs(Map<URN,URN> URNsToChange)
Changes the URNs of any documents that the internal PluginDocument references.
|
static boolean |
DocumentUtilities.selectDocuments(List<URN> urns)
Changes the currently selected documents in the Geneious document table.
|
static boolean |
DocumentUtilities.selectDocuments(List<URN> urns,
SequenceSelection sequenceSelection)
Changes the currently selected documents in the Geneious document table and selects a region within them.
|
static void |
XMLSerializer.translateUrns(org.jdom.Element element,
Map<URN,URN> urnChanges)
Translates all URNs (i.e.
|
static void |
XMLSerializer.translateUrns(org.jdom.Element element,
Map<URN,URN> urnChanges)
Translates all URNs (i.e.
|
| Constructor and Description |
|---|
AbstractPluginDocument(Date created,
URN urn)
Construct a new document with a given URN and time of creation.
|
URN(URN urnToCopy)
Constructs a copy of this URN.
|
| Constructor and Description |
|---|
OperationRecordDocument(List<URN> inputDocuments,
List<URN> additionalParentDocuments,
String operationId,
long timeAtWhichOperationWasRun,
org.jdom.Element optionsForRecreatingDescendants)
Creates an operation record whose documents added later using
OperationRecordDocument.addOutputDocument(URN) will be actively linked (see OperationRecordDocument.hasAnyActiveLinks()) |
OperationRecordDocument(List<URN> inputDocuments,
List<URN> additionalParentDocuments,
String operationId,
long timeAtWhichOperationWasRun,
org.jdom.Element optionsForRecreatingDescendants)
Creates an operation record whose documents added later using
OperationRecordDocument.addOutputDocument(URN) will be actively linked (see OperationRecordDocument.hasAnyActiveLinks()) |
OperationRecordDocument(List<URN> inputDocuments,
String operationId,
long timeAtWhichOperationWasRun)
Creates an operation record whose documents added later using
OperationRecordDocument.addOutputDocument(URN) will be inactively linked (see OperationRecordDocument.hasAnyActiveLinks()) |
| Modifier and Type | Method and Description |
|---|---|
URN |
ImmutableSequenceImplementation.getURN() |
| Constructor and Description |
|---|
SequenceAnnotationQualifier(String name,
URN urn,
boolean strong,
String label)
create a new SequenceAnnotationQualifier which contains a reference to another document.
|
| Modifier and Type | Method and Description |
|---|---|
URN |
DefaultAlignmentDocument.getURN() |
URN |
DefaultSameTaxaTreesDocument.getURN() |
URN |
DefaultTreeDocument.getURN() |
| Modifier and Type | Method and Description |
|---|---|
URN |
SequenceTrack.getDocumentVisibleByDefaultOn()
if this returns a not-null value then this track is only visible by default when viewed from within document with this URN.
|
URN |
CombinedAlignmentAndSequenceDocument.getURN() |
URN |
SequencePropertiesStorage.getURN()
This method is not implemented.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SequenceTrack.setDocumentVisibleByDefaultOn(URN documentVisibleByDefaultOn)
Sets the document that this track is only visible by default on.
|
| Constructor and Description |
|---|
DefaultAminoAcidSequence(String name,
String description,
CharSequence charSequence,
Date created,
URN urn)
Construct a new amino acid sequence.
|
DefaultNucleotideGraphSequence(String name,
String description,
CharSequence charSequence,
Date created,
NucleotideGraph graph,
URN urn)
Create a DefaultNucleotideGraphSequence from any chromatogram.
|
DefaultNucleotideSequence(String name,
String description,
CharSequence charSequence,
Date created,
URN urn)
Construct a new nucelotide sequence.
|
DefaultSequenceDocument(String name,
String description,
CharSequence sequence,
Date created,
URN urn) |
| Constructor and Description |
|---|
PdbDocument(String defaultName,
Date date,
String content,
URN urn)
Construct an externally retrieved PDB document.
|