| 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. |
| 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 | Method and Description |
|---|---|
Geneious.MajorVersion |
FolderView.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
| Modifier and Type | Method and Description |
|---|---|
org.jdom.Element |
FolderView.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
| 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.fieldValuesToElement(Geneious.MajorVersion version,
String name,
Map<String,Object> fieldValues,
boolean silentlyExcludeXmlSerializableFieldsThatDontSupportThisVersion)
Create one jdom element containing several fields.
|
static org.jdom.Element |
XMLSerializer.fieldValueToElement(Geneious.MajorVersion version,
String elementName,
Object value)
Create one jdom element containing one field value.
|
static org.jdom.Element |
XMLSerializer.pluginDocumentToXml(Geneious.MajorVersion version,
PluginDocument pluginDocument,
ProgressListener progressListener)
Converts a PluginDocument to XML, handling the case where the PluginDocument may or may not implement
XMLSerializableWithProgress. |
org.jdom.Element |
AbstractPluginDocument.toXML(Geneious.MajorVersion version,
ProgressListener progressListener) |
org.jdom.Element |
DocumentCollection.toXML(Geneious.MajorVersion version,
ProgressListener progressListener) |
org.jdom.Element |
DocumentField.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
OperationRecordDocument.toXML(Geneious.MajorVersion version,
ProgressListener progressListener) |
org.jdom.Element |
XMLSerializable.OldVersionCompatible.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener)
Serializes this class to XML format, potentially to a format readable by an earlier version of Geneious.
|
abstract org.jdom.Element |
AnnotatedPluginDocument.toXMLExcludingInternalPluginDocument(Geneious.MajorVersion majorVersion)
converts this AnnotatedPluginDocument to a single XML element.
|
| Modifier and Type | Method and Description |
|---|---|
org.jdom.Element |
AlignmentLayout.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
DefaultSequenceListDocument.toXML(Geneious.MajorVersion version,
ProgressListener progressListener) |
org.jdom.Element |
SequenceAnnotation.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener)
Serialization of annotation - to.
|
org.jdom.Element |
SequenceCharSequence.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
SequenceListOnDisk.AlignmentData.toXML(Geneious.MajorVersion version,
ProgressListener progressListener) |
org.jdom.Element |
SequenceListSummary.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
ValueAndFrequencyDistribution.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
ImmutableSequence.toXML(Geneious.MajorVersion version,
ProgressListener progressListener,
boolean allowFileData) |
org.jdom.Element |
SequenceCharSequence.toXML(Geneious.MajorVersion version,
ProgressListener progressListener,
boolean allowFileData)
Serializes this SequenceCharSequence to XML into an element named
XMLSerializable.ROOT_ELEMENT_NAME. |
void |
SequenceAnnotation.writeObject(Geneious.MajorVersion version,
DataOutput out)
Writes this annotation to a DataOutput in a form that can potentially be read by old versions of Geneious
|
static void |
DefaultNucleotideGraph.writeObject(Geneious.MajorVersion version,
DataOutput out,
NucleotideGraph graph)
Writes the given graph in a binary format to an output stream (as specified by
Serializable)
such that it can be recreated using DefaultNucleotideGraph.readObject(java.io.DataInput). |
void |
ImmutableSequence.writeObject(Geneious.MajorVersion version,
DataOutput out,
ProgressListener progressListener) |
void |
SequenceCharSequence.writeObject(Geneious.MajorVersion version,
DataOutput dataOutput,
ProgressListener progressListener)
Writes this sequence to a DataOutput.
|
| Modifier and Type | Method and Description |
|---|---|
Geneious.MajorVersion |
DefaultAlignmentDocument.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
DefaultPhylogenyDocument.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
DefaultSameTaxaTreesDocument.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
DefaultTreeDocument.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
EValue.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
EndGapsManager.getVersionSupport(XMLSerializable.VersionSupportType versionType)
Like
XMLSerializable.OldVersionCompatible#getVersionSupport(com.biomatters.geneious.publicapi.documents.XMLSerializable.VersionSupportType)
but this class isn't really XML serialiable. |
Geneious.MajorVersion |
PairedReadManager.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
Percentage.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
static Geneious.MajorVersion |
SequenceGapInformation.getVersionSupportStatic(XMLSerializable.VersionSupportType versionType)
Returns version support as defined by
XMLSerializable.OldVersionCompatible#getVersionSupport(com.biomatters.geneious.publicapi.documents.XMLSerializable.VersionSupportType). |
| Modifier and Type | Method and Description |
|---|---|
void |
PairedReadManager.toOutputStream(Geneious.MajorVersion version,
GeneiousObjectOutputStream objectOutputStream)
Serializes this PairedReadManager to an output stream so that it can be reconstructed later using
PairedReadManager.PairedReadManager(com.biomatters.geneious.publicapi.documents.sequence.GeneiousObjectInputStream). |
org.jdom.Element |
DefaultAlignmentDocument.toXML(Geneious.MajorVersion version,
ProgressListener progressListener) |
org.jdom.Element |
DefaultPhylogenyDocument.toXML(Geneious.MajorVersion version,
ProgressListener progressListener) |
org.jdom.Element |
DefaultSameTaxaTreesDocument.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
DefaultTreeDocument.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
EValue.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
PairedReadManager.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
Percentage.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
SequenceGapInformation.toXML(Geneious.MajorVersion version,
String name)
Serializes this gap information (excluding the char sequence) to XML which may use
PluginDocument.FILE_DATA_ATTRIBUTE_NAME |
org.jdom.Element |
EndGapsManager.toXmlExcludingSequences(Geneious.MajorVersion version,
ProgressListener progressListener)
Converts this EndGapsManager to XML, excluding the associated sequences, which must be stored independently and provided again during serialization using
EndGapsManager.EndGapsManager(org.jdom.Element, com.biomatters.geneious.publicapi.documents.sequence.SequenceListOnDisk) |
| Modifier and Type | Method and Description |
|---|---|
Geneious.MajorVersion |
CombinedAlignmentAndSequenceDocument.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
DefaultNucleotideGraphSequence.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
DefaultSequenceDocument.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
OligoSequenceDocument.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
SequencePropertiesStorage.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
SequenceTrack.Manager.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
| Modifier and Type | Method and Description |
|---|---|
static org.jdom.Element |
SequencePropertiesStorage.integerArrayToXML(Geneious.MajorVersion version,
String elementName,
int[] values)
Converts an integer array to xml, storing them in a compact way if possible.
|
static org.jdom.Element |
DefaultSequenceDocument.sequenceAnnotationsToXML(Geneious.MajorVersion version,
String elementName,
List<SequenceAnnotation> annotations)
Return a list of sequence annotations as XML in the specified version of Geneious
|
org.jdom.Element |
CombinedAlignmentAndSequenceDocument.toXML(Geneious.MajorVersion version,
ProgressListener progressListener) |
org.jdom.Element |
DefaultNucleotideGraphSequence.toXML(Geneious.MajorVersion version,
ProgressListener progressListener) |
org.jdom.Element |
DefaultSequenceDocument.toXML(Geneious.MajorVersion version,
ProgressListener progressListener) |
org.jdom.Element |
OligoSequenceDocument.toXML(Geneious.MajorVersion version,
ProgressListener progressListener) |
org.jdom.Element |
SequencePropertiesStorage.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
SequenceTrack.Manager.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener)
Serializes this manager to XML, using
PluginDocument.FILE_DATA_ATTRIBUTE_NAME where appropriate. |
void |
DefaultSequenceDocument.writeObject(Geneious.MajorVersion version,
DataOutput out,
ProgressListener progressListener)
Writes this sequence to a stream as specified by
Serializable. |
void |
SequenceTrack.Manager.writeObject(Geneious.MajorVersion majorVersion,
DataOutput out,
ProgressListener progressListener)
Writes this manager to a DataOutput
|
| Modifier and Type | Method and Description |
|---|---|
Geneious.MajorVersion |
PdbDocument.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
| Modifier and Type | Method and Description |
|---|---|
static Geneious.MajorVersion |
Geneious.MajorVersion.forVersion(String version)
Gets the MajorVersion from a full Geneious version (e.g.
|
static Geneious.MajorVersion |
Geneious.getMajorVersion() |
Geneious.MajorVersion |
SequenceSelection.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
SequenceSelection.SequenceIndex.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
SequenceSelection.SelectionInterval.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
SequenceSelectionWithDocuments.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
SequenceSelectionWithDocuments.ExtractionStrategy.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
Geneious.MajorVersion |
Options.getVersionSupportForValuesToXML(XMLSerializable.VersionSupportType versionType)
Gets the version support as defined by
OldVersionCompatible#getVersionSupport(com.biomatters.geneious.publicapi.documents.XMLSerializable.VersionSupportType)
for use with Options.valuesToXML(com.biomatters.geneious.publicapi.plugin.Geneious.MajorVersion, String) |
static Geneious.MajorVersion |
Geneious.MajorVersion.max(Geneious.MajorVersion... versions) |
static Geneious.MajorVersion |
Geneious.MajorVersion.min(Geneious.MajorVersion... versions) |
static Geneious.MajorVersion |
Geneious.MajorVersion.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static Geneious.MajorVersion[] |
Geneious.MajorVersion.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
| Modifier and Type | Method and Description |
|---|---|
static Geneious.MajorVersion |
Geneious.MajorVersion.max(Geneious.MajorVersion... versions) |
static Geneious.MajorVersion |
Geneious.MajorVersion.min(Geneious.MajorVersion... versions) |
org.jdom.Element |
SequenceSelection.toXML(Geneious.MajorVersion version,
ProgressListener progressListener) |
org.jdom.Element |
SequenceSelection.SequenceIndex.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
SequenceSelection.SelectionInterval.toXML(Geneious.MajorVersion version,
ProgressListener progressListener) |
org.jdom.Element |
SequenceSelectionWithDocuments.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
SequenceSelectionWithDocuments.ExtractionStrategy.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
org.jdom.Element |
Options.valuesToXML(Geneious.MajorVersion version,
String rootElementName)
Serializes the current values for these options to XML for use with
a later call to
Options.valuesFromXML(org.jdom.Element). |
org.jdom.Element |
Options.valuesToXML(Geneious.MajorVersion version,
String rootElementName,
boolean excludeOptionsWhereRestorePreferenceApplies)
Serializes the current values for these options to XML for use with
a later call to
Options.valuesFromXML(org.jdom.Element). |
| Modifier and Type | Method and Description |
|---|---|
Geneious.MajorVersion |
Interval.getVersionSupport(XMLSerializable.VersionSupportType versionType) |
| Modifier and Type | Method and Description |
|---|---|
org.jdom.Element |
Interval.toXML(Geneious.MajorVersion majorVersion,
ProgressListener progressListener) |
static void |
DataInputOutputUtilities.writeSequence(Geneious.MajorVersion version,
DataOutput out,
SequenceDocument sequence,
ProgressListener progressListener)
Writes a sequence to a DataOutput which can be read back using
DataInputOutputUtilities.readSequence(java.io.DataInput) |