org.aisb.bio.things
Class Sequence

java.lang.Object
  org.aisb.bio.things.Sequence

All Implemented Interfaces:

Collection, List

public class Sequence

extends Object

implements List

This is the basis for any implementation of any sequence. Classes and methods that work on sequences should refer to this, and not directly to the classes that extend it. It is an implementation of the List interface, which is an extension of the Collection interface. This means there are already a lot of sophisticated Java tools that will work directly on it. It also means that you ought not assume the implementations are thread safe.

There is a lot of "junk code" here. We create a ArrayList and wrap it with a bunch of methods that validate the inputs against the type of sequence we have, for inputs that would modify the contents. Very little of that code is worth looking at. However, doing this allows us to focus on adding interesting methods while preserving the List and Collection interfaces.

Of particular note is the loadFromString method. This takes a string of characters representing a sequence. It then generates an actual Sequence of the Monomers represented by those characters.

We can tighten this up a lot later on. This was just the easiest implementation for me to blast out quickly.

Author:

Doug DeJulio

Field Summary

Class

type

Constructor Summary

Sequence()

Sequence(Class monomer)

Sequence(Class monomer, String sequence)

Sequence(int count)

Method Summary

void	add(int index, Object element)
boolean	add(Object o)
boolean	addAll(Collection c)
boolean	addAll(int index, Collection c)
void	appendFromString(String input)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection c)
Object	get(int index)
String	getComment()
String	getFasta() Return this sequence in FASTA format.
Class	getType()
int	indexOf(Object o)
boolean	isEmpty()
Iterator	iterator()
int	lastIndexOf(Object o)
ListIterator	listIterator()
ListIterator	listIterator(int index)
void	loadFromString(String input) Take a string that makes sense given the type of sequence this is.
Object	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection c)
boolean	retainAll(Collection c)
Object	set(int index, Object element)
void	setComment(String comment)
void	setType(Class type) Set the type.
void	setType(String type)
int	size()
List	subList(int fromIndex, int toIndex)
Object[]	toArray()
Object[]	toArray(Object[] a)
String	toString()
void	validate(Collection c)
void	validate(Object element) This method validates every object added to the sequence.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

equals, hashCode

Field Detail

type

public Class type

Constructor Detail

Sequence

public Sequence(Class monomer)

Sequence

public Sequence(Class monomer,
                String sequence)

Sequence

public Sequence(int count)

Sequence

public Sequence()

Method Detail

getType

public Class getType()

Returns:

Returns the type.

setType

public void setType(String type)

setType

public void setType(Class type)

Set the type. This is used to validate all the elements that make up this sequence. For example, if the type is set to AminoAcid, attempts to add an object of type Nucleotide will fail. However, attempts to add elements of a subclass of AminoAcid, such as a class describing some constrained set of amino acids, will succeed. Every class used must be descended from Monomer.

Parameters:

type - The type to set.

getFasta

public String getFasta()

Return this sequence in FASTA format.

Returns:

The FASTA format version of the sequence.

getComment

public String getComment()

Returns:

Returns the comment.

setComment

public void setComment(String comment)

Parameters:

comment - The comment to set.

validate

public void validate(Object element)

This method validates every object added to the sequence. This prevents us from accidentally creating a sequence that contains both amino acids and nucleotides for example.

Parameters:

element - The element to be added to the sequence.

validate

public void validate(Collection c)

loadFromString

public void loadFromString(String input)

Take a string that makes sense given the type of sequence this is. For example, if we have a Sequence in which the type has been set to Nucleotide, the string "GATTACA" makes sense. The string is parsed and an ordered Collection of the appropriate object is created and stuffed into this Sequence's data field. In other words, we can take any sequence file and convert it into one very long string, create a new Sequence, call setType on that new Sequence to teach it what it's a sequence of, and pass that string into the loadFromString method, and we're done.

Parameters:

input -

appendFromString

public void appendFromString(String input)

toString

public String toString()

add

public void add(int index,
                Object element)

Specified by:

add in interface List

add

public boolean add(Object o)

Specified by:

add in interface List

addAll

public boolean addAll(Collection c)

Specified by:

addAll in interface List

addAll

public boolean addAll(int index,
                      Collection c)

Specified by:

addAll in interface List

clear

public void clear()

Specified by:

clear in interface List

contains

public boolean contains(Object o)

Specified by:

contains in interface List

containsAll

public boolean containsAll(Collection c)

Specified by:

containsAll in interface List

get

public Object get(int index)

Specified by:

get in interface List

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface List

iterator

public Iterator iterator()

Specified by:

iterator in interface List

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List

listIterator

public ListIterator listIterator()

Specified by:

listIterator in interface List

listIterator

public ListIterator listIterator(int index)

Specified by:

listIterator in interface List

remove

public Object remove(int index)

Specified by:

remove in interface List

remove

public boolean remove(Object o)

Specified by:

remove in interface List

removeAll

public boolean removeAll(Collection c)

Specified by:

removeAll in interface List

retainAll

public boolean retainAll(Collection c)

Specified by:

retainAll in interface List

set

public Object set(int index,
                  Object element)

Specified by:

set in interface List

size

public int size()

Specified by:

size in interface List

subList

public List subList(int fromIndex,
                    int toIndex)

Specified by:

subList in interface List

toArray

public Object[] toArray()

Specified by:

toArray in interface List

toArray

public Object[] toArray(Object[] a)

Specified by:

toArray in interface List