Used to load XTandemXML files. More...

#include <OpenMS/FORMAT/XTandemXMLFile.h>

Inheritance diagram for XTandemXMLFile:

Collaboration diagram for XTandemXMLFile:

Public Member Functions
	XTandemXMLFile ()
	Default constructor. More...

	~XTandemXMLFile () override
	Destructor. More...

void	load (const String &filename, ProteinIdentification &protein_identification, std::vector< PeptideIdentification > &id_data, ModificationDefinitionsSet &mod_def_set)
	loads data from an X! Tandem XML file More...

Public Member Functions inherited from XMLFile
	XMLFile ()
	Default constructor. More...

	XMLFile (const String &schema_location, const String &version)
	Constructor that sets the schema location. More...

virtual	~XMLFile ()
	Destructor. More...

bool	isValid (const String &filename, std::ostream &os)
	Checks if a file validates against the XML schema. More...

const String &	getVersion () const
	return the version of the schema More...

Protected Member Functions
void	startElement (const XMLCh const, const XMLCh const, const XMLCh *const qname, const xercesc::Attributes &attributes) override

void	endElement (const XMLCh const, const XMLCh const, const XMLCh *const qname) override

void	characters (const XMLCh *const chars, const XMLSize_t) override

	XTandemXMLFile (const XTandemXMLFile &rhs)

XTandemXMLFile &	operator= (const XTandemXMLFile &rhs)

Protected Member Functions inherited from XMLHandler
void	writeUserParam_ (const String &tag_name, std::ostream &os, const MetaInfoInterface &meta, UInt indent) const
	Writes the content of MetaInfoInterface to the file. More...

Int	asInt_ (const String &in) const
	Conversion of a String to an integer value. More...

Int	asInt_ (const XMLCh *in) const
	Conversion of a Xerces string to an integer value. More...

UInt	asUInt_ (const String &in) const
	Conversion of a String to an unsigned integer value. More...

double	asDouble_ (const String &in) const
	Conversion of a String to a double value. More...

float	asFloat_ (const String &in) const
	Conversion of a String to a float value. More...

bool	asBool_ (const String &in) const
	Conversion of a string to a boolean value. More...

DateTime	asDateTime_ (String date_string) const
	Conversion of a xs:datetime string to a DateTime value. More...

bool	equal_ (const XMLCh a, const XMLCh b) const
	Returns if two Xerces strings are equal. More...

SignedSize	cvStringToEnum_ (const Size section, const String &term, const char *message, const SignedSize result_on_error=0)

String	attributeAsString_ (const xercesc::Attributes &a, const char *name) const
	Converts an attribute to a String. More...

Int	attributeAsInt_ (const xercesc::Attributes &a, const char *name) const
	Converts an attribute to a Int. More...

double	attributeAsDouble_ (const xercesc::Attributes &a, const char *name) const
	Converts an attribute to a double. More...

DoubleList	attributeAsDoubleList_ (const xercesc::Attributes &a, const char *name) const
	Converts an attribute to a DoubleList. More...

IntList	attributeAsIntList_ (const xercesc::Attributes &a, const char *name) const
	Converts an attribute to an IntList. More...

StringList	attributeAsStringList_ (const xercesc::Attributes &a, const char *name) const
	Converts an attribute to an StringList. More...

bool	optionalAttributeAsString_ (String &value, const xercesc::Attributes &a, const char *name) const
	Assigns the attribute content to the String value if the attribute is present. More...

bool	optionalAttributeAsInt_ (Int &value, const xercesc::Attributes &a, const char *name) const
	Assigns the attribute content to the Int value if the attribute is present. More...

bool	optionalAttributeAsUInt_ (UInt &value, const xercesc::Attributes &a, const char *name) const
	Assigns the attribute content to the UInt value if the attribute is present. More...

bool	optionalAttributeAsDouble_ (double &value, const xercesc::Attributes &a, const char *name) const
	Assigns the attribute content to the double value if the attribute is present. More...

bool	optionalAttributeAsDoubleList_ (DoubleList &value, const xercesc::Attributes &a, const char *name) const
	Assigns the attribute content to the DoubleList value if the attribute is present. More...

bool	optionalAttributeAsStringList_ (StringList &value, const xercesc::Attributes &a, const char *name) const
	Assigns the attribute content to the StringList value if the attribute is present. More...

bool	optionalAttributeAsIntList_ (IntList &value, const xercesc::Attributes &a, const char *name) const
	Assigns the attribute content to the IntList value if the attribute is present. More...

String	attributeAsString_ (const xercesc::Attributes &a, const XMLCh *name) const
	Converts an attribute to a String. More...

Int	attributeAsInt_ (const xercesc::Attributes &a, const XMLCh *name) const
	Converts an attribute to a Int. More...

double	attributeAsDouble_ (const xercesc::Attributes &a, const XMLCh *name) const
	Converts an attribute to a double. More...

DoubleList	attributeAsDoubleList_ (const xercesc::Attributes &a, const XMLCh *name) const
	Converts an attribute to a DoubleList. More...

