sbc.orthoxml
Class Membership

java.lang.Object
  extended by sbc.orthoxml.Scoreable
      extended by sbc.orthoxml.Membership

public class Membership
extends Scoreable

The membership class represents a group membership of gene. The same gene object can be in multiple groups. The membership encapsulation allows to assign different scores to same gene depending on the group.

 {
        @code
        OrthoXMLReader reader = new OrthoXMLReader(myFile);
        Group group = reader.next();
 
        Map<String, ScoreDefinition> scoreDefinitions = reader
                        .getScoreDefinitions();
 
        for (Membership member : group.getMembers()) {
                //accessing the gene
                Gene gene = member.getGene();
                //accessing the scores that are assigned to gene
                List<Double> scores = member.getScore(scoreDefinitions
                                .get("myGeneScore"));
        }
 }
 

Author:
Thomas Schmitt

Constructor Summary
Membership(Gene gene)
          Creates a Membership object for Gene gene.
 
Method Summary
 Gene getGene()
          Returns the gene that this membership stands for.
 
Methods inherited from class sbc.orthoxml.Scoreable
addScore, getDefinedScores, getScores
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Membership

public Membership(Gene gene)
Creates a Membership object for Gene gene.

Parameters:
gene - the gene o be nested in the Membership
Method Detail

getGene

public Gene getGene()
Returns the gene that this membership stands for.

Returns:
gene the gene