com.compomics.util.experiment.quantification
Class Quantification

java.lang.Object
  extended by com.compomics.util.experiment.personalization.ExperimentObject
      extended by com.compomics.util.experiment.quantification.Quantification
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
ReporterIonQuantification

public abstract class Quantification
extends ExperimentObject

This class contains quantification results. User: Marc Date: Nov 11, 2010 Time: 3:46:24 PM

See Also:
Serialized Form

Nested Class Summary
static class Quantification.QuantificationMethod
          The implemented quantification methods.
 
Field Summary
protected  Quantification.QuantificationMethod methodUsed
          The quantification method used
protected  HashMap<String,ArrayList<String>> modifiedPeptidesQuantification
          The modified peptides quantification
protected  ArrayList<String> peptideQuantification
          The peptide quantification
protected  ArrayList<String> proteinQuantification
          The protein quantification
protected  HashMap<String,ArrayList<String>> psmIDentificationToQuantification
          A convenience map indicating all psm quantifying an identified PSM
 
Constructor Summary
Quantification()
           
 
Method Summary
 void addPeptideQuantification(PeptideQuantification match)
          Add a peptide quantification match to the peptide quantification matches map if not already implemented.
 void addProteinQuantification(ProteinQuantification match)
          Add a protein quantification match to the peptide quantification matches map if not already implemented.
 void addPsmQuantification(PsmQuantification match)
          Add a spectrum quantification to the spectrum quantification matches map and overwrites if already implemented.
 void buildPeptidesAndProteinQuantifications(Identification identification, WaitingHandler waitingHandler)
          Creates the peptides and protein quantification instances based on the identification and the psm quantification.
 void establishConnection(String dbFolder, String name, boolean deleteOldDatabase, ObjectsCache objectsCache)
          Establishes connection to the database.
 Quantification.QuantificationMethod getMethodUsed()
          getter for the method used
 ArrayList<String> getModifiedPeptideQuantification(String modificationName)
          This method retrieves the quantification result at the modified peptides level
 PeptideQuantification getPeptideMatch(String peptideKey)
          Returns a peptide quantification match
 ArrayList<String> getPeptideQuantification()
          This method retrieves the quantification result at the peptide level
 ProteinQuantification getProteinMatch(String proteinKey)
          Returns a protein quantification match
 ArrayList<String> getProteinQuantification()
          This method retrieves the quantification result at the protein level
 HashMap<String,ArrayList<String>> getPsmIDentificationToQuantification()
          This method retrieves the quantification result at the spectrum level
 PsmQuantification getSpectrumMatch(String spectrumKey)
          Returns a spectrum quantification match
 ArrayList<PsmQuantification> getSpectrumMatches(String identificationMatchKey)
          Returns a list of PSM quantification matches corresponding to the given psm identification key.
 void setMatchChanged(QuantificationMatch match)
          Indicates that a match was changed, it will thus be serialized again if needed.
 void setMethodUsed(Quantification.QuantificationMethod methodUsed)
          setter for the method used
 
Methods inherited from class com.compomics.util.experiment.personalization.ExperimentObject
addUrParam, getParameterKey, getUrParam
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

methodUsed

protected Quantification.QuantificationMethod methodUsed
The quantification method used


proteinQuantification

protected ArrayList<String> proteinQuantification
The protein quantification


peptideQuantification

protected ArrayList<String> peptideQuantification
The peptide quantification


modifiedPeptidesQuantification

protected HashMap<String,ArrayList<String>> modifiedPeptidesQuantification
The modified peptides quantification


psmIDentificationToQuantification

protected HashMap<String,ArrayList<String>> psmIDentificationToQuantification
A convenience map indicating all psm quantifying an identified PSM

Constructor Detail

Quantification

public Quantification()
Method Detail

getProteinQuantification

public ArrayList<String> getProteinQuantification()
This method retrieves the quantification result at the protein level

Returns:
quantification at the protein level

getPeptideQuantification

