com.biomatters.geneious.publicapi.documents

Interface XMLSerializable.OldVersionCompatible

All Known Implementing Classes:

AbstractPluginDocument, AlignmentLayout, CmlDocument, CombinedAlignmentAndAminoAcidSequenceDocument, CombinedAlignmentAndNucleotideGraphSequenceDocument, CombinedAlignmentAndNucleotideSequenceDocument, CombinedAlignmentAndSequenceDocument, DefaultAlignmentDocument, DefaultAminoAcidSequence, DefaultMolecularStructureDocument, DefaultNucleotideGraphSequence, DefaultNucleotideSequence, DefaultPhylogenyDocument, DefaultSameTaxaTreesDocument, DefaultSequenceDocument, DefaultSequenceListDocument, DefaultTreeDocument, DocumentCollection, DocumentField, EValue, FolderView, GprDocument, HinDocument, ImmutableSequence, ImmutableSequenceImplementation, Interval, MolDocument, NwoDocument, OligoSequenceDocument, OperationRecordDocument, PairedReadManager, PdbDocument, Percentage, PhylogenyDocument, SequenceAnnotation, SequenceCharSequence, SequenceListOnDisk, SequenceListOnDisk.AlignmentData, SequenceListSummary, SequencePropertiesStorage, SequenceSelection, SequenceSelection.SelectionInterval, SequenceSelection.SequenceIndex, SequenceSelectionWithDocuments, SequenceSelectionWithDocuments.ExtractionStrategy, SequenceTrack.Manager, ValueAndFrequencyDistribution, XyzDocument

Enclosing interface:

XMLSerializable

public static interface XMLSerializable.OldVersionCompatible

XMLSerializable classes may implement this to indicate they support serializing to older version formats and potentially deserializing from newer version formats.

This interface should only be implemented by classes bundled with Geneious. Classes and PluginDocument implementations that aren't bundled with Geneious (for example 3rd party plugins) need to handle different version support themselves in their XML. This is because those plugins can be installed with any version of Geneious and users are able to downgrade the version of a non-bundled plugin without downgrading Geneious.

Since:

API 4.600 (Geneious 6.0.0)

Method Summary

Methods

Modifier and Type	Method and Description
Geneious.MajorVersion	getVersionSupport(XMLSerializable.VersionSupportType versionType) Gets either the latest version this class can serialize to via toXML(com.biomatters.geneious.publicapi.plugin.Geneious.MajorVersion, jebl.util.ProgressListener) or the most recent version in which the XML returned from toXML(com.biomatters.geneious.publicapi.plugin.Geneious.MajorVersion, jebl.util.ProgressListener) last changed.
org.jdom.Element	toXML(Geneious.MajorVersion majorVersion, ProgressListener progressListener) Serializes this class to XML format, potentially to a format readable by an earlier version of Geneious.

Method Detail

getVersionSupport

Geneious.MajorVersion getVersionSupport(XMLSerializable.VersionSupportType versionType)

Gets either the latest version this class can serialize to via toXML(com.biomatters.geneious.publicapi.plugin.Geneious.MajorVersion, jebl.util.ProgressListener) or the most recent version in which the XML returned from toXML(com.biomatters.geneious.publicapi.plugin.Geneious.MajorVersion, jebl.util.ProgressListener) last changed.

Parameters:

versionType - specifies which version property to return

Returns:

the major version of Geneious corresponding to the versionType for this classes toXML method.

toXML

org.jdom.Element toXML(Geneious.MajorVersion majorVersion,
                     ProgressListener progressListener)

Serializes this class to XML format, potentially to a format readable by an earlier version of Geneious. It is acceptable for the XML to include unnecessary tags that will be ignored by the earlier version. For example if the implementation has only extended the XML since the earlier version, then the XML returned may be identical to the XML returned for the current version.

See XMLSerializable.toXML() for a more detailed description of what it means to serialize to XML.

All classes that implement this method must also implement XMLSerializable.toXML() and should delegate back to this method using Geneious.getMajorVersion() and ProgressListener.EMPTY as parameters.

Parameters:

majorVersion - the major version of Geneious to serialize to XML for. For example "6.0" but not "6.0.0". This must be a version returned greater or equal to a version returned from getVersionSupport(VersionSupportType.OldestVersionSerializableTo) and must never be greater than the current version (Geneious.getMajorVersion())

progressListener - for reporting progress and cancelling

Returns:

object encoded as a JDOM element

Throws:

RuntimeException - whose cause is a XMLSerializationException if the serializable class is a PluginDocument and it is unable to serialize to a temporary file using PluginDocument.FILE_DATA_ATTRIBUTE_NAME.