softparsmap
Interface FamilyGroup

All Known Implementing Classes:

AbstractFamilyGroup

public interface FamilyGroup

This interface represents a set of gene families and it is responsible of providing these families for a certain task.

Method Summary

DataSource	getDataSource() Returns the data source that this family group is using.
java.util.Set	getFamilies() Returns the set of Family instances that this this family group is responsible for.
GeneNode	getGeneTree(java.lang.Integer familyNumber) Returns the gene tree given a family number.
java.lang.String	getGroupName() Returns the name of the family group.
PropertyFile	getPropertyFile() Returns the property file.

Method Detail

getPropertyFile

public PropertyFile getPropertyFile()

Returns the property file. Used in the family class to access the property file.

Returns:

the property file

See Also:

PropertyFile

getGroupName

public java.lang.String getGroupName()

Returns the name of the family group.

Returns:

the name of this family group

getDataSource

public DataSource getDataSource()

Returns the data source that this family group is using.

Returns:

the data source that this family is using

getFamilies

public java.util.Set getFamilies()

Returns the set of Family instances that this this family group is responsible for.

Returns:

a set of Family instances

See Also:

Family

getGeneTree

public GeneNode getGeneTree(java.lang.Integer familyNumber)

Returns the gene tree given a family number.

Returns:

the gene node which is the root of the gene tree

See Also:

GeneNode