| 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 | Method and Description |
|---|---|
SequenceAnnotationInterval |
SequenceAnnotationInterval.adjustIntervalForGapInsertion(SequenceGapInformation sequenceGapInformation)
Creates a new interval adjusted to compensate for inserting gaps into the sequence covered by this interval.
|
SequenceAnnotationInterval |
SequenceAnnotationInterval.adjustIntervalForGapRemoval(SequenceGapInformation sequenceGapInformation)
Creates a new interval adjusted to compensate for removing gaps from the sequence covered by this interval.
|
static SequenceAnnotationInterval |
SequenceAnnotationInterval.between(int min,
int max)
Creates a zero-length SequenceAnnotationInterval between the given bases/residues with direction
SequenceAnnotationInterval.Direction.none |
SequenceAnnotationInterval |
SequenceAnnotation.getInterval()
If this annotation has exactly 1 interval gets that interval or throws an
IllegalStateException if it doesn't have exactly 1 interval. |
SequenceAnnotationInterval |
SequenceAnnotation.getInterval(int intervalIndex)
Returns one of the intervals from this annotation
|
SequenceAnnotationInterval |
SequenceAnnotationInterval.getReverse()
Returns the reverse of this interval, covering the same sequence residues but having
the opposite direction (as defined by
SequenceAnnotationInterval.Direction.reverse()). |
SequenceAnnotationInterval |
SequenceAnnotationInterval.offsetBy(int offsetDistance)
Returns a new interval offset to the right by the given distance from this interval
|
SequenceAnnotationInterval |
SequenceAnnotationInterval.reverse()
Deprecated.
use
getReverse() instead. |
SequenceAnnotationInterval |
SequenceAnnotationInterval.truncate(int minIndex,
int maxIndex)
Truncates this interval to not extend below minIndex or above maxIndex.
|
| Modifier and Type | Method and Description |
|---|---|
List<SequenceAnnotationInterval> |
SequenceAnnotation.getIntervals()
Gets all the
intervals this annotation contains. |
static List<SequenceAnnotationInterval> |
SequenceAnnotationInterval.merge(List<SequenceAnnotationInterval> _intervals)
Deprecated.
equivalent to calling
merge(intervals, true) |
static List<SequenceAnnotationInterval> |
SequenceAnnotationInterval.merge(List<SequenceAnnotationInterval> _intervals,
boolean mergeIntervalsWithDifferentDirections)
Merges a list of intervals, i.e.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SequenceAnnotation.addInterval(SequenceAnnotationInterval interval)
add a new interval to this annotation.
|
boolean |
SequenceAnnotationInterval.contains(SequenceAnnotationInterval anotherInterval)
Determines if this interval entirely covers another interval.
|
boolean |
SequenceAnnotationInterval.intersectsWith(SequenceAnnotationInterval anotherInterval)
Determines if this interval intersects with another interval.
|
boolean |
SequenceAnnotationInterval.intersectsWithInCircularSequence(SequenceAnnotationInterval anotherInterval,
int circularSequenceLength)
Determines if this interval intersects with another interval in a circular sequence.
|
void |
SequenceAnnotation.removeInterval(SequenceAnnotationInterval interval)
Removes the given interval from this annotation.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SequenceAnnotation.addIntervals(Collection<SequenceAnnotationInterval> intervalsToAdd)
adds a collection of intervals to this annotation
|
static List<SequenceAnnotationInterval> |
SequenceAnnotationInterval.merge(List<SequenceAnnotationInterval> _intervals)
Deprecated.
equivalent to calling
merge(intervals, true) |
static List<SequenceAnnotationInterval> |
SequenceAnnotationInterval.merge(List<SequenceAnnotationInterval> _intervals,
boolean mergeIntervalsWithDifferentDirections)
Merges a list of intervals, i.e.
|
void |
SequenceAnnotation.setIntervals(List<SequenceAnnotationInterval> intervals)
set the intervals on this annotation
|
| Constructor and Description |
|---|
SequenceAnnotation(String name,
String type,
SequenceAnnotationInterval... intervals)
Constructs a new SequenceAnnotation with the specified name and type.
|
SequenceAnnotationInterval(SequenceAnnotationInterval interval)
Construct a SequenceAnnotationInterval that is identical to the given parameter.
|
| Modifier and Type | Method and Description |
|---|---|
static DefaultSequenceDocument |
SequenceExtractionUtilities.extractIntervals(SequenceDocument sequence,
SequenceAnnotationInterval... intervalsToExtract)
A convenience method for extracting intervals from a sequence.
|
| Modifier and Type | Method and Description |
|---|---|
static DefaultSequenceDocument |
SequenceExtractionUtilities.extractIntervals(SequenceDocument sourceDocument,
String overrideName,
GeneticCode geneticCode,
int translationFrame,
boolean residuesOnly,
List<SequenceAnnotationInterval> intervals,
boolean allowReverseComplement,
boolean removeGaps)
|
void |
SequenceExtractionUtilities.ExtractionOptions.setIntervals(List<SequenceAnnotationInterval> intervals)
Set the intervals to extract.
|
| Constructor and Description |
|---|
SequenceExtractionUtilities.ExtractionOptions(SequenceAnnotationInterval... intervals)
Construct the extraction options from a list of intervals.
|
| Constructor and Description |
|---|
SequenceExtractionUtilities.ExtractionOptions(List<SequenceAnnotationInterval> intervals)
Construct the extraction options from a list of intervals.
|
| Modifier and Type | Method and Description |
|---|---|
SequenceAnnotationInterval |
OligoSequenceDocument.getBindingInterval()
Get the interval for the binding region of the oligo sequence (excluding any 5' extension).
|
SequenceAnnotationInterval |
OligoSequenceDocument.getExtensionInterval()
Get the interval for the 5' extension region of the oligo sequence .
|
| Modifier and Type | Method and Description |
|---|---|
abstract SequenceAnnotationInterval |
SequenceViewerExtension.SequenceAnnotationWrapper.getInterval(int intervalIndex) |
| Modifier and Type | Method and Description |
|---|---|
abstract List<SequenceAnnotationInterval> |
SequenceViewerExtension.SequenceAnnotationWrapper.getIntervals() |