com.compomics.util.experiment.io.massspectrometry
Class MgfIndex

java.lang.Object
  extended by com.compomics.util.experiment.personalization.ExperimentObject
      extended by com.compomics.util.experiment.io.massspectrometry.MgfIndex
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class MgfIndex
extends ExperimentObject

This class contains the indexes of an mgf file after indexing mapped with the title of the spectrum

Author:
marc
See Also:
Serialized Form

Constructor Summary
MgfIndex(java.util.HashMap<java.lang.String,java.lang.Long> indexMap, java.lang.String fileName)
          Constructor
 
Method Summary
 java.lang.String getFileName()
          Returns the name of the indexed file
 java.lang.Long getIndex(java.lang.String spectrumTitle)
          Returns the index corresponding to the desired spectrum
 java.util.HashMap<java.lang.String,java.lang.Long> getIndexes()
          Returns the index map
 
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

MgfIndex

public MgfIndex(java.util.HashMap<java.lang.String,java.lang.Long> indexMap,
                java.lang.String fileName)
Constructor

Parameters:
indexMap - map of all indexes: spectrum title -> index in the file
Method Detail

getIndex

public java.lang.Long getIndex(java.lang.String spectrumTitle)
Returns the index corresponding to the desired spectrum

Parameters:
spectrumTitle - the desired spectrum
Returns:
the corresponding index

getIndexes

public java.util.HashMap<java.lang.String,java.lang.Long> getIndexes()
Returns the index map

Returns:
the index mapF

getFileName

public java.lang.String getFileName()
Returns the name of the indexed file

Returns:
the name of the indexed file


Copyright © 2011. All Rights Reserved.