Class DefaultPhylogenyDocument

All Implemented Interfaces:
ExportableDocument, PluginDocument, PluginDocument.SizeRequiredToLoadIntoMemoryProvider, Renamable, PairedReads, SequenceListSummary.Provider, EditableSameTaxaTreesDocument, SameTaxaTreesDocument, TreeDocument, XMLSerializable, XMLSerializable.OldVersionCompatible, XMLSerializableWithProgress, SequenceTrack.Manager.Provider

An implementation of a Phylogeny document.
  • Field Details

  • Constructor Details

    • DefaultPhylogenyDocument

      public DefaultPhylogenyDocument()
      XML deserialization constructor. See XMLSerializable
    • DefaultPhylogenyDocument

      public DefaultPhylogenyDocument(org.jdom.Element element, jebl.util.ProgressListener progressListener) throws XMLSerializationException
      Construct a new DefaultPhylogenyDocument from XML. This constructor can be cancelled through the use of the progress listener. Cancellation is currently only supported by Nexus document types.
      Parameters:
      element - A serialized form of a DefaultPhylogenyDocument
      progressListener - A progress listener
      Throws:
      XMLSerializationException - If the progress listener is cancelled during instantiation.
      Since:
      API 4.202600 (Geneious 2026.0.0)
    • DefaultPhylogenyDocument

      public DefaultPhylogenyDocument(org.jdom.Element element) throws XMLSerializationException
      XML deserialization constructor. See XMLSerializable
      Parameters:
      element - the previously serialized element returned from toXML().
      Throws:
      XMLSerializationException - if deserialization fails
    • DefaultPhylogenyDocument

      public DefaultPhylogenyDocument(List<? extends jebl.evolution.trees.Tree> trees, List<jebl.evolution.sequences.Sequence> inAlignedSequences, String name, String summary, AnnotatedPluginDocument alignmentDocument, boolean standardTranslation)
      Parameters:
      trees - One or more trees whose tips are sequences of the alignment; must not be null or empty
      inAlignedSequences - List of aligned sequences. Can be null if alignmentDocument is given.
      name - document name
      summary - document summary
      alignmentDocument - Alignment document which is the origin of alignedSequences (optional, i.e. may be null)
      standardTranslation - when true, taxa on tree is in fact ("1", "2", ...) and so a conversion to the actual taxa name (from the sequences) has to be applied when appropriate.
      Throws:
      IllegalArgumentException - if trees is null or empty
    • DefaultPhylogenyDocument

      public DefaultPhylogenyDocument(List<? extends jebl.evolution.trees.Tree> trees, List<jebl.evolution.sequences.Sequence> inAlignedSequences, String name, String summary, AnnotatedPluginDocument alignmentDocument, boolean standardTranslation, boolean allTreesWritable)
      Parameters:
      trees - One or more trees whose tips are sequences of the alignment; must not be null or empty
      inAlignedSequences - List of aligned sequences. Can be null if alignmentDocument is given.
      name - document name
      summary - document summary
      alignmentDocument - Alignment document which is the origin of alignedSequences (optional, i.e. may be null)
      standardTranslation - when true, taxa on tree is in fact ("1", "2", ...) and so a conversion to the actual taxa name (from the sequences) has to be applied when appropriate.
      allTreesWritable - True if the tree viewer should allow the user to modify all trees in this document (if false, only the first tree will be writable)
      Throws:
      IllegalArgumentException - if trees is null or empty
  • Method Details