public ArrayList<String> getPeptideQuantification()
This method retrieves the quantification result at the peptide level

Returns:
quantification at the protein level

getModifiedPeptideQuantification

public ArrayList<String> getModifiedPeptideQuantification(String modificationName)
This method retrieves the quantification result at the modified peptides level

Parameters:
modificationName - the name of the modification
Returns:
quantification at the protein level

getPsmIDentificationToQuantification

public HashMap<String,ArrayList<String>> getPsmIDentificationToQuantification()
This method retrieves the quantification result at the spectrum level

Returns:
quantification at the protein level

getMethodUsed

public Quantification.QuantificationMethod getMethodUsed()
getter for the method used

Returns:
the method used

setMethodUsed

public void setMethodUsed(Quantification.QuantificationMethod methodUsed)
setter for the method used

Parameters:
methodUsed - the method used

getSpectrumMatches

public ArrayList<PsmQuantification> getSpectrumMatches(String identificationMatchKey)
                                                throws Exception
Returns a list of PSM quantification matches corresponding to the given psm identification key.

Parameters:
identificationMatchKey - the key of the identification match
Returns:
the desired matches
Throws:
Exception - exception thrown whenever an error occurred while retrieving the match

getSpectrumMatch

public PsmQuantification getSpectrumMatch(String spectrumKey)
                                   throws Exception
Returns a spectrum quantification match

Parameters:
spectrumKey - the key of the spectrum match
Returns:
the desired match
Throws:
Exception - exception thrown whenever an error occurred while retrieving the match

getPeptideMatch

public PeptideQuantification getPeptideMatch(String peptideKey)
                                      throws Exception
Returns a peptide quantification match

Parameters:
peptideKey - the key of the match
Returns:
the desired match
Throws:
Exception - exception thrown whenever an error occurred while retrieving the match

getProteinMatch

public ProteinQuantification getProteinMatch(String proteinKey)
                                      throws Exception
Returns a protein quantification match

Parameters:
proteinKey - the key of the match
Returns:
the desired match
Throws:
Exception - exception thrown whenever an error occurred while retrieving the match

addPsmQuantification

public void addPsmQuantification(PsmQuantification match)
                          throws Exception
Add a spectrum quantification to the spectrum quantification matches map and overwrites if already implemented.

Parameters:
match - the new spectrum match
Throws:
Exception

addPeptideQuantification

public void addPeptideQuantification(PeptideQuantification match)
                              throws Exception
Add a peptide quantification match to the peptide quantification matches map if not already implemented.

Parameters:
match - the new spectrum match
Throws:
Exception

addProteinQuantification

public void addProteinQuantification(ProteinQuantification match)
                              throws Exception
Add a protein quantification match to the peptide quantification matches map if not already implemented.

Parameters:
match - the new spectrum match
Throws:
Exception

buildPeptidesAndProteinQuantifications

public void buildPeptidesAndProteinQuantifications(Identification identification,
                                                   WaitingHandler waitingHandler)
                                            throws Exception
Creates the peptides and protein quantification instances based on the identification and the psm quantification. This operation will be extremely slow if the cache is already full.

Parameters:
identification -
waitingHandler -
Throws:
Exception

setMatchChanged

public void setMatchChanged(QuantificationMatch match)
                     throws IllegalArgumentException,
                            IOException,
                            SQLException
Indicates that a match was changed, it will thus be serialized again if needed.

Parameters:
match -
Throws:
IllegalArgumentException
IOException
SQLException

establishConnection

public void establishConnection(String dbFolder,
                                String name,
                                boolean deleteOldDatabase,
                                ObjectsCache objectsCache)
                         throws SQLException
Establishes connection to the database.

Parameters:
dbFolder - the absolute path to the folder where the database is located
deleteOldDatabase - if true, tries to delete the old database
Throws:
SQLException - exception thrown whenever an error occurred while establishing the connection


Copyright © 2012. All Rights Reserved.