com.compomics.util.experiment.identification.protein_inference.proteintree

Class ProteinTree

java.lang.Object

com.compomics.util.experiment.identification.protein_inference.proteintree.ProteinTree

public class ProteinTree
extends Object

This class sorts the proteins into groups.

Author:

Marc Vaudel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ProteinTree.PeptideIterator Alphabetical iterator for the tree.

Field Summary

Fields

Modifier and Type	Field and Description
static int	proteinBatchSize The number of proteins which should be imported at a time.
static String	version The version of the protein tree.

Constructor Summary

Constructors

Constructor and Description
ProteinTree(int memoryAllocation, int cacheSize) Creates a tree based on the proteins present in the sequence factory.

Method Summary

Modifier and Type	Method and Description
void	close() Closes all connections to files, tries to delete corrupted and deprecated trees.
boolean	deleteDb() Try to delete the current database.
void	emptyCache() Empties the cache.
int	getCacheSize() Returns the size of the cache used for peptide mappings (note that there are two of them).
Integer	getInitialTagSize() Returns the initial tag size of the tree.
HashMap<String,ArrayList<Integer>>	getMatchedPeptideSequences(String peptideSequence, String proteinAccession, SequenceMatchingPreferences sequenceMatchingPreferences) Returns a list of peptides matched using the given peptide sequence in the given protein according the provided matching settings.
int	getMemoryAllocation() Returns the memory allocation.
int	getNodesInCache() Returns the number of nodes currently loaded in cache.
ProteinTree.PeptideIterator	getPeptideIterator() Returns a PeptideIterator which iterates alphabetically all peptides corresponding to the end of a branch in the tree.
Integer	getProteinLength(String accession) Retrieves the length of a protein.
HashMap<String,HashMap<String,ArrayList<Integer>>>	getProteinMapping(String peptideSequence, SequenceMatchingPreferences proteinInferencePreferences) Returns the protein mapping in the sequence factory for the given peptide sequence.
HashMap<Peptide,HashMap<String,ArrayList<Integer>>>	getProteinMapping(Tag tag, TagMatcher tagMatcher, SequenceMatchingPreferences sequenceMatchingPreferences, Double massTolerance) Returns the protein mappings for the given peptide sequence.
void	initiateTree(int initialTagSize, int maxNodeSize, int maxPeptideSize, Enzyme enzyme, WaitingHandler waitingHandler, ExceptionHandler exceptionHandler, boolean printExpectedImportTime, boolean displayProgress, int nThreads) Initiates the tree.
void	initiateTree(int initialTagSize, int maxNodeSize, int maxPeptideSize, WaitingHandler waitingHandler, ExceptionHandler exceptionHandler, boolean printExpectedImportTime, boolean displayProgress, int nThreads) Initiates the tree.
void	reduceNodeCacheSize(double share) Reduces the node cache size by the given share.
void	setCacheSize(int cacheSize) Sets the size of the cache used for peptide mappings (note that there are two of them).
void	setMemoryAllocation(int memoryAllocation) Sets the memory allocation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

version

public static final String version

The version of the protein tree.

See Also:

Constant Field Values

proteinBatchSize

public static final int proteinBatchSize

The number of proteins which should be imported at a time.

See Also:

Constant Field Values

Constructor Detail

ProteinTree

public ProteinTree(int memoryAllocation,
                   int cacheSize)
            throws IOException

Creates a tree based on the proteins present in the sequence factory.

Parameters:

memoryAllocation - the number of MB available for the tree in memory.

cacheSize - the peptide queries caches size (note, there are two of them)

Throws:

IOException - if an IOException occurs

Method Detail

getMemoryAllocation

public int getMemoryAllocation()

Returns the memory allocation.

Returns:

the memory allocation

setMemoryAllocation

public void setMemoryAllocation(int memoryAllocation)

Sets the memory allocation.

Parameters:

memoryAllocation - the memory allocation

initiateTree

public void initiateTree(int initialTagSize,
                         int maxNodeSize,
                         int maxPeptideSize,
                         WaitingHandler waitingHandler,
                         ExceptionHandler exceptionHandler,
                         boolean printExpectedImportTime,
                         boolean displayProgress,
                         int nThreads)
                  throws IOException,
                         IllegalArgumentException,
                         InterruptedException,
                         ClassNotFoundException,
                         SQLException

Initiates the tree.

Parameters:

nThreads - the number of threads to use

