See: Description
| Interface | Description |
|---|---|
| AdditionalSearchContent |
Interface implemented by a document which has text stored in places other than the document fields and want that
text available for search.
|
| AdditionalSearchContent.Utilities.FilterElement |
Provide directions on how to handle element
|
| AnnotatedPluginDocument.DocumentNotes |
Provides access to all the
DocumentNotes on an AnnotatedPluginDocument |
| DocumentListener |
Used for notifying when an
AnnotatedPluginDocument has changed. |
| DocumentNote |
Represents an instance of a
DocumentNoteType that exists on a document. |
| DocumentNoteType |
This represents a "Note Type" in the program.
|
| ElementProvider |
Provides a method to load an XML element with progress information and
the ability to cancel it.
|
| ExportableDocument |
Interface implemented by plugin documents that wish to implemenet a specialized export.
|
| PluginDocument |
PluginDocument defines the interface for a Document created by a plugin.
|
| PluginDocument.ReferencedDocumentsAlwaysLoaded |
PluginDocuments can optionally implement this empty interface to signify that they generally require their referenced documents when
they are deserialized and for general use such as viewing the document, even if those referenced documents have not
been modified since this PluginDocument was last saved.
|
| PluginDocument.ReferencedDocumentsNotLoaded |
PluginDocuments can optionally implement this empty interface to signify that they don't require their referenced documents when
they are deserialized and for general use such as viewing the document.
|
| PluginDocument.SizeRequiredToLoadIntoMemoryProvider |
A PluginDocument may implement this interface to indicate to Geneious the amount of memory it will probably require in order to load the document.
|
| Renamable |
Provides that ability to rename something.
|
| SummaryDocument |
Any summary document should "implement" this empty interface to enable special handling of summary documents inside
Geneious.
|
| XMLSerializable |
Interface for handling persistent objects.
|
| XMLSerializable.OldVersionCompatible |
XMLSerializable classes may implement this to indicate they support serializing to older version formats and potentially deserializing from newer version formats.
|
| XMLSerializableWithProgress |
An extended interface to
XMLSerializable to support providing progress (and the ability to cancel)
when serializing and deserialing. |
| Class | Description |
|---|---|
| AbstractPluginDocument |
This class provides a "Field based" implementation of a Plugin documents.
|
| AdditionalSearchContent.Result |
Searchable content for a single category.
|
| AdditionalSearchContent.Utilities |
Small helpers for extracting searchable content from XML data.
|
| AnnotatedPluginDocument |
An AnnotatedPluginDocument is a wrapper document that wraps any
PluginDocument
(such as a SequenceDocument
or SequenceAlignmentDocument
or TreeDocument) and adds extra information
and provides extra functionality that the underlying PluginDocument need not concern itself with,
such as allowing the user to rename the document or edit any fields displayed in the document table. |
| Author |
A class holding one author name.
|
| Constraint |
The idea of a Constraint is very simple.
|
| DocumentCollection |
This class provides a field based document that stores a collection of other documents.
|
| DocumentField |
A Document Field describes the properties (but not value) of one data item of a plugin document or one field in a
search query.
|
| DocumentFieldAndValue |
Wraps a
DocumentField together with its value. |
| DocumentHistory |
The document history for an AnnotatedPluginDocument is made up of a list of
entries. |
| DocumentHistoryEntry |
Represents a single 'edit' of a document in the document history.
|
| DocumentHistoryEntryField |
A document history field is basically a name-value pair that describes one aspect of a
DocumentHistoryEntry. |
| DocumentNoteField |
Describes the properties of a single value in a note.
|
| DocumentNoteUtilities |
This gives access to the NoteTypes defined in the program.
|
| DocumentSearchCache<T extends PluginDocument> |
Class which caches the results of a search for a particular type of document and automatically updates
to include newly added documents of the particular type when they are added to the user's database.
|
| DocumentUtilities |
Some core functionality provided by Geneious for adding and managing documents.
|
| OperationRecordDocument |
Stores references to the input and output documents a from single
DocumentOperation. |
| URN |
An unmodifiable uniform resource name (URN), intended to serve as persistent, location-independent, resource identifiers.
|
| UrnWithRevisionNumber |
Represents an AnnotatedPluginDocument at a particular revision, via its URN (
AnnotatedPluginDocument.getURN())
and revision number (AnnotatedPluginDocument.getRevisionNumber()) |
| XMLSerializer |
Serialization helper class.
|
| Enum | Description |
|---|---|
| AdditionalSearchContent.Utilities.Filter |
Various filterng options on element text.
|
| AnnotatedPluginDocument.ActiveLinkSaveBehaviour |
Gives an action to take when
AnnotatedPluginDocument.saveDocument(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument.ActiveLinkSaveBehaviour, jebl.util.ProgressListener) is called. |
| Condition |
Available types of conditions.
|
| DocumentField.SequenceType |
Possible values for the
DocumentField.SEQUENCE_TYPE field. |
| DocumentNoteField.Types |
All of the available note field types.
|
| ExportableDocument.Format |
Current exportable formats.
|
| XMLSerializable.VersionSupportType |
Used for specifying the type of version support when used with
XMLSerializable.OldVersionCompatible.getVersionSupport(com.biomatters.geneious.publicapi.documents.XMLSerializable.VersionSupportType) |
| Exception | Description |
|---|---|
| MalformedURNException |
Exception indicating an incorrectly formatted URN.
|
| XMLSerializationException |
Represents a problem with XML serialization or deserialization.
|