IntList	attributeAsIntList_ (const xercesc::Attributes &a, const XMLCh *name) const
	Converts an attribute to a IntList. More...

StringList	attributeAsStringList_ (const xercesc::Attributes &a, const XMLCh *name) const
	Converts an attribute to a StringList. More...

bool	optionalAttributeAsString_ (String &value, const xercesc::Attributes &a, const XMLCh *name) const
	Assigns the attribute content to the String value if the attribute is present. More...

bool	optionalAttributeAsInt_ (Int &value, const xercesc::Attributes &a, const XMLCh *name) const
	Assigns the attribute content to the Int value if the attribute is present. More...

bool	optionalAttributeAsUInt_ (UInt &value, const xercesc::Attributes &a, const XMLCh *name) const
	Assigns the attribute content to the UInt value if the attribute is present. More...

bool	optionalAttributeAsDouble_ (double &value, const xercesc::Attributes &a, const XMLCh *name) const
	Assigns the attribute content to the double value if the attribute is present. More...

bool	optionalAttributeAsDoubleList_ (DoubleList &value, const xercesc::Attributes &a, const XMLCh *name) const
	Assigns the attribute content to the DoubleList value if the attribute is present. More...

bool	optionalAttributeAsIntList_ (IntList &value, const xercesc::Attributes &a, const XMLCh *name) const
	Assigns the attribute content to the IntList value if the attribute is present. More...

bool	optionalAttributeAsStringList_ (StringList &value, const xercesc::Attributes &a, const XMLCh *name) const
	Assigns the attribute content to the StringList value if the attribute is present. More...

	XMLHandler (const String &filename, const String &version)
	Default constructor. More...

	~XMLHandler () override
	Destructor. More...

