| Package | Description |
|---|---|
| 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.plugin |
Provides the
GeneiousPlugin interface and plugin
related interfaces. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ChromatogramDocument
Deprecated.
Check for instanceof
NucleotideGraphSequenceDocument instead. |
interface |
EditableNucleotideGraphSequenceDocument
A mutable nucleotide sequence with residue graph.
|
interface |
ExtendedNucleotideGraph
Provides an extended interface to a
NucleotideGraph. |
static interface |
NucleotideGraph.ImmutableGraphProvider
An interface a NucleotideGraph may implement to indicate it can provide an immutable instance of itself.
|
interface |
NucleotideGraphSequenceDocument
A nucleotide sequence with an underlying "graph".
|
| Modifier and Type | Class and Description |
|---|---|
class |
CompactQualityOnlyGraph
A memory efficient nucleotide graph that only supports quality values in the range 0->256 and does not support traces.
|
class |
DefaultNucleotideGraph
A
NucleotideGraph that stores its values in int[] arrays internally,
and allows getting and setting those arrays. |
| Modifier and Type | Method and Description |
|---|---|
static NucleotideGraph |
DefaultNucleotideGraph.createNucleotideGraph(int[][] chromatogramValues,
int[] chromatogramPositionsForResidues,
int[] sequenceQualities,
int sequenceLength,
int chromatogramLength)
Creates a new nucleotide graph.
|
static NucleotideGraph |
DefaultNucleotideGraph.createNucleotideGraph(int[][] chromatogramValues,
int[] chromatogramPositionsForResidues,
int[] sequenceQualities,
int sequenceLength,
int chromatogramLength,
int leadingGapsLength,
int trailingGapsLength)
Creates a new nucleotide graph.
|
static NucleotideGraph |
DefaultNucleotideGraph.createNucleotideGraph(int[] internalQualities,
int leadingGapsLength,
int trailingGapsLength)
Creates a new nucleotide graph with qualities but no traces.
|
static NucleotideGraph |
DefaultNucleotideGraph.createNucleotideGraph(NucleotideGraph graphToCopy)
Creates a deep copy of the given graph.
|
| Modifier and Type | Method and Description |
|---|---|
static DefaultNucleotideGraph |
DefaultNucleotideGraph.copyOf(NucleotideGraph graph)
Creates a copy of the given graph.
|
static NucleotideGraph |
DefaultNucleotideGraph.createNucleotideGraph(NucleotideGraph graphToCopy)
Creates a deep copy of the given graph.
|
static ExtendedNucleotideGraph |
DefaultNucleotideGraph.createNucleotideGraphAdjustedForGapInsertion(NucleotideGraph graphToCopy,
CharSequence charSequence)
Creates a deep copy of the given graph with all graph values adjusted to compensate for gap insertion as indicated by the presense of gaps in charSequence.
|
ImmutableSequence |
ImmutableSequence.Builder.createNucleotideGraphSequence(String name,
CharSequence charSequence,
NucleotideGraph nucleotideGraph)
Creates a nucleotide graph sequence compacted to use as little memory as possible
|
static int[] |
DefaultNucleotideGraph.getChromatogramPositionsForResidues(NucleotideGraph graph)
Equivalent to calling
getChromatogramPositionsForResidues(graph,0,graph.getSequenceLength()) |
static int[] |
DefaultNucleotideGraph.getChromatogramPositionsForResidues(NucleotideGraph graph,
int startIndex,
int endIndex)
Get all the values returned from
getChromatogramPositionForResidue(int) for all
residues indices in the range startIndex (inclusive) to endIndex (exclusive). |
static int[][] |
DefaultNucleotideGraph.getChromatogramValues(NucleotideGraph graph) |
static int[] |
DefaultNucleotideGraph.getChromatogramValues(NucleotideGraph graph,
int i) |
static int[] |
DefaultNucleotideGraph.getSequenceQualities(NucleotideGraph graph)
Equivalent to calling
getSequenceQualities(graph,0,graph.getSequenceLength()) |
static int[] |
DefaultNucleotideGraph.getSequenceQualities(NucleotideGraph graph,
int startIndex,
int endIndex)
Get all the values returned from
getSequenceQuality(int) for all
residues indices in the range startIndex (inclusive) to endIndex (exclusive). |
static ExtendedNucleotideGraph |
DefaultNucleotideGraph.reverseComplement(NucleotideGraph graphToReverseComplement)
Creates a new graph that is the reverse complement of the given graph.
|
void |
EditableNucleotideGraphSequenceDocument.setSequenceAndAnnotationsAndGraph(CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph)
Replaces
EditableSequenceDocument.setSequenceAndAnnotations(CharSequence,java.util.List)
which you must not call on a NucleotideGraphSequenceDocument. |
void |
SequenceAlignmentDocument.updateSequence(int index,
CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph,
boolean allowModifyingReferencedDocuments)
Set new residues and related data for one sequence.
|
static void |
DefaultNucleotideGraph.writeObject(DataOutput out,
NucleotideGraph graph)
Equivalent to
writeObject(Geneious.getMajorVersion(), out, graph) |
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). |
static void |
DefaultNucleotideGraph.writeObject(GeneiousObjectOutputStream 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(GeneiousObjectInputStream). |
| Modifier and Type | Method and Description |
|---|---|
void |
DefaultAlignmentDocument.updateSequence(int index,
CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph,
boolean allowModifyingOriginals) |
void |
DefaultPhylogenyDocument.updateSequence(int index,
CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph,
boolean allowModifyingOriginals) |
| Modifier and Type | Class and Description |
|---|---|
class |
CombinedAlignmentAndNucleotideGraphSequenceDocument
See documentation at
CombinedAlignmentAndSequenceDocument |
class |
DefaultNucleotideGraphSequence
An implementation of an editable chromatogram.
|
class |
SequencePropertiesStorage
Provides supporting functionality for sequence classes that need to store
various sequence properties and serialise those to XML.
|
| Modifier and Type | Method and Description |
|---|---|
NucleotideGraph |
SequencePropertiesStorage.getGraph() |
| Modifier and Type | Method and Description |
|---|---|
void |
SequencePropertiesStorage.fromXML(org.jdom.Element root,
NucleotideGraph overriddenGraph)
Deprecated.
|
void |
CombinedAlignmentAndNucleotideGraphSequenceDocument.setSequenceAndAnnotationsAndGraph(CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph) |
void |
DefaultNucleotideGraphSequence.setSequenceAndAnnotationsAndGraph(CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph) |
void |
SequencePropertiesStorage.setSequenceAndAnnotationsAndGraph(CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph)
|
void |
CombinedAlignmentAndSequenceDocument.updateSequence(int index,
CharSequence sequence,
List<SequenceAnnotation> annotations,
NucleotideGraph graph,
boolean allowModifyingReferencedDocuments) |
| Constructor and Description |
|---|
DefaultNucleotideGraphSequence(String name,
String description,
CharSequence charSequence,
Date created,
NucleotideGraph graph)
Create a DefaultNucleotideGraphSequence from any chromatogram.
|
DefaultNucleotideGraphSequence(String name,
String description,
CharSequence charSequence,
Date created,
NucleotideGraph graph,
URN urn)
Create a DefaultNucleotideGraphSequence from any chromatogram.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SequenceGraph.setResidues(List<CharSequence> sequences,
List<NucleotideGraph> nucleotideGraphs,
boolean ignoreEndGaps)
Sets the residues of the sequence or alignment document that the graph applies to.
|