This class provides Input/Output functionality for feature maps. More...

#include <OpenMS/FORMAT/FeatureXMLFile.h>

Inheritance diagram for FeatureXMLFile:

Collaboration diagram for FeatureXMLFile:

Protected Attributes
temporary data structures to hold parsed data
Param	param_

ConvexHull2D::PointArrayType	current_chull_

DPosition< 2 >	hull_position_

UInt	dim_
	current dimension of the feature position, quality, or convex hull point More...

bool	in_description_
	for downward compatibility, all tags in the old description must be ignored More...

Int	subordinate_feature_level_
	level in Feature stack during parsing More...

MetaInfoInterface *	last_meta_
	Pointer to last read object as a MetaInfoInterface, or null. More...

ProteinIdentification	prot_id_
	Temporary protein ProteinIdentification. More...

PeptideIdentification	pep_id_
	Temporary peptide ProteinIdentification. More...

ProteinHit	prot_hit_
	Temporary protein hit. More...

PeptideHit	pep_hit_
	Temporary peptide hit. More...

Map< String, String >	proteinid_to_accession_
	Map from protein id to accession. More...

Map< String, Size >	accession_to_id_
	Map from search identifier concatenated with protein accession to id. More...

Map< String, String >	identifier_id_
	Map from identification run identifier to file xs:id (for linking peptide identifications to the corresponding run) More...

Map< String, String >	id_identifier_
	Map from file xs:id to identification run identifier (for linking peptide identifications to the corresponding run) More...

ProteinIdentification::SearchParameters	search_param_
	Temporary search parameters file. More...

Protected Attributes inherited from XMLHandler
String	error_message_
	Error message of the last error. More...

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...

Protected Attributes inherited from ProgressLogger
LogType	type_

time_t	last_invoke_

ProgressLoggerImpl *	current_logger_

Constructors and Destructor
Int	disable_parsing_

Feature *	current_feature_
	points to the last open <feature> tag (possibly a subordinate feature) More...

FeatureMap *	map_
	Feature map pointer for reading. More...

FeatureFileOptions	options_
	Options that can be set. More...

bool	size_only_
	only parse until "count" tag is reached (used in loadSize()) More...

Size	expected_size_
	holds the putative size given in count More...

	FeatureXMLFile ()
	Default constructor. More...

	~FeatureXMLFile () override
	Destructor. More...

void	load (const String &filename, FeatureMap &feature_map)
	loads the file with name `filename` into `map` and calls updateRanges(). More...

Size	loadSize (const String &filename)

void	store (const String &filename, const FeatureMap &feature_map)
	stores the map `feature_map` in file with name `filename`. More...

FeatureFileOptions &	getOptions ()
	Mutable access to the options for loading/storing. More...

const FeatureFileOptions &	getOptions () const
	Non-mutable access to the options for loading/storing. More...

void	setOptions (const FeatureFileOptions &)
	setter for options for loading/storing More...

void	resetMembers_ ()

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

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

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

void	writeFeature_ (const String &filename, std::ostream &os, const Feature &feat, const String &identifier_prefix, UInt64 identifier, UInt indentation_level)
	Writes a feature to a stream. More...

void	writePeptideIdentification_ (const String &filename, std::ostream &os, const PeptideIdentification &id, const String &tag_name, UInt indentation_level)
	Writes a peptide identification to a stream (for assigned/unassigned peptide identifications) More...

void	updateCurrentFeature_ (bool create)
	update the pointer to the current feature More...

Additional Inherited Members
Public Types inherited from ProgressLogger
enum	LogType { CMD, GUI, NONE }
	Possible log types. 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...

Public Member Functions inherited from ProgressLogger
	ProgressLogger ()
	Constructor. More...

	~ProgressLogger ()
	Destructor. More...

	ProgressLogger (const ProgressLogger &other)
	Copy constructor. More...

ProgressLogger &	operator= (const ProgressLogger &other)
	Assignment Operator. More...