initialTagSize - the initial tag size

maxNodeSize - the maximal size of a node. large nodes will be fast to initiate but slow to query. I typically use 500 giving an approximate query time <20ms.

maxPeptideSize - the maximum peptide size

waitingHandler - the waiting handler used to display progress to the user and cancel the process. Can be null but strongly recommended.

exceptionHandler - handler for the exceptions encountered while creating the tree

printExpectedImportTime - if true the expected import time will be printed to the waiting handler

displayProgress - display progress

Throws:

IOException - if an IOException occurs

ClassNotFoundException - if a ClassNotFoundException occurs

InterruptedException - if an InterruptedException occurs

IllegalArgumentException - if an IllegalArgumentException occurs

SQLException - if an SQLException occurs

initiateTree

public void initiateTree(int initialTagSize,
                         int maxNodeSize,
                         int maxPeptideSize,
                         Enzyme enzyme,
                         WaitingHandler waitingHandler,
                         ExceptionHandler exceptionHandler,
                         boolean printExpectedImportTime,
                         boolean displayProgress,
                         int nThreads)
                  throws IOException,
                         InterruptedException,
                         IOException,
                         InterruptedException,
                         ClassNotFoundException,
                         SQLException

Initiates the tree. Note: speed and memory are calibrated for the no enzyme case.

Parameters:

nThreads - the number of threads to use

initialTagSize - the initial size of peptide tag. Large initial size are fast to query, low initial size are fast to initiate. I typically use 3 for databases containing less than 100 000 proteins giving an approximate initiation time of 60ms per accession.

maxNodeSize - the maximal size of a node. large nodes will be fast to initiate but slow to query. I typically use 500 giving an approximate query time <20ms.

maxPeptideSize - the maximum peptide size

enzyme - the enzyme used to select peptides. If null all possible peptides will be indexed

waitingHandler - the waiting handler used to display progress to the user and cancel the process. Can be null but strongly recommended.

exceptionHandler - handler for the exceptions encountered while creating the tree

printExpectedImportTime - if true the expected import time will be printed to the waiting handler

displayProgress - display progress

Throws:

IOException - exception thrown whenever an error occurs while reading or writing a file.

ClassNotFoundException - exception thrown whenever an error occurs while deserializing an object.

InterruptedException - exception thrown whenever a threading issue occurred while creating the tree.

SQLException - if an SQLException exception thrown whenever a problem occurred while interacting with the tree database.

deleteDb

public boolean deleteDb()

Try to delete the current database. Note: The delete method will attempt to close the connection. It is thus not needed (and not advised) to close the connection before deleting.

Returns:

true of the deletion was a success

getProteinMapping

public HashMap<String,HashMap<String,ArrayList<Integer>>> getProteinMapping(String peptideSequence,
                                                                            SequenceMatchingPreferences proteinInferencePreferences)
                                                                     throws IOException,
                                                                            InterruptedException,
                                                                            ClassNotFoundException,
                                                                            SQLException

Returns the protein mapping in the sequence factory for the given peptide sequence.

Parameters:

peptideSequence - the peptide sequence

proteinInferencePreferences - the sequence matching preferences

Returns:

the peptide to protein mapping: peptide sequence > protein accession > index in the protein An empty map if not

Throws:

IOException - exception thrown whenever an error occurs while reading or writing a file.

ClassNotFoundException - exception thrown whenever an error occurs while deserializing an object.

InterruptedException - exception thrown whenever a threading issue occurred while interacting with the tree.

SQLException - if an SQLException exception thrown whenever a problem occurred while interacting with the tree database.

getProteinMapping

public HashMap<Peptide,HashMap<String,ArrayList<Integer>>> getProteinMapping(Tag tag,
                                                                             TagMatcher tagMatcher,
                                                                             SequenceMatchingPreferences sequenceMatchingPreferences,
                                                                             Double massTolerance)
                                                                      throws IOException,
                                                                             InterruptedException,
                                                                             ClassNotFoundException,
                                                                             SQLException

Returns the protein mappings for the given peptide sequence. Peptide sequence > Protein accession > Index in the protein. An empty map if not found.

Parameters:

tag - the tag to look for in the tree. Must contain a consecutive amino acid sequence of longer or equal size than the initialTagSize of the tree.

tagMatcher - the tag matcher to use

sequenceMatchingPreferences - the sequence matching preferences

massTolerance - the MS2 m/z tolerance

Returns:

