org.biojava.bio.program.homologene
Interface OrthologueSet

All Known Implementing Classes:

AbstractOrthologueSet

public interface OrthologueSet

Interface for classes that store and manipulate orthologues.

You cannot create Orthologues here, just work with them.

Author:

David Huen * @author Matthew Pocock

Nested Class Summary

static interface

OrthologueSet.Iterator An iterator for the contents of an OrthologueSet.

Field Summary

static ChangeType

MODIFY

Method Summary

void	addOrthologue(Orthologue ortho) Add an orthologue to the set.
OrthologueSet	filter(OrthologueFilter filter) Filter the contents of a set.
Orthologue	getOrthologue(String homologeneID)
OrthologueSet.Iterator	iterator() Return an iterator to the contents of the set.
void	removeOrthologue(Orthologue ortho) Remove an orthologue from the set.

Field Detail

MODIFY

public static final ChangeType MODIFY

Method Detail

getOrthologue

public Orthologue getOrthologue(String homologeneID)

addOrthologue

public void addOrthologue(Orthologue ortho)
                   throws ChangeVetoException

Add an orthologue to the set.

Throws:

ChangeVetoException

removeOrthologue

public void removeOrthologue(Orthologue ortho)
                      throws ChangeVetoException

Remove an orthologue from the set.

Throws:

ChangeVetoException

iterator

public OrthologueSet.Iterator iterator()

Return an iterator to the contents of the set.

filter

public OrthologueSet filter(OrthologueFilter filter)

Filter the contents of a set.