com.compomics.util.experiment.identification.advocates
Class SearchEngine

java.lang.Object
  extended by com.compomics.util.experiment.personalization.ExperimentObject
      extended by com.compomics.util.experiment.identification.advocates.SearchEngine
All Implemented Interfaces:
Advocate, Serializable, Cloneable

public class SearchEngine
extends ExperimentObject
implements Advocate

This class models a search engine. For now only Mascot, OMSSA and X!Tandem are implemented.

Author:
Marc Vaudel
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.compomics.util.experiment.identification.Advocate
ANDROMEDA, MASCOT, OMSSA, PEPNOVO, PEPTIDE_SHAKER, PEPTIZER, XTANDEM
 
Constructor Summary
SearchEngine()
          Constructor for a search engine.
SearchEngine(int searchEngineId)
          Constructor for a search engine.
 
Method Summary
 int getId()
          Getter for the search engine index.
 String getName()
          Getter for the search engine name.
static String getName(int id)
          Getter for the search engine name.
static boolean isAscendingScore(int id)
          Indicates whether a search engine score is increasing when the quality of the match increases.
 
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
 

Constructor Detail

SearchEngine

public SearchEngine()
Constructor for a search engine.


SearchEngine

public SearchEngine(int searchEngineId)
Constructor for a search engine.

Parameters:
searchEngineId - the search engine index
Method Detail

getName

public static String getName(int id)
Getter for the search engine name.

Parameters:
id - the id of the search engine
Returns:
the search engine name

getName

public String getName()
Getter for the search engine name.

Specified by:
getName in interface Advocate
Returns:
the search engine name

getId

public int getId()
Getter for the search engine index.

Specified by:
getId in interface Advocate
Returns:
the search engine index

isAscendingScore

public static boolean isAscendingScore(int id)
Indicates whether a search engine score is increasing when the quality of the match increases. Typically false for an e-value or a PEP, true for a confidence.

Parameters:
id - the index of the search engine according to the Advocate static fields
Returns:
true if the score is ascending, false otherwise


Copyright © 2013. All Rights Reserved.