the protein mapping for the given peptide sequence

Throws:

IOException - exception thrown whenever an error occurs while reading or writing a file.

ClassNotFoundException - exception thrown whenever an error occurs while deserializing an object.

InterruptedException - exception thrown whenever a threading issue occurred while interacting with the tree.

SQLException - if an SQLException exception thrown whenever a problem occurred while interacting with the tree database.

close

public void close()
           throws IOException,
                  SQLException

Closes all connections to files, tries to delete corrupted and deprecated trees.

Throws:

IOException - exception thrown whenever an error occurs while reading or writing a file.

SQLException - if an SQLException exception thrown whenever a problem occurred while interacting with the tree database.

getCacheSize

public int getCacheSize()

Returns the size of the cache used for peptide mappings (note that there are two of them).

Returns:

the size of the cache used for peptide mappings

setCacheSize

public void setCacheSize(int cacheSize)

Sets the size of the cache used for peptide mappings (note that there are two of them).

Parameters:

cacheSize - the size of the cache used for peptide mappings

emptyCache

public void emptyCache()

Empties the cache.

reduceNodeCacheSize

public void reduceNodeCacheSize(double share)

Reduces the node cache size by the given share. If less than 100 nodes are left they will all be removed.

Parameters:

share - the share of the cache to remove. 0.5 means 50%

getNodesInCache

public int getNodesInCache()

Returns the number of nodes currently loaded in cache.

Returns:

the number of nodes currently loaded in cache

getMatchedPeptideSequences

public HashMap<String,ArrayList<Integer>> getMatchedPeptideSequences(String peptideSequence,
                                                                     String proteinAccession,
                                                                     SequenceMatchingPreferences sequenceMatchingPreferences)
                                                              throws IOException,
                                                                     InterruptedException,
                                                                     ClassNotFoundException,
                                                                     SQLException

Returns a list of peptides matched using the given peptide sequence in the given protein according the provided matching settings.

Parameters:

peptideSequence - the original peptide sequence

proteinAccession - the accession of the protein of interest

sequenceMatchingPreferences - the sequence matching preferences

Returns:

a list of peptides matched and their indexes in the protein sequence

Throws:

IOException - exception thrown whenever an error occurs while reading or writing a file.

ClassNotFoundException - exception thrown whenever an error occurs while deserializing an object.

InterruptedException - exception thrown whenever a threading issue occurred while interacting with the tree.

SQLException - if an SQLException exception thrown whenever a problem occurred while interacting with the tree database.

getPeptideIterator

public ProteinTree.PeptideIterator getPeptideIterator()
                                               throws SQLException,
                                                      IOException,
                                                      ClassNotFoundException,
                                                      InterruptedException

Returns a PeptideIterator which iterates alphabetically all peptides corresponding to the end of a branch in the tree.

Returns:

a PeptideIterator which iterates alphabetically all peptides corresponding to the end of a branch in the tree

Throws:

IOException - exception thrown whenever an error occurs while reading or writing a file.

ClassNotFoundException - exception thrown whenever an error occurs while deserializing an object.

InterruptedException - exception thrown whenever a threading issue occurred while interacting with the tree.

SQLException - if an SQLException exception thrown whenever a problem occurred while interacting with the tree database.

getProteinLength

public Integer getProteinLength(String accession)
                         throws SQLException,
                                ClassNotFoundException,
                                IOException,
                                InterruptedException

Retrieves the length of a protein.

Parameters:

accession - the accession of the protein of interest

Returns:

the length of this protein

Throws:

IOException - exception thrown whenever an error occurs while reading or writing a file.

ClassNotFoundException - exception thrown whenever an error occurs while deserializing an object.

InterruptedException - exception thrown whenever a threading issue occurred while interacting with the tree.

SQLException - if an SQLException exception thrown whenever a problem occurred while interacting with the tree database.

getInitialTagSize

public Integer getInitialTagSize()
                          throws SQLException,
                                 IOException,
                                 ClassNotFoundException,
                                 InterruptedException

Returns the initial tag size of the tree.

Returns:

the initial tag size of the tree

Throws:

IOException - exception thrown whenever an error occurs while reading or writing a file.

ClassNotFoundException - exception thrown whenever an error occurs while deserializing an object.

InterruptedException - exception thrown whenever a threading issue occurred while interacting with the tree.

SQLException - if an SQLException exception thrown whenever a problem occurred while interacting with the tree database.