| 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.
|
| com.biomatters.geneious.publicapi.utilities.xml |
| Modifier and Type | Method and Description |
|---|---|
void |
FolderView.fromXML(org.jdom.Element element) |
void |
QueryField.fromXML(org.jdom.Element element) |
| Constructor and Description |
|---|
FolderView(org.jdom.Element element)
XML deserialization constructor.
|
| Modifier and Type | Method and Description |
|---|---|
static XMLSerializable |
XMLSerializer.classFromXML(org.jdom.Element element)
A convenience method.
|
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 XMLSerializable |
XMLSerializer.classFromXML(org.jdom.Element element,
ProgressListener progressListener)
A convenience method.
|
static <T extends XMLSerializable> |
XMLSerializer.clone(T object)
Create a copy of an XMLSerializable object by serializing and then
de-serializing it.
|
static AnnotatedPluginDocument |
DocumentUtilities.createAnnotatedPluginDocument(org.jdom.Element annotatedDocumentElement,
ElementProvider pluginDocumentElementProvider,
boolean assignNewURN)
Deprecated.
use
DocumentUtilities.createAnnotatedPluginDocument(org.jdom.Element, ElementProvider, boolean) instead, where the final parameter of null is equivalent to assignNewURN==false or URN.generateUniqueLocalURN() for assignNewURN==true |
static AnnotatedPluginDocument |
DocumentUtilities.createAnnotatedPluginDocument(org.jdom.Element annotatedDocumentElement,
ElementProvider pluginDocumentElementProvider,
String assignerForUrn)
Deprecated.
|
static AnnotatedPluginDocument |
DocumentUtilities.createAnnotatedPluginDocument(org.jdom.Element annotatedDocumentElement,
ElementProvider pluginDocumentElementProvider,
URN urnForNewDocument)
Creates an AnnotatedPluginDocument without the internal PluginDocument included.
|
static void |
XMLSerializer.ensureMemoryAvailable(long memoryInBytes)
Ensures that at least this much memory is available plus a little extra (100 MB in the current implementation) to be safe, and if not throws an XMLSerializationException
|
void |
AbstractPluginDocument.fromXML(org.jdom.Element root) |
void |
Author.fromXML(org.jdom.Element element) |
void |
DocumentCollection.fromXML(org.jdom.Element root) |
void |
DocumentField.fromXML(org.jdom.Element element) |
void |
OperationRecordDocument.fromXML(org.jdom.Element element) |
void |
XMLSerializable.fromXML(org.jdom.Element element)
Restore the object from the JDOM Element returned by
XMLSerializable.toXML(). |
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). |
static File |
DocumentUtilities.pluginDocumentFileDataFromXml(org.jdom.Element element,
boolean mayReturnNullIfNoFileData,
boolean fileMayBeZeroBytesInSize)
Deserializes the name of a file serialized using
DocumentUtilities.pluginDocumentFileDataToXml(org.jdom.Element, java.io.File, boolean) checking for corruption such
as the file disappearing, changing in size or reducing to 0 bytes in size. |
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. |
static org.jdom.Element |
XMLSerializer.pluginDocumentToXml(PluginDocument pluginDocument,
ProgressListener progressListener)
Converts a PluginDocument to XML, handling the case where the PluginDocument may or may not implement
XMLSerializableWithProgress. |
| Modifier and Type | Method and Description |
|---|---|
static SequenceCharSequence |
SequenceCharSequence.fromXml(org.jdom.Element element)
Constructs a SequenceCharSequence from the specified element to which it
was serialized via
SequenceCharSequence.toXML(). |
static SequenceListOnDisk |
SequenceListOnDisk.fromXml(org.jdom.Element element)
Recreates a SequenceListOnDisk from XML returned from
SequenceListOnDisk.toXML(String) |
void |
DefaultSequenceListDocument.fromXML(org.jdom.Element root) |
void |
SequenceAnnotation.fromXML(org.jdom.Element element) |
void |
SequenceCharSequence.fromXML(org.jdom.Element element)
Unsupported operation.
|
void |
SequenceListOnDisk.fromXML(org.jdom.Element element) |
void |
SequenceListSummary.fromXML(org.jdom.Element element) |
void |
ValueAndFrequencyDistribution.fromXML(org.jdom.Element element) |
void |
DefaultSequenceListDocument.fromXML(org.jdom.Element root,
ProgressListener progressListener)
Deserializes this document from XML
|
static ImmutableSequence |
ImmutableSequence.immutableSequenceFromXML(org.jdom.Element element)
Recreates this sequence from XML returned from a previous call to
ImmutableSequence.toXML(boolean). |
static SequenceCharSequence |
SequenceCharSequence.readObject(DataInput dataInput)
Reconstructs this sequence from data previously created using
SequenceCharSequence.writeObject(java.io.DataOutput, jebl.util.ProgressListener) |
static ImmutableSequence |
ImmutableSequenceImplementation.readObject(DataInput in,
byte header) |
static ImmutableSequence |
ImmutableSequence.readObject(GeneiousObjectInputStream in)
Reads a instance of an
ImmutableSequence that
was previously written using SequenceCharSequence.writeObject(GeneiousObjectOutputStream, jebl.util.ProgressListener) |
static SequenceCharSequence |
SequenceCharSequence.readObject(GeneiousObjectInputStream inputStream)
Reconstructs this sequence from data previously created using
SequenceCharSequence.writeObject(GeneiousObjectOutputStream , jebl.util.ProgressListener) |
org.jdom.Element |
ImmutableSequence.toXML(boolean allowFileData) |
org.jdom.Element |
SequenceCharSequence.toXML(boolean allowFileData)
Serializes this SequenceCharSequence to XML into an element named
XMLSerializable.ROOT_ELEMENT_NAME. |
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. |
| Constructor and Description |
|---|
AlignmentLayout(org.jdom.Element element)
Recreates an AlignmentLayout from XML.
|
SequenceAnnotation(org.jdom.Element element)
XML deserialization constructor.
|
SequenceListOnDisk.AlignmentData(org.jdom.Element element)
Recreates AlignmentData from a previously serialized AlignmentData
|
SequenceListSummary(org.jdom.Element element)
Creates a summary from a previously serialized summary
|
ValueAndFrequencyDistribution(org.jdom.Element e)
Construct a new empty distribution from some previously serialized data.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DefaultAlignmentDocument.fromXML(org.jdom.Element e) |
void |
DefaultPhylogenyDocument.fromXML(org.jdom.Element doc) |
void |
DefaultSameTaxaTreesDocument.fromXML(org.jdom.Element doc) |
void |
DefaultTreeDocument.fromXML(org.jdom.Element doc) |
void |
EValue.fromXML(org.jdom.Element element) |
void |
Percentage.fromXML(org.jdom.Element element) |
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) |
org.jdom.Element |
EndGapsManager.toXmlExcludingSequences(String elementName)
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) |
| Constructor and Description |
|---|
DefaultPhylogenyDocument(org.jdom.Element element)
XML deserialization constructor.
|
DefaultSameTaxaTreesDocument(org.jdom.Element element)
XML deserialization constructor.
|
DefaultTreeDocument(org.jdom.Element element)
XML deserialization constructor.
|
| Modifier and Type | Method and Description |
|---|---|
static List<SequenceAnnotation> |
DefaultSequenceDocument.annotationsFromXML(org.jdom.Element annotationsElement)
Return a List of SequenceAnnotations from a JDOM XML Element.
|
void |
CombinedAlignmentAndSequenceDocument.fromXML(org.jdom.Element element) |
void |
DefaultNucleotideGraphSequence.fromXML(org.jdom.Element root) |
void |
DefaultSequenceDocument.fromXML(org.jdom.Element root) |
void |
OligoSequenceDocument.fromXML(org.jdom.Element root) |
void |
SequencePropertiesStorage.fromXML(org.jdom.Element root) |
void |
SequencePropertiesStorage.fromXML(org.jdom.Element root,
NucleotideGraph overriddenGraph)
Deprecated.
|
static DefaultSequenceDocument |
DefaultSequenceDocument.readObject(DataInput in)
Recreates a sequence from a stream previously written to using
DefaultSequenceDocument.writeObject(java.io.DataOutput, jebl.util.ProgressListener) |
static DefaultSequenceDocument |
DefaultSequenceDocument.readObject(GeneiousObjectInputStream in)
Recreates a sequence from a stream previously written to using
DefaultSequenceDocument.writeObject(com.biomatters.geneious.publicapi.documents.sequence.GeneiousObjectOutputStream , jebl.util.ProgressListener) |
| Constructor and Description |
|---|
SequencePropertiesStorage(org.jdom.Element element)
Constructs a SequencePropertiesStorage object from a JDOM XML Element.
|
SequenceTrack.Manager(PluginDocument associatedPluginDocument,
org.jdom.Element element)
Recreates a manager from XML.
|
SequenceTrack(org.jdom.Element element)
Deserializes a track from XML.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PdbDocument.fromXML(org.jdom.Element root) |
| Modifier and Type | Method and Description |
|---|---|
void |
DocumentSelectionSignature.fromXML(org.jdom.Element element) |
void |
Options.fromXML(org.jdom.Element element) |
void |
Options.MultipleOptions.fromXML(org.jdom.Element element) |
void |
Options.Option.fromXML(org.jdom.Element element)
|
void |
Options.OptionValue.fromXML(org.jdom.Element element) |
void |
SequenceSelection.fromXML(org.jdom.Element element) |
void |
SequenceSelectionWithDocuments.fromXML(org.jdom.Element element) |
void |
SequenceSelectionWithDocuments.ExtractionStrategy.fromXML(org.jdom.Element element) |
| Constructor and Description |
|---|
DocumentSelectionSignature(org.jdom.Element element)
XML deserialization constructor
|
Options.BooleanOption(org.jdom.Element e)
Constructor for XML Serialization.
|
Options.ButtonOption(org.jdom.Element element)
Constructor for XML Serialization.
|
Options.ComboBoxOption(org.jdom.Element e)
Constructor for XML Serialization.
|
Options.DoubleOption(org.jdom.Element element)
Constructor for XML Serialization.
|
Options.ExecutableFileSelectionOption(org.jdom.Element e)
Constructor for XML Serialization.
|
Options.FileSelectionOption(org.jdom.Element element)
Constructor for XML Serialization.
|
Options.IntegerOption(org.jdom.Element element)
Constructor for XML Serialization.
|
Options.LabelOption(org.jdom.Element element) |
Options.MultipleLineStringOption(org.jdom.Element element)
Constructor for XML Serialization.
|
Options.Option(org.jdom.Element element)
Constructor for XML Serialization.
|
Options.OptionValue(org.jdom.Element element) |
Options.RadioOption(org.jdom.Element e)
Constructor for XML Serialization.
|
Options.StringOption(org.jdom.Element e)
Constructor for XML Serialization.
|
Options(org.jdom.Element element)
Constructor for XML Serialization.
|
SequenceAnnotationGenerator.SelectionGrabOption(org.jdom.Element element) |
SequenceSelection.SelectionInterval(org.jdom.Element element) |
SequenceSelection.SequenceIndex(org.jdom.Element element)
Reconstruct using results returned from
SequenceSelection.SequenceIndex.toXML() |
SequenceSelection(org.jdom.Element element)
Construct a SequenceSelection from the results of
SequenceSelection.toXML() |
SequenceSelectionWithDocuments(org.jdom.Element element)
Construct a SequenceSelectionWithDocuments from the results of
SequenceSelectionWithDocuments.toXML() |
| Modifier and Type | Method and Description |
|---|---|
void |
Interval.fromXML(org.jdom.Element element) |
| Constructor and Description |
|---|
Interval(org.jdom.Element element)
Reconstructs this interval from a previously serialized element
|
| Modifier and Type | Method and Description |
|---|---|
static void |
PluginDocumentXmlCollection.fromXml(org.jdom.Element rootElement,
PluginDocumentXmlCollection.ElementHandler childElementHandler,
ProgressListener progressListener)
deserializes some XML elements, calling
PluginDocumentXmlCollection.ElementHandler.handleElement(org.jdom.Element)
for each child element. |
abstract void |
PluginDocumentXmlCollection.ElementHandler.handleElement(org.jdom.Element element)
Provides a single child element to the caller of a
PluginDocumentXmlCollection.fromXml(org.jdom.Element, com.biomatters.geneious.publicapi.utilities.xml.PluginDocumentXmlCollection.ElementHandler, jebl.util.ProgressListener) call. |
static org.jdom.Element |
PluginDocumentXmlCollection.toXml(org.jdom.Element rootElement,
Iterable<org.jdom.Element> childElements,
int childElementsSize,
ProgressListener progressListener,
boolean serializeToFileInsteadOfMemory)
Serializes these elements into a single parent element, potentially storing them in a file (using
PluginDocument.FILE_DATA_ATTRIBUTE_NAME) |