void	setLogType (LogType type) const
	Sets the progress log that should be used. The default type is NONE! More...

LogType	getLogType () const
	Returns the type of progress log being used. More...

void	startProgress (SignedSize begin, SignedSize end, const String &label) const
	Initializes the progress display. More...

void	setProgress (SignedSize value) const
	Sets the current progress. More...

void	endProgress () const
	Ends the progress display. More...

void	nextProgress () const
	increment progress by 1 (according to range begin-end) More...

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 }

Protected Types inherited from ProgressLogger
enum	LogType { CMD, GUI, NONE }
	Possible log types. More...

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)
	Conversion of a String to an integer value. More...

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

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

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

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

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

DateTime	asDateTime_ (String date_string)
	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...

String	errorString ()
	Returns the last error description. 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...

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

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...

Protected Member Functions inherited from ProgressLogger
	ProgressLogger ()
	Constructor. More...

	~ProgressLogger ()
	Destructor. More...

	ProgressLogger (const ProgressLogger &other)
	Copy constructor. More...

ProgressLogger &	operator= (const ProgressLogger &other)
	Assignment Operator. More...

void	setLogType (LogType type) const
	Sets the progress log that should be used. The default type is NONE! More...

LogType	getLogType () const
	Returns the type of progress log being used. More...

void	startProgress (SignedSize begin, SignedSize end, const String &label) const
	Initializes the progress display. More...

void	setProgress (SignedSize value) const
	Sets the current progress. More...

void	endProgress () const
	Ends the progress display. More...

void	nextProgress () const
	increment progress by 1 (according to range begin-end) More...

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

Static Protected Member Functions inherited from ProgressLogger
static String	logTypeToFactoryName_ (LogType type)
	Return the name of the factory product used for this log type. More...

Static Protected Attributes inherited from ProgressLogger
static int	recursion_depth_

Detailed Description

This class provides Input/Output functionality for feature maps.

A documented schema for this format can be found at https://github.com/OpenMS/OpenMS/tree/develop/share/OpenMS/SCHEMAS

Todo:: Take care that unique ids are assigned properly by TOPP tools before calling FeatureXMLFile::store(). There will be a message on OPENMS_LOG_INFO but we will make no attempt to fix the problem in this class. (all developers)

Note: This format will eventually be replaced by the HUPO-PSI AnalysisXML (mzIdentML and mzQuantML) formats!

Constructor & Destructor Documentation

◆ FeatureXMLFile()

FeatureXMLFile ( )

Default constructor.

◆ ~FeatureXMLFile()

~FeatureXMLFile ( )

override

Destructor.

Member Function Documentation

◆ characters()

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

overrideprotected

◆ endElement()

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

overrideprotected

◆ getOptions() [1/2]

FeatureFileOptions& getOptions ( )

Mutable access to the options for loading/storing.

◆ getOptions() [2/2]

const FeatureFileOptions& getOptions ( ) const

Non-mutable access to the options for loading/storing.

◆ load()

void load	(	const String &	filename,
		FeatureMap &	feature_map
	)

loads the file with name filename into map and calls updateRanges().

Exceptions

Exception::FileNotFound	is thrown if the file could not be opened
Exception::ParseError	is thrown if an error occurs during parsing

Referenced by TOPPViewBase::addDataFile(), and TOPPViewBase::annotateWithID().

◆ loadSize()

Size loadSize ( const String & filename )

◆ resetMembers_()

void resetMembers_ ( )

protected

◆ setOptions()

void setOptions ( const FeatureFileOptions & )

setter for options for loading/storing

◆ startElement()

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

overrideprotected

◆ store()

void store	(	const String &	filename,
		const FeatureMap &	feature_map
	)

stores the map feature_map in file with name filename.

Exceptions

Exception::UnableToCreateFile is thrown if the file could not be created

Referenced by TOPPViewBase::runTOPPTool_().

◆ updateCurrentFeature_()

void updateCurrentFeature_ ( bool create )

protected

update the pointer to the current feature

Parameters

create If true, a new (empty) Feature is added at the appropriate subordinate_feature_level_

◆ writeFeature_()

void writeFeature_	(	const String &	filename,
		std::ostream &	os,
		const Feature &	feat,
		const String &	identifier_prefix,
		UInt64	identifier,
		UInt	indentation_level
	)

protected

Writes a feature to a stream.

◆ writePeptideIdentification_()

void writePeptideIdentification_	(	const String &	filename,
		std::ostream &	os,
		const PeptideIdentification &	id,
		const String &	tag_name,
		UInt	indentation_level
	)

protected

Writes a peptide identification to a stream (for assigned/unassigned peptide identifications)

Member Data Documentation

◆ accession_to_id_

Map<String, Size> accession_to_id_

protected

Map from search identifier concatenated with protein accession to id.

◆ current_chull_

ConvexHull2D::PointArrayType current_chull_

protected

◆ current_feature_

Feature* current_feature_

protected

points to the last open <feature> tag (possibly a subordinate feature)

◆ dim_

UInt dim_

protected

current dimension of the feature position, quality, or convex hull point

◆ disable_parsing_

Int disable_parsing_

protected

allows for early return in parsing functions when certain sections should be ignored <=0 - parsing ON >0 - this number of tags have been entered that forbid parsing and need to be exited before parsing continues

◆ expected_size_

Size expected_size_

protected

holds the putative size given in count

◆ hull_position_

DPosition<2> hull_position_

protected

◆ id_identifier_

Map<String, String> id_identifier_

protected

Map from file xs:id to identification run identifier (for linking peptide identifications to the corresponding run)

◆ identifier_id_

Map<String, String> identifier_id_

protected

Map from identification run identifier to file xs:id (for linking peptide identifications to the corresponding run)

◆ in_description_

bool in_description_

protected

for downward compatibility, all tags in the old description must be ignored

◆ last_meta_

MetaInfoInterface* last_meta_

protected

Pointer to last read object as a MetaInfoInterface, or null.

◆ map_

FeatureMap* map_

protected

Feature map pointer for reading.

◆ options_

FeatureFileOptions options_

protected

Options that can be set.

◆ param_

Param param_

protected

◆ pep_hit_

PeptideHit pep_hit_

protected

Temporary peptide hit.

◆ pep_id_

PeptideIdentification pep_id_

protected

Temporary peptide ProteinIdentification.

◆ prot_hit_

ProteinHit prot_hit_

protected

Temporary protein hit.

◆ prot_id_

ProteinIdentification prot_id_

protected

Temporary protein ProteinIdentification.

◆ proteinid_to_accession_

Map<String, String> proteinid_to_accession_

protected

Map from protein id to accession.

◆ search_param_

ProteinIdentification::SearchParameters search_param_

protected

Temporary search parameters file.

◆ size_only_

bool size_only_

protected

only parse until "count" tag is reached (used in loadSize())

◆ subordinate_feature_level_

Int subordinate_feature_level_

protected

level in Feature stack during parsing

Protected Attributes

Constructors and Destructor

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FeatureXMLFile()

◆ ~FeatureXMLFile()

Member Function Documentation

◆ characters()

◆ endElement()

◆ getOptions() [1/2]

◆ getOptions() [2/2]

◆ load()

◆ loadSize()

◆ resetMembers_()

◆ setOptions()

◆ startElement()

◆ store()

◆ updateCurrentFeature_()

◆ writeFeature_()

◆ writePeptideIdentification_()

Member Data Documentation

◆ accession_to_id_

◆ current_chull_

◆ current_feature_

◆ dim_

◆ disable_parsing_

◆ expected_size_

◆ hull_position_

◆ id_identifier_

◆ identifier_id_

◆ in_description_

◆ last_meta_

◆ map_

◆ options_

◆ param_

◆ pep_hit_

◆ pep_id_

◆ prot_hit_

◆ prot_id_

◆ proteinid_to_accession_

◆ search_param_

◆ size_only_

◆ subordinate_feature_level_