void	reset ()
	Release internal memory used for parsing (call. More...

void	fatalError (const xercesc::SAXParseException &exception) override

void	error (const xercesc::SAXParseException &exception) override

void	warning (const xercesc::SAXParseException &exception) override

void	fatalError (ActionMode mode, const String &msg, UInt line=0, UInt column=0) const
	Fatal error handler. Throws a ParseError exception. More...

void	error (ActionMode mode, const String &msg, UInt line=0, UInt column=0) const
	Error handler for recoverable errors. More...

void	warning (ActionMode mode, const String &msg, UInt line=0, UInt column=0) const
	Warning handler. More...

void	characters (const XMLCh *const chars, const XMLSize_t length) override
	Parsing method for character data. More...

void	startElement (const XMLCh const uri, const XMLCh const localname, const XMLCh *const qname, const xercesc::Attributes &attrs) override
	Parsing method for opening tags. More...

void	endElement (const XMLCh const uri, const XMLCh const localname, const XMLCh *const qname) override
	Parsing method for closing tags. More...

virtual void	writeTo (std::ostream &)
	Writes the contents to a stream. More...

virtual LOADDETAIL	getLoadDetail () const
	handler which support partial loading, implement this method More...

virtual void	setLoadDetail (const LOADDETAIL d)
	handler which support partial loading, implement this method More...

DataValue	cvParamToValue (const ControlledVocabulary &cv, const String &parent_tag, const String &accession, const String &name, const String &value, const String &unit_accession) const
	Convert the value of a <cvParam value=.> (as commonly found in PSI schemata) to the DataValue with the correct type (e.g. int) according to the type stored in the CV (usually PSI-MS CV), as well as set its unit. More...

DataValue	cvParamToValue (const ControlledVocabulary &cv, const CVTerm &raw_term) const
	Convert the value of a <cvParam value=.> (as commonly found in PSI schemata) to the DataValue with the correct type (e.g. int) according to the type stored in the CV (usually PSI-MS CV), as well as set its unit. More...

void	checkUniqueIdentifiers_ (const std::vector< ProteinIdentification > &prot_ids) const

Protected Member Functions inherited from XMLFile
void	parse_ (const String &filename, XMLHandler *handler)
	Parses the XML file given by `filename` using the handler given by `handler`. More...

void	parseBuffer_ (const std::string &buffer, XMLHandler *handler)
	Parses the in-memory buffer given by `buffer` using the handler given by `handler`. More...

void	save_ (const String &filename, XMLHandler *handler) const
	Stores the contents of the XML handler given by `handler` in the file given by `filename`. More...

void	enforceEncoding_ (const String &encoding)

	XMLFile ()
	Default constructor. More...

	XMLFile (const String &schema_location, const String &version)
	Constructor that sets the schema location. More...

virtual	~XMLFile ()
	Destructor. More...

bool	isValid (const String &filename, std::ostream &os)
	Checks if a file validates against the XML schema. More...

const String &	getVersion () const
	return the version of the schema More...

Private Types
enum class	GroupType { MODEL , PARAMETERS , SUPPORT }

Private Attributes
ProteinIdentification *	protein_identification_

bool	is_protein_note_

bool	is_spectrum_note_

bool	skip_protein_acc_update_

std::map< UInt, std::vector< PeptideHit > >	peptide_hits_

std::vector< ProteinHit >	protein_hits_

std::set< UInt >	protein_uids_

String	current_protein_

Int	current_charge_

UInt	current_id_

String	tag_

UInt	current_start_

UInt	current_stop_

String	previous_seq_

std::map< UInt, String >	spectrum_ids_

ModificationDefinitionsSet	mod_def_set_

ModificationDefinitionsSet	default_nterm_mods_

std::stack< GroupType >	group_type_stack_

Additional Inherited Members
Protected Types inherited from XMLHandler
enum	ActionMode { LOAD , STORE }
	Action to set the current mode (for error messages) More...

enum	LOADDETAIL { LD_ALLDATA , LD_RAWCOUNTS , LD_COUNTS_WITHOPTIONS }

Static Protected Member Functions inherited from XMLHandler
static String	writeXMLEscape (const String &to_escape)
	Escapes a string and returns the escaped string. More...

static DataValue	fromXSDString (const String &type, const String &value)
	Convert an XSD type (e.g. 'xsd:double') to a DataValue. More...

Protected Attributes inherited from XMLHandler
String	file_
	File name. More...

String	version_
	Schema version. More...

StringManager	sm_
	Helper class for string conversion. More...

std::vector< String >	open_tags_
	Stack of open XML tags. More...

LOADDETAIL	load_detail_
	parse only until total number of scans and chroms have been determined from attributes More...

std::vector< std::vector< String > >	cv_terms_
	Array of CV term lists (one sublist denotes one term and it's children) More...

Protected Attributes inherited from XMLFile
String	schema_location_
	XML schema file location. More...

String	schema_version_
	Version string. More...

String	enforced_encoding_
	Encoding string that replaces the encoding (system dependent or specified in the XML). Disabled if empty. Used as a workaround for XTandem output xml. More...

Detailed Description

Used to load XTandemXML files.

This class is used to load documents that implement the schema of XTandemXML files.

Member Enumeration Documentation

◆ GroupType

enum GroupType

strongprivate

Enumerator
MODEL
PARAMETERS
SUPPORT

Constructor & Destructor Documentation

◆ XTandemXMLFile() [1/2]

XTandemXMLFile ( )

Default constructor.

◆ ~XTandemXMLFile()

~XTandemXMLFile ( )

override

Destructor.

◆ XTandemXMLFile() [2/2]

XTandemXMLFile ( const XTandemXMLFile & rhs )

protected

Member Function Documentation

◆ characters()

void characters	(	const XMLCh *const	chars,
		const	XMLSize_t
	)

overrideprotected

◆ endElement()

void endElement	(	const XMLCh * const	,
		const XMLCh * const	,
		const XMLCh *const	qname
	)

overrideprotected

◆ operator=()

XTandemXMLFile& operator= ( const XTandemXMLFile & rhs )

protected

◆ startElement()

void startElement	(	const XMLCh * const	,
		const XMLCh * const	,
		const XMLCh *const	qname,
		const xercesc::Attributes &	attributes
	)

overrideprotected

Member Data Documentation

◆ current_charge_

Int current_charge_

private

◆ current_id_

UInt current_id_

private

◆ current_protein_

String current_protein_

private

◆ current_start_

UInt current_start_

private

◆ current_stop_

UInt current_stop_

private

◆ default_nterm_mods_

ModificationDefinitionsSet default_nterm_mods_

private

◆ group_type_stack_

std::stack<GroupType> group_type_stack_

private

◆ is_protein_note_

bool is_protein_note_

private

◆ is_spectrum_note_

bool is_spectrum_note_

private

◆ mod_def_set_

ModificationDefinitionsSet mod_def_set_

private

◆ peptide_hits_

std::map<UInt, std::vector<PeptideHit> > peptide_hits_

private

◆ previous_seq_

String previous_seq_

private

◆ protein_hits_

std::vector<ProteinHit> protein_hits_

private

◆ protein_identification_

ProteinIdentification* protein_identification_

private

◆ protein_uids_

std::set<UInt> protein_uids_

private

◆ skip_protein_acc_update_

bool skip_protein_acc_update_

private

◆ spectrum_ids_

std::map<UInt, String> spectrum_ids_

private

◆ tag_

String tag_

private

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ GroupType

Constructor & Destructor Documentation

◆ XTandemXMLFile() [1/2]

◆ ~XTandemXMLFile()

◆ XTandemXMLFile() [2/2]

Member Function Documentation

◆ characters()

◆ endElement()

◆ operator=()

◆ startElement()

Member Data Documentation

◆ current_charge_

◆ current_id_

◆ current_protein_

◆ current_start_

◆ current_stop_

◆ default_nterm_mods_

◆ group_type_stack_

◆ is_protein_note_

◆ is_spectrum_note_

◆ mod_def_set_

◆ peptide_hits_

◆ previous_seq_

◆ protein_hits_

◆ protein_identification_

◆ protein_uids_

◆ skip_protein_acc_update_

◆ spectrum_ids_

◆ tag_