public class MzIdentMLIdfileReader extends Object implements IdfileReader
Modifier and Type | Class and Description |
---|---|
static class |
MzIdentMLIdfileReader.RawValueConversionType
Enum for the raw value to e-value conversion.
|
Constructor and Description |
---|
MzIdentMLIdfileReader()
Default constructor for the purpose of instantiation.
|
MzIdentMLIdfileReader(File mzIdentMLFile)
Constructor for an mzIdentML result file reader.
|
MzIdentMLIdfileReader(File mzIdentMLFile,
WaitingHandler waitingHandler)
Constructor for an mzIdentML result file reader.
|
Modifier and Type | Method and Description |
---|---|
void |
close() |
ArrayList<SpectrumMatch> |
getAllSpectrumMatches(SpectrumProvider spectrumProvider,
WaitingHandler waitingHandler,
SearchParameters searchParameters)
Retrieves all the spectrum matches from an identification file as a list
of spectrum matches, one spectrum match per spectrum.
|
ArrayList<SpectrumMatch> |
getAllSpectrumMatches(SpectrumProvider spectrumProvider,
WaitingHandler waitingHandler,
SearchParameters searchParameters,
SequenceMatchingParameters sequenceMatchingPreferences,
boolean expandAaCombinations)
Retrieves all the spectrum matches from an identification file as a list
of spectrum matches, one spectrum match per spectrum.It is very important
to close the file reader after creation.
|
String |
getExtension()
Returns the extension of the file for which this IdfileReader can be
used.
|
HashMap<String,ArrayList<String>> |
getSoftwareVersions()
Returns the names and versions of the software used to generate the
identification file in a map, e.g., Mascot > (2.2 and 2.3) and
X!Tandem > Sledgehammer (2013.09.01.1).
|
boolean |
hasDeNovoTags()
Returns a boolean indicating whether the file contains de novo results as
tags.
|
static void |
main(String[] args)
Main method for testing purposes only.
|
public MzIdentMLIdfileReader()
public MzIdentMLIdfileReader(File mzIdentMLFile) throws IOException
mzIdentMLFile
- the mzIdentML fileFileNotFoundException
- if a FileNotFoundException occursIOException
- if an IOException occurspublic MzIdentMLIdfileReader(File mzIdentMLFile, WaitingHandler waitingHandler) throws IOException
mzIdentMLFile
- the mzIdentML filewaitingHandler
- the waiting handlerFileNotFoundException
- if a FileNotFoundException occursIOException
- if an IOException occurspublic String getExtension()
IdfileReader
getExtension
in interface IdfileReader
public ArrayList<SpectrumMatch> getAllSpectrumMatches(SpectrumProvider spectrumProvider, WaitingHandler waitingHandler, SearchParameters searchParameters) throws IOException, SQLException, ClassNotFoundException, InterruptedException, JAXBException, org.xmlpull.v1.XmlPullParserException
IdfileReader
getAllSpectrumMatches
in interface IdfileReader
spectrumProvider
- A spectrum provider with the spectra of the file loaded.waitingHandler
- The waiting handler displaying the progress (can be
null). The secondary progress methods will be called.searchParameters
- The search parameters.IOException
- if an IOException occursSQLException
- if an SQLException occursClassNotFoundException
- if an\ ClassNotFoundException occursInterruptedException
- if an InterruptedException occursJAXBException
- if a JAXBException occursorg.xmlpull.v1.XmlPullParserException
- if an XmlPullParserException occurspublic ArrayList<SpectrumMatch> getAllSpectrumMatches(SpectrumProvider spectrumProvider, WaitingHandler waitingHandler, SearchParameters searchParameters, SequenceMatchingParameters sequenceMatchingPreferences, boolean expandAaCombinations) throws IOException, SQLException, ClassNotFoundException, InterruptedException, JAXBException, org.xmlpull.v1.XmlPullParserException
IdfileReader
getAllSpectrumMatches
in interface IdfileReader
spectrumProvider
- A spectrum provider with the spectra of the file loaded.waitingHandler
- The waiting handler displaying the progress (can be
null). The secondary progress methods will be called.searchParameters
- The search parameters.sequenceMatchingPreferences
- The sequence matching preferences to
use for the creation of the secondary maps.expandAaCombinations
- If true, a peptide assumption (not
implemented for tag assumptions) will be created for all possible amino
acid combination for peptide sequences containing an ambiguity like an X.IOException
- if an IOException occursSQLException
- if an SQLException occursClassNotFoundException
- if an\ ClassNotFoundException occursInterruptedException
- if an InterruptedException occursJAXBException
- if a JAXBException occursorg.xmlpull.v1.XmlPullParserException
- if an XmlPullParserException occurspublic void close() throws IOException
close
in interface IdfileReader
close
in interface AutoCloseable
IOException
public HashMap<String,ArrayList<String>> getSoftwareVersions()
IdfileReader
getSoftwareVersions
in interface IdfileReader
public boolean hasDeNovoTags()
IdfileReader
hasDeNovoTags
in interface IdfileReader
public static void main(String[] args)
args
- the command line argumentsCopyright © 2021. All rights reserved.