Class StringProxySequenceReader<C extends Compound>
- java.lang.Object
-
- org.biojava.nbio.core.sequence.loader.StringProxySequenceReader<C>
-
- Type Parameters:
C-
- All Implemented Interfaces:
java.lang.Iterable<C>,Accessioned,ProxySequenceReader<C>,Sequence<C>,SequenceReader<C>
- Direct Known Subclasses:
GenbankProxySequenceReader
public class StringProxySequenceReader<C extends Compound> extends java.lang.Object implements ProxySequenceReader<C>
An example of a ProxySequenceReader that is created from a String. Used for testing- Author:
- Scooter Willis
-
-
Constructor Summary
Constructors Constructor Description StringProxySequenceReader()StringProxySequenceReader(java.lang.String sequence, CompoundSet<C> compoundSet)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intcountCompounds(C... compounds)Returns the number of times we found a compound in the SequenceAccessionIDgetAccession()Returns the AccessionID this location is currently bound withjava.util.List<C>getAsList()Returns the Sequence as a List of compoundsCgetCompoundAt(int position)Returns the Compound at the given biological indexCompoundSet<C>getCompoundSet()Gets the compound set used to back this SequenceintgetIndexOf(C compound)Scans through the Sequence looking for the first occurrence of the given compoundSequenceView<C>getInverse()Does the right thing to get the inverse of the current Sequence.intgetLastIndexOf(C compound)Scans through the Sequence looking for the last occurrence of the given compoundintgetLength()Returns the length of the Sequencejava.lang.StringgetSequenceAsString()Returns the String representation of the Sequencejava.lang.StringgetSequenceAsString(java.lang.Integer bioBegin, java.lang.Integer bioEnd, Strand strand)SequenceView<C>getSubSequence(java.lang.Integer bioBegin, java.lang.Integer bioEnd)Returns a portion of the sequence from the different positions.java.util.Iterator<C>iterator()voidsetCompoundSet(CompoundSet<C> compoundSet)voidsetContents(java.lang.String sequence)voidsetContents(java.lang.String sequence, java.util.ArrayList features)java.lang.StringtoString()
-
-
-
Constructor Detail
-
StringProxySequenceReader
public StringProxySequenceReader()
-
StringProxySequenceReader
public StringProxySequenceReader(java.lang.String sequence, CompoundSet<C> compoundSet) throws CompoundNotFoundException- Throws:
CompoundNotFoundException
-
-
Method Detail
-
setCompoundSet
public void setCompoundSet(CompoundSet<C> compoundSet)
- Specified by:
setCompoundSetin interfaceSequenceReader<C extends Compound>
-
setContents
public void setContents(java.lang.String sequence) throws CompoundNotFoundException- Specified by:
setContentsin interfaceSequenceReader<C extends Compound>- Throws:
CompoundNotFoundException
-
setContents
public void setContents(java.lang.String sequence, java.util.ArrayList features) throws CompoundNotFoundException- Throws:
CompoundNotFoundException
-
getLength
public int getLength()
Description copied from interface:SequenceReturns the length of the Sequence
-
getCompoundAt
public C getCompoundAt(int position)
Description copied from interface:SequenceReturns the Compound at the given biological index- Specified by:
getCompoundAtin interfaceSequence<C extends Compound>- Parameters:
position- Biological index (1 to n)- Returns:
- Compound at the specified position
-
getIndexOf
public int getIndexOf(C compound)
Description copied from interface:SequenceScans through the Sequence looking for the first occurrence of the given compound- Specified by:
getIndexOfin interfaceSequence<C extends Compound>- Parameters:
compound- Compounds to look for- Returns:
- Index of the first position of the compound in the sequence (1 to n)
-
getLastIndexOf
public int getLastIndexOf(C compound)
Description copied from interface:SequenceScans through the Sequence looking for the last occurrence of the given compound- Specified by:
getLastIndexOfin interfaceSequence<C extends Compound>- Parameters:
compound- Compounds to look for- Returns:
- Index of the last position of the compound in the sequence (1 to n)
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
getSequenceAsString
public java.lang.String getSequenceAsString()
Description copied from interface:SequenceReturns the String representation of the Sequence- Specified by:
getSequenceAsStringin interfaceSequence<C extends Compound>
-
getAsList
public java.util.List<C> getAsList()
Description copied from interface:SequenceReturns the Sequence as a List of compounds
-
getSequenceAsString
public java.lang.String getSequenceAsString(java.lang.Integer bioBegin, java.lang.Integer bioEnd, Strand strand)
-
getSubSequence
public SequenceView<C> getSubSequence(java.lang.Integer bioBegin, java.lang.Integer bioEnd)
Description copied from interface:SequenceReturns a portion of the sequence from the different positions. This is indexed from 1- Specified by:
getSubSequencein interfaceSequence<C extends Compound>- Parameters:
bioBegin- Biological index start; must be greater than 0bioEnd- Biological end; must be less than length + 1- Returns:
- A SequenceView of the offset
-
iterator
public java.util.Iterator<C> iterator()
-
getCompoundSet
public CompoundSet<C> getCompoundSet()
Description copied from interface:SequenceGets the compound set used to back this Sequence- Specified by:
getCompoundSetin interfaceSequence<C extends Compound>
-
getAccession
public AccessionID getAccession()
Description copied from interface:AccessionedReturns the AccessionID this location is currently bound with- Specified by:
getAccessionin interfaceAccessioned
-
countCompounds
public int countCompounds(C... compounds)
Description copied from interface:SequenceReturns the number of times we found a compound in the Sequence- Specified by:
countCompoundsin interfaceSequence<C extends Compound>- Parameters:
compounds- Vargs of the compounds to count- Returns:
- Number of times a compound was found
-
getInverse
public SequenceView<C> getInverse()
Description copied from interface:SequenceDoes the right thing to get the inverse of the current Sequence. This means either reversing the Sequence and optionally complementing the Sequence.- Specified by:
getInversein interfaceSequence<C extends Compound>
-
-