uk.ac.sanger.cgp.standalonecsa.beans
Class VariantGroup

java.lang.Object
  extended by uk.ac.sanger.cgp.standalonecsa.beans.VariantGroup

public class VariantGroup
extends java.lang.Object

Grouping of variants for different displays. Two types are in use:
- VariantType.SUBSTITUTION_PATH
- VariantType.OTHER_PATH

Author:
Original: kr2, $Author: kr2 $

Constructor Summary
VariantGroup(VariantType type)
          Should be constructed using constants for VariantType.
 
Method Summary
 void addVariant(uk.ac.sanger.cgp.autocsa.beans.Mutation mut, uk.ac.sanger.cgp.autocsa.beans.MutationDetails mutDet)
          Adds Mutation and MutationDetails objects in a controlled manner.
 VariantType getGroupType()
          Get the VariantType of this group
 java.util.List getVarDetailsList()
          Get the list of MutationDetails objects.
 java.util.List getVariantList()
          Get the list of Mutation objects.
 int variantsInGroup()
          Get the number of variants in this group.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VariantGroup

public VariantGroup(VariantType type)
Should be constructed using constants for VariantType. Two types are in use:
- VariantType.SUBSTITUTION_PATH
- VariantType.OTHER_PATH

Parameters:
type - populate with elements of VariantType
Method Detail

addVariant

public void addVariant(uk.ac.sanger.cgp.autocsa.beans.Mutation mut,
                       uk.ac.sanger.cgp.autocsa.beans.MutationDetails mutDet)
Adds Mutation and MutationDetails objects in a controlled manner. Although MutationDetails are not used via this object they have been included as this is part of the full variant information and my be required at a later date.

Parameters:
mut - a Mutation object
mutDet - a MutationDetails object

getGroupType

public VariantType getGroupType()
Get the VariantType of this group

Returns:
the variantType of this group

getVarDetailsList

public java.util.List getVarDetailsList()
Get the list of MutationDetails objects.

Returns:
a list of MutationDetails objects

getVariantList

public java.util.List getVariantList()
Get the list of Mutation objects.

Returns:
list of Mutation objects

variantsInGroup

public int variantsInGroup()
Get the number of variants in this group.

Returns:
the number of variants in this group