Uses of Interface
org.biojava3.core.sequence.template.Compound
Packages that use Compound
Package
Description
-
Uses of Compound in bacnet.reader
Classes in bacnet.reader with type parameters of type CompoundModifier and TypeClassDescriptionclass
FastaFileReader<S extends Sequence<?>,
C extends Compound> class
NCBIFastaHeaderParser<S extends AbstractSequence<C>,
C extends Compound> My own implementation of a FastaHeaderParserInterface to parse Fasta files from NCBI ftp NCBI fna (genome and plasmids) gi|gi-number|ref|accession|name gi|16802048|ref|NC_003210.1| Listeria monocytogenes EGD-e, complete genome NCBI ffn (coding) ref|refGenome gi-number|:start-end name ref|NC_003210.1|:318-1673 chromosomal replication initiation protein [Listeria monocytogenes EGD-e] NCBI frn (non-coding) ref|refGenome gi-number|:start-end| name| [locus-tag] ref|NC_003210|:82705-82777|Lys tRNA| [locus_tag=lmot01] NCBI faa (proteins) gi|gi-number|ref|accession|name gi|16802049|ref|NP_463534.1| chromosomal replication initiation protein [Listeria monocytogenes EGD-e] -
Uses of Compound in org.biojava3.core.sequence
Classes in org.biojava3.core.sequence with type parameters of type CompoundModifier and TypeClassDescriptionclass
BasicSequence<C extends Compound>
Bare bones version of the Sequence object to be used sparingly.class
MultipleSequenceAlignment<S extends Sequence<C>,
C extends Compound> Implements a minimal data structure for reading and writing a sequence alignment. -
Uses of Compound in org.biojava3.core.sequence.compound
Classes in org.biojava3.core.sequence.compound that implement CompoundModifier and TypeClassDescriptionclass
Used to describe an Amino Acid.class
Define a codonclass
Methods in org.biojava3.core.sequence.compound with parameters of type CompoundModifier and TypeMethodDescriptionboolean
AminoAcidCompound.equalsIgnoreCase
(Compound compound) boolean
CodonCompound.equalsIgnoreCase
(Compound compound) boolean
NucleotideCompound.equalsIgnoreCase
(Compound compound) -
Uses of Compound in org.biojava3.core.sequence.edits
Classes in org.biojava3.core.sequence.edits with type parameters of type CompoundModifier and TypeInterfaceDescriptioninterface
Interface for carrying out edit operations on a Sequence.static class
Edit.AbstractEdit<C extends Compound>
Abstract class which defines all edit operations as a call to discover what 5' and 3' ends of an editing Sequence should be joined together with a target Sequence.static class
Edit.Delete<C extends Compound>
Implementation which allows for the deletion of bases from a Sequencestatic class
Edit.Insert<C extends Compound>
Edit implementation which allows us to insert a base at any position in a Sequence.static class
Edit.Substitute<C extends Compound>
Allows for the substitution of bases into an existing Sequence. -
Uses of Compound in org.biojava3.core.sequence.features
Classes in org.biojava3.core.sequence.features with type parameters of type CompoundModifier and TypeClassDescriptionclass
AbstractFeature<S extends AbstractSequence<C>,
C extends Compound> A feature is currently any descriptive item that can be associated with a sequence position(s) A feature has a type and a source which is currently a string to allow flexibility for the user Ideally well defined features should have a class to describe attributes of that featureinterface
FeatureInterface<S extends AbstractSequence<C>,
C extends Compound> Interface class to handle describing arbitrary features.class
QualityFeature<S extends AbstractSequence<C>,
C extends Compound> DNA Sequences produced by modern sequencers usually have quality informaion attached to them.class
QuantityFeature<S extends AbstractSequence<C>,
C extends Compound> It is common to have a numerical value or values associated with a feature.class
TextFeature<S extends AbstractSequence<C>,
C extends Compound> A implmentation of AbstractFeature -
Uses of Compound in org.biojava3.core.sequence.io
Classes in org.biojava3.core.sequence.io with type parameters of type CompoundModifier and TypeClassDescriptionclass
FastaReader<S extends Sequence<?>,
C extends Compound> Use FastaReaderHelper as an example of how to use this class where FastaReaderHelper should be the primary class used to read Fasta filesclass
FastaWriter<S extends Sequence<?>,
C extends Compound> The FastaWriter writes a collection of sequences to an outputStream.class
GenericFastaHeaderFormat<S extends AbstractSequence<?>,
C extends Compound> We store the original header if the sequence is parsed from a fasta file and will use that exact sequence if we write out the sequences to a fasta file.class
GenericFastaHeaderParser<S extends AbstractSequence<C>,
C extends Compound> The default fasta header parser where some headers are well defined based on the source database which allows us to set the source of the protein sequence and the identifier that can be used in future implementations to load features from external sources If the user has a custom header with local data then they can create their own implementation of a FastaHeaderParserInterface GenBank gi|gi-number|gb|accession|locus ENA Data Library gi|gi-number|emb|accession|locus DDBJ, DNA Database of Japan gi|gi-number|dbj|accession|locus NBRF PIR pir||entry Protein Research Foundation prf||name SWISS-PROT sp|accession|name Brookhaven Protein Data Bank (1) pdb|entry|chain Brookhaven Protein Data Bank (2) entry:chain|PDBID|CHAIN|SEQUENCE PDB EBI PDB:1ECY_A mol:protein length:142 ECOTIN Patents pat|country|number GenInfo Backbone Id bbs|number General database identifier gnl|database|identifier NCBI Reference Sequence ref|accession|locus Local Sequence identifier lcl|identifier -
Uses of Compound in org.biojava3.core.sequence.io.template
Classes in org.biojava3.core.sequence.io.template with type parameters of type CompoundModifier and TypeInterfaceDescriptioninterface
FastaHeaderFormatInterface<S extends Sequence<?>,
C extends Compound> interface
FastaHeaderParserInterface<S extends Sequence<?>,
C extends Compound> interface
SequenceCreatorInterface<C extends Compound>
-
Uses of Compound in org.biojava3.core.sequence.io.util
Methods in org.biojava3.core.sequence.io.util with type parameters of type CompoundModifier and TypeMethodDescriptionIOUtils.getGCGChecksum
(List<S> sequences) Calculates GCG checksum for entire list of sequencesIOUtils.getGCGChecksum
(S sequence) Calculates GCG checksum for a given sequenceIOUtils.getGCGHeader
(List<S> sequences) Assembles a GCG file headerIOUtils.getGCGType
(CompoundSet<C> cs) Determines GCG typeIOUtils.getIDFormat
(List<S> sequences) Creates format String for accession IDs -
Uses of Compound in org.biojava3.core.sequence.loader
Classes in org.biojava3.core.sequence.loader with type parameters of type CompoundModifier and TypeClassDescriptionclass
ArrayListProxySequenceReader<C extends Compound>
class
SequenceFileProxyLoader<C extends Compound>
This class represents the storage container of a sequence stored in a fasta file where the initial parsing of the file we store the offset and length of the sequence.class
StringProxySequenceReader<C extends Compound>
An example of a ProxySequenceReader that is created from a String.class
UniprotProxySequenceReader<C extends Compound>
Pass in a Uniprot ID and this ProxySequenceReader when passed to a ProteinSequence will get the sequence data and other data elements associated with the ProteinSequence by Uniprot.Methods in org.biojava3.core.sequence.loader with parameters of type CompoundModifier and TypeMethodDescriptionint
SequenceFileProxyLoader.countCompounds
(C... compounds) int
StringProxySequenceReader.countCompounds
(C... compounds) int
UniprotProxySequenceReader.countCompounds
(C... compounds) -
Uses of Compound in org.biojava3.core.sequence.location
Classes in org.biojava3.core.sequence.location with type parameters of type CompoundModifier and TypeClassDescriptionclass
SequenceLocation<S extends AbstractSequence<C>,
C extends Compound> A location in a sequence that keeps a reference to its parent sequence -
Uses of Compound in org.biojava3.core.sequence.location.template
Methods in org.biojava3.core.sequence.location.template with type parameters of type CompoundModifier and TypeMethodDescriptionAbstractLocation.getRelevantSubSequence
(Sequence<C> sequence) Location.getRelevantSubSequence
(Sequence<C> sequence) Will return a SequenceReader object which offers a view of all resolved locations i.e. those locations which are not complex and define the true Sequence representedAbstractLocation.getSubSequence
(Sequence<C> sequence) If circular this will return the sequence represented by the sub locations joined.Location.getSubSequence
(Sequence<C> sequence) Will return a SequenceReader object which represents the outer bounds of this LocationMethods in org.biojava3.core.sequence.location.template that return types with arguments of type CompoundModifier and TypeMethodDescriptionProxySequenceReader<? extends Compound>
AccesionedLocation.getProxySequenceReader()
Return the proxy reader used to get sequence for this location. -
Uses of Compound in org.biojava3.core.sequence.storage
Classes in org.biojava3.core.sequence.storage with type parameters of type CompoundModifier and TypeClassDescriptionclass
ArrayListSequenceReader<C extends Compound>
Stores a Sequence as a collection of compounds in an ArrayListclass
BitSequenceReader<C extends Compound>
An implementation of the popular bit encodings.static class
BitSequenceReader.BitArrayWorker<C extends Compound>
The logic of working with a bit has been separated out into this class to help developers create the bit data structures without having to put the code into an intermediate format and to also use the format without the need to copy this code.class
FourBitSequenceReader<C extends Compound>
Four bit encoding of the bit formats.static class
FourBitSequenceReader.FourBitArrayWorker<C extends Compound>
A four bit per compound implementation of the bit array worker code.class
JoiningSequenceReader<C extends Compound>
This reader actually proxies onto multiple types of sequence in order to allow a number of sequence objects to act as if they are one sequence.class
SequenceAsStringHelper<C extends Compound>
This is a common method that can be used across multiple storage/proxy implementations to handle Negative strand and other interesting elements of sequence data.class
SingleCompoundSequenceReader<C extends Compound>
An implementation of the SequenceReader interface which for every call will return only 1 compound (given to it during construction; a String is also valid but will require a CompoundSet).Methods in org.biojava3.core.sequence.storage with parameters of type CompoundModifier and TypeMethodDescriptionint
ArrayListSequenceReader.countCompounds
(C... compounds) int
BitSequenceReader.countCompounds
(C... compounds) Counts the number of times a compound appears in this sequence storeint
JoiningSequenceReader.countCompounds
(C... compounds) int
SingleCompoundSequenceReader.countCompounds
(C... compounds) Delegates toSequenceMixin#countCompounds(org.biojava3.core.sequence.template.Sequence, C[])
-
Uses of Compound in org.biojava3.core.sequence.template
Classes in org.biojava3.core.sequence.template with type parameters of type CompoundModifier and TypeClassDescriptionclass
AbstractCompoundSet<C extends Compound>
class
AbstractCompoundTranslator<F extends Compound,
T extends Compound> class
AbstractCompoundTranslator<F extends Compound,
T extends Compound> class
AbstractSequence<C extends Compound>
The base class for DNA, RNA and Protein sequences.interface
CompoundSet<C extends Compound>
interface
CompoundTranslator<F extends Compound,
T extends Compound> interface
CompoundTranslator<F extends Compound,
T extends Compound> interface
LightweightProfile<S extends Sequence<C>,
C extends Compound> Defines a minimal data structure for reading and writing a sequence alignment.interface
ProxySequenceReader<C extends Compound>
interface
Main interface for defining a collection of Compounds and accessing them using biological indexesstatic class
SequenceMixin.SequenceIterator<C extends Compound>
A basic sequence iterator which iterates over the given Sequence by biological index.class
SequenceProxyView<C extends Compound>
interface
SequenceReader<C extends Compound>
interface
SequenceView<C extends Compound>
Subinterfaces of Compound in org.biojava3.core.sequence.templateClasses in org.biojava3.core.sequence.template that implement CompoundMethods in org.biojava3.core.sequence.template with type parameters of type CompoundModifier and TypeMethodDescriptionPerforms a simple CRC64 checksum on any given sequence.static <C extends Compound>
intSequenceMixin.countCompounds
(Sequence<C> sequence, C... compounds) For the given vargs of compounds this method counts the number of times those compounds appear in the given sequenceSequenceMixin.createIterator
(Sequence<C> sequence) Creates a simple sequence iterator which moves through a sequence going from 1 to the length of the Sequence.static <C extends Compound>
SequenceView<C>SequenceMixin.createSubSequence
(Sequence<C> sequence, int start, int end) Creates a simple sub sequence view delimited by the given start and end.SequenceMixin.getComposition
(Sequence<C> sequence) Does a linear scan over the given Sequence and records the number of times each base appears.SequenceMixin.getDistribution
(Sequence<C> sequence) Analogous toSequenceMixin.getComposition(Sequence)
but returns the distribution of thatCompound
over the given sequence.static <C extends Compound>
intPerforms a linear search of the given Sequence for the given compound.static <C extends Compound>
SequenceView<C>A method which attempts to do the right thing when is comes to a reverse/reverse complementstatic <C extends Compound>
intSequenceMixin.lastIndexOf
(Sequence<C> sequence, C compound) Performs a reversed linear search of the given Sequence by wrapping it in aReversedSequenceView
and passing it intoSequenceMixin.indexOf(Sequence, Compound)
.static <C extends Compound>
List<SequenceView<C>>SequenceMixin.nonOverlappingKmers
(Sequence<C> sequence, int kmer) Produces kmers of the specified size e.g.static <C extends Compound>
List<SequenceView<C>>SequenceMixin.overlappingKmers
(Sequence<C> sequence, int kmer) Used to generate overlapping k-mers such i.e.static <C extends Compound>
booleanSequenceMixin.sequenceEquality
(Sequence<C> source, Sequence<C> target) A case-sensitive manner of comparing two sequence objects together.static <C extends Compound>
booleanSequenceMixin.sequenceEqualityIgnoreCase
(Sequence<C> source, Sequence<C> target) A case-insensitive manner of comparing two sequence objects together.Implements sequence shuffling by first materializing the givenSequence
into aList
, applyingCollections.shuffle(List)
and then returning the shuffled elements in a new instance ofSequenceBackingStore
which behaves as aSequence
.Shortcut toSequenceMixin.toStringBuilder(org.biojava3.core.sequence.template.Sequence)
which calls toString() on the resulting object.static <C extends Compound>
StringBuilderSequenceMixin.toStringBuilder
(Sequence<C> sequence) For the given Sequence this will return aStringBuilder
object filled with the results ofCompound#toString()
.static <C extends Compound>
voidSequenceMixin.write
(Appendable appendable, Sequence<C> sequence) Used as a way of sending a Sequence to a writer without the cost of converting to a full length String and then writing the data outMethods in org.biojava3.core.sequence.template with parameters of type CompoundModifier and TypeMethodDescriptionint
AbstractSequence.countCompounds
(C... compounds) int
Sequence.countCompounds
(C... compounds) Returns the number of times we found a compound in the Sequencestatic <C extends Compound>
intSequenceMixin.countCompounds
(Sequence<C> sequence, C... compounds) For the given vargs of compounds this method counts the number of times those compounds appear in the given sequenceint
SequenceProxyView.countCompounds
(C... compounds) boolean
AbstractCompound.equalsIgnoreCase
(Compound compound) boolean
Compound.equalsIgnoreCase
(Compound compound) -
Uses of Compound in org.biojava3.core.sequence.transcription
Classes in org.biojava3.core.sequence.transcription that implement CompoundModifier and TypeClassDescriptionclass
Attempts to wrap compounds so it is possible to view them in a case insensitive mannerstatic class
Instance of a Codon which is 3NucleotideCompound
s, its correspondingAminoAcidCompound
and if it is a start or stop codon.Methods in org.biojava3.core.sequence.transcription with parameters of type CompoundModifier and TypeMethodDescriptionboolean
CaseInsensitiveCompound.equalsIgnoreCase
(Compound compound) boolean
Table.Codon.equalsIgnoreCase
(Compound compound) -
Uses of Compound in org.biojava3.core.sequence.views
Classes in org.biojava3.core.sequence.views with type parameters of type CompoundModifier and TypeClassDescriptionclass
ReversedSequenceView<C extends Compound>
For a given sequence this class will return the base at the reversed position i.e. in a sequence of size 10, if you request base 2 you will get back the base at position 9.class
WindowedSequence<C extends Compound>
A sliding window view of a sequence which does not implement any interfaces likeSequence
because they do not fit how this works.