| 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.documents.types |
Provides interfaces specifying the types of documents available in Geneious.
|
| 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. |
| 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 | Interface and Description |
|---|---|
interface |
AdvancedSearchQueryTerm
Basic term in a Geneious advanced search query.
|
interface |
BasicSearchQuery
A simple, text only search query.
|
interface |
CompoundSearchQuery
A compound query is a set of queries combined by a logical operator.
|
interface |
FolderViewDocument
A PluginDocument may implement this interface to indicate that it provides information about the results
of a search.
|
interface |
Query
An interface that produces a common ancestor for various queries.
|
| Modifier and Type | Class and Description |
|---|---|
class |
FolderView
Stores information about documents in a folder.
|
class |
QueryField
Basic block for building advanced search queries.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
PluginDocument
PluginDocument defines the interface for a Document created by a plugin.
|
interface |
SummaryDocument
Any summary document should "implement" this empty interface to enable special handling of summary documents inside
Geneious.
|
interface |
XMLSerializableWithProgress
An extended interface to
XMLSerializable to support providing progress (and the ability to cancel)
when serializing and deserialing. |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractPluginDocument
This class provides a "Field based" implementation of a Plugin documents.
|
class |
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. |
class |
Author
A class holding one author name.
|
class |
DocumentCollection
This class provides a field based document that stores a collection of other documents.
|
class |
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.
|
class |
DocumentHistoryEntry
Represents a single 'edit' of a document in the document history.
|
class |
DocumentHistoryEntryField
A document history field is basically a name-value pair that describes one aspect of a
DocumentHistoryEntry. |
class |
OperationRecordDocument
Stores references to the input and output documents a from single
DocumentOperation. |
| Modifier and Type | Method and Description |
|---|---|
static <T extends XMLSerializable> |
XMLSerializer.classFromXML(org.jdom.Element element,
Class<? extends T> cl)
recreates an object from an XML element created from a classToXML() call.
|
static <T extends XMLSerializable> |
XMLSerializer.classFromXML(org.jdom.Element element,
Class<? extends T> cl,
ProgressListener progressListener)
recreates an object from an XML element created from a classToXML() call.
|
static <T extends XMLSerializable> |
XMLSerializer.clone(T object)
Create a copy of an XMLSerializable object by serializing and then
de-serializing it.
|
static <T extends XMLSerializable> |
XMLSerializer.listFromXML(org.jdom.Element element,
Class<? extends T> cl)
Deserializes a list of XMLSerializable elements which were serialized using
XMLSerializer.listToXML(String, java.util.List). |
| Modifier and Type | Method and Description |
|---|---|
static XMLSerializable |
XMLSerializer.classFromXML(org.jdom.Element element)
A convenience method.
|
static XMLSerializable |
XMLSerializer.classFromXML(org.jdom.Element element,
ProgressListener progressListener)
A convenience method.
|
| Modifier and Type | Method and Description |
|---|---|
static org.jdom.Element |
XMLSerializer.classToXML(Geneious.MajorVersion version,
String elementName,
XMLSerializable object,
ProgressListener progressListener)
converts the given object to an XML element of the given name so that is is readable in the specified version of Geneious.
|
static org.jdom.Element |
XMLSerializer.classToXML(String elementName,
XMLSerializable object)
converts the given object to an XML element of the given name.
|
static org.jdom.Element |
XMLSerializer.classToXML(String elementName,
XMLSerializable object,
ProgressListener progressListener)
converts the given object to an XML element of the given name.
|
Geneious.MajorVersion |
XMLSerializable.VersionSupportType.getVersionSupport(XMLSerializable xmlSerializable)
Helper method for implementing
XMLSerializable.OldVersionCompatible.getVersionSupport(com.biomatters.geneious.publicapi.documents.XMLSerializable.VersionSupportType) that
returns that delegates to the given object if it implements OldVersionCompatible or returns Geneious.getMajorVersion() if it doesn't. |
| Modifier and Type | Method and Description |
|---|---|
static DocumentField |
DocumentField.createCustomField(String name,
String desc,
String code,
Class<? extends XMLSerializable> valueType)
Creates a DocumentField with a value of arbitrary type.
|
static DocumentField |
DocumentField.createCustomField(String name,
String desc,
String code,
Class<? extends XMLSerializable> valueType,
boolean defaultVisible,
boolean editable)
Creates a DocumentField with a value of arbitrary type.
|
static org.jdom.Element |
XMLSerializer.listToXML(String name,
List<? extends XMLSerializable> list)
Serializes a list of XMLSerializable elements which can be deserialized using
XMLSerializer.listFromXML(org.jdom.Element, Class). |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AminoAcidSequenceDocument
An interface for an Amino Acid sequence.
|
interface |
ChromatogramDocument
Deprecated.
Check for instanceof
NucleotideGraphSequenceDocument instead. |
interface |
EditableNucleotideGraphSequenceDocument
A mutable nucleotide sequence with residue graph.
|
interface |
EditableSequenceDocument
An extensions of a
SequenceDocument that can be edited. |
interface |
NucleotideGraphSequenceDocument
A nucleotide sequence with an underlying "graph".
|
interface |
NucleotideSequenceDocument
An interface for a nucleotide sequence.
|
interface |
SequenceAlignmentListDocument
A document representing a list of alignments.
|
interface |
SequenceDocument
Interface representing one sequence.
|
interface |
SequenceDocumentWithEditableAnnotations
An extension of a
SequenceDocument that allows its annotations to be changed. |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultSequenceListDocument
A default implementation of a
SequenceListDocument. |
class |
ImmutableSequence
An implementation of a
SequenceDocument that is immutable
and has very low memory usage. |
class |
ImmutableSequenceImplementation
Despite this class being public, it is only public for implementation reasons.
|
class |
SequenceAlignmentDocument
An alignment or contig of sequences.
|
class |
SequenceAnnotation
Provides information on a subset of the sequence.
|
class |
SequenceCharSequence
A CharSequence that knows the length of its terminal gaps (sequences of '-') and
allows for efficient
insertions and
deletions of subsequences. |
class |
SequenceListOnDisk<T extends SequenceDocument>
A list of sequences which are loaded from disk on demand rather than all stored in memory.
|
class |
SequenceListSummary
Provides a summary of data in a list of sequences.
|
class |
ValueAndFrequencyDistribution
Provides a sorted distribution of longs and the frequency of each of them.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
EditableSameTaxaTreesDocument
A mutable tree set.
|
interface |
JournalArticleDocument
Interface for plugin documents containing a Journal Article.
|
interface |
MolecularStructureDocument
Interface representing 3D model data of a molecular structure.
|
interface |
PublicationDocument
Interface for plugin documents containing a publication.
|
interface |
RootedTreeDocument
A document containing one (rooted) tree.
|
interface |
SameTaxaTreesDocument
A document containing a list of trees.
|
interface |
TaxonomyDocument
A plugin document containing one
TaxonomyDocument.Taxon, which holds information
(rank, scientific name and alternative names) about one taxon in a taxonomy,
and a reference to its parent taxon (if any). |
interface |
TreeDocument
The common base for all documents that hold one or several trees.
|
| Modifier and Type | Class and Description |
|---|---|
class |
PhylogenyDocument
A document containing an alignment and one or more trees whose tips are the sequences
(i.e.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultAlignmentDocument
An implementation of a
SequenceAlignmentDocument. |
class |
DefaultPhylogenyDocument
An implementation of a Phylogeny document.
|
class |
DefaultSameTaxaTreesDocument
A default implementation of a plugin document holding a list of trees.
|
class |
DefaultTreeDocument
A default implementation of a plugin document holding a tree.
|
class |
EValue
Just like a double, but the toString() method displays it as a nicely formatted e value
|
class |
Percentage
Just like a double, but the toString() method displays it as a percentage
with the specified number of decimal places.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CombinedAlignmentAndAminoAcidSequenceDocument
See documentation at
CombinedAlignmentAndSequenceDocument |
class |
CombinedAlignmentAndNucleotideGraphSequenceDocument
See documentation at
CombinedAlignmentAndSequenceDocument |
class |
CombinedAlignmentAndNucleotideSequenceDocument
See documentation at
CombinedAlignmentAndSequenceDocument |
class |
CombinedAlignmentAndSequenceDocument
A wrapper to both an alignment and a stand-alone sequence that appears as a single EditableSequenceDocument.
|
class |
DefaultAminoAcidSequence
A plugin document holding one amino acid sequence.
|
class |
DefaultNucleotideGraphSequence
An implementation of an editable chromatogram.
|
class |
DefaultNucleotideSequence
A plugin document holding one nucleotide sequence.
|
class |
DefaultSequenceDocument
A default implementation of a sequence document.
|
class |
OligoSequenceDocument
A sequence document which represents an olgionucleotide such as a Primer or DNA probe.
|
class |
SequencePropertiesStorage
Provides supporting functionality for sequence classes that need to store
various sequence properties and serialise those to XML.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmlDocument
A Cml molecular structure document.
|
class |
DefaultMolecularStructureDocument
An implementation of a MolecularStructureDocument.
|
class |
GprDocument
A Gpr molecular structure document.
|
class |
HinDocument
A Hin molecular structure document.
|
class |
MolDocument
A Mol molecular structure document.
|
class |
NwoDocument
A Nwo molecular structure document.
|
class |
PdbDocument
A PDB molecular structure document.
|
class |
XyzDocument
An XYZ molecular structure document.
|
| Modifier and Type | Interface and Description |
|---|---|
static interface |
DocumentSelectionOption.DoNotRememberInPreferences
An interface that documents used in a DocumentSelectionOption may implement so that the option doesn't cache their instance
and reuse it on future instances of these options.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DocumentSelectionOption
An option to allow the user to select a number of documents of a particular type from their local database.
|
class |
DocumentSelectionSignature
Several plugin components (Viewers, Exporters, Operations, Actions) operate on one (or a set of) Geneious documents.
|
class |
OperationLocationOptions
An
Options that provides the ability to pick between running an Operation on the local computer or on a
supported GeneiousService. |
class |
Options
|
static class |
Options.BooleanOption
An option that stores a Boolean and is represented graphically as a check box.
|
static class |
Options.ButtonOption
Provides the user with a button which may have actions associated with it by calling
Options.ButtonOption.addActionListener(java.awt.event.ActionListener). |
static class |
Options.ComboBoxOption<ValueType extends Options.OptionValue>
An option that provides the user with a list of options in a combo box
|
static class |
Options.DateOption
An option that stores a date.
|
static class |
Options.DoubleOption
An option that stores an Double and is displayed graphically
to the user as a single line text field with a spinner (up and down arrow)
on the right-hand side
|
static class |
Options.EditableComboBoxOption
Like a ComboBoxOption, but besides letting the user choose one of
the preconfigured default values, also allows arbitrary custom strings
to be entered.
|
static class |
Options.ExecutableFileSelectionOption
Provides the user with an executable file name and provides assistance with finding
the location of it.
|
static class |
Options.FileSelectionOption
Provides functionality to let the user choose a file.
|
static class |
Options.IntegerOption
An option that stores an Integer and is displayed graphically
to the user as a single line text field with a spinner (up and down arrow)
on the right-hand side.
|
static class |
Options.LabelOption
An option that is only used for display purposes.
|
static class |
Options.MultipleLineStringOption
An option that stores a String and is displayed to the user as a multiple line text area
|
static class |
Options.MultipleOptions
Stores the multiple options added using
Options.addMultipleOptions(String, Options, boolean)
and provides methods to access the current values (Options.MultipleOptions.getValues()) and to add change listeners
(Options.MultipleOptions.addChangeListener(org.virion.jam.util.SimpleListener) and to
change the enabled state Options.MultipleOptions.setEnabled(boolean). |
static class |
Options.Option<ValueType,ComponentType extends JComponent>
The base class of all types of options.
|
static class |
Options.OptionValue
Possible values that a
Options.RadioOption or Options.ComboBoxOption can
take on. |
static class |
Options.RadioOption<ValueType extends Options.OptionValue>
An option that provides the user with a list of radio buttons to select one of
|
static class |
Options.StringOption
An option that stores a String and is displayed graphically to the user as a single line text field.
|
static class |
SequenceAnnotationGenerator.SelectionGrabOption
If any option returned from
SequenceAnnotationGenerator.getOptions(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[], com.biomatters.geneious.publicapi.plugin.SequenceAnnotationGenerator.SelectionRange)
is a SelectionGrabOption then the sequence viewer will interact with the option such that when the user clicks on the button representing this option, the current selection
in the sequence viewer is copied to this option value. |
class |
SequenceSelection
Specifies a selection of regions in a sequence, list of sequences, alignment or other sequence containing document.
|
class |
SequenceSelectionWithDocuments
This class associates a
SequenceSelection with the List of AnnotatedPluginDocument that it is
defined on. |
static class |
SequenceSelectionWithDocuments.ExtractionStrategy
Instances of this allow calling code to fine tune how
SequenceSelectionWithDocuments.getSequences() returns
SequenceDocuments from its selection and documents. |
| Modifier and Type | Class and Description |
|---|---|
class |
Interval
Represents a directional interval.
|
| Modifier and Type | Method and Description |
|---|---|
static XMLSerializable |
DataInputOutputUtilities.readXmlSerializable(DataInput input)
Reads an XMLSerializable from this input stream that was previously written using
DataInputOutputUtilities.writeXmlSerializable(java.io.DataOutput, com.biomatters.geneious.publicapi.documents.XMLSerializable, jebl.util.ProgressListener) |
| Modifier and Type | Method and Description |
|---|---|
static void |
DataInputOutputUtilities.writeXmlSerializable(DataOutput out,
XMLSerializable xmlSerializable,
ProgressListener progressListener)
Writes an XmlSerializable object to a DataOutput which can be read back using
DataInputOutputUtilities.readXmlSerializable(java.io.DataInput)This method lacks many of the optimizations that DataInputOutputUtilities.writeSequence(java.io.DataOutput, com.biomatters.geneious.publicapi.documents.sequence.SequenceDocument, jebl.util.ProgressListener) contains. |