XML Handler for Param files. More...

#include <OpenMS/FORMAT/HANDLERS/ParamXMLHandler.h>

Inheritance diagram for ParamXMLHandler:

Collaboration diagram for ParamXMLHandler:

Public Member Functions
	ParamXMLHandler (Param &param, const std::string &filename, const std::string &version)
	Default constructor.

	~ParamXMLHandler () override
	Destructor.

void	onEndElement (const char16_t *qname) override
	Parsing method for closing tags.

void	onStartElement (const char16_t *qname, const XMLAttributes &attributes) override
	Parsing method for opening tags.

Public Member Functions inherited from XMLHandler
	XMLHandler (const std::string &filename, const std::string &version)
	Default constructor.

virtual	~XMLHandler ()
	Destructor.

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

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

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

void	warning (ActionMode mode, const std::string &msg, UInt line=0, UInt column=0) const
	Warning handler.

virtual void	onCharacters (const char16_t *chars, Size length)
	Parsing method for character data.

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

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

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

DataValue	cvParamToValue (const ControlledVocabulary &cv, const std::string &parent_tag, const std::string &accession, const std::string &name, const std::string &value, const std::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.

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.

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

Protected Attributes
std::string	path_
	The current absolute path (concatenation of nodes_ with : in between)

Param &	param_
	Reference to the Param object to fill.

std::map< std::string, std::string >	descriptions_
	Map of node descriptions (they are set at the end of parsing)

struct {

std::string	name

std::string	type

std::vector< std::string >	stringlist

IntList	intlist

DoubleList	doublelist

std::vector< std::string >	tags

std::string	description

std::string	restrictions

Int	restrictions_index

}	list_
	Temporary data for parsing of item lists.

Protected Attributes inherited from XMLHandler
std::string	file_
	File name.

std::string	version_
	Schema version.

StringManager	sm_
	Helper class for string conversion.

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

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

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

Private Member Functions
	ParamXMLHandler ()
	Not implemented.

Additional Inherited Members
Public 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 Public Member Functions inherited from XMLHandler
static std::string	writeXMLEscape (const std::string &to_escape)
	Escapes a string and returns the escaped string.

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

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

Int	asInt_ (const std::string &in) const
	Conversion of a std::string to an integer value.

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

UInt	asUInt_ (const std::string &in) const
	Conversion of a std::string to an unsigned integer value.

double	asDouble_ (const std::string &in) const
	Conversion of a std::string to a double value.

float	asFloat_ (const std::string &in) const
	Conversion of a std::string to a float value.

bool	asBool_ (const std::string &in) const
	Conversion of a string to a boolean value.

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

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

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

std::string	attributeAsString_ (const XMLAttributes &a, const char *name) const
	Converts an attribute to a String.

Int	attributeAsInt_ (const XMLAttributes &a, const char *name) const
	Converts an attribute to a Int.

double	attributeAsDouble_ (const XMLAttributes &a, const char *name) const
	Converts an attribute to a double.

DoubleList	attributeAsDoubleList_ (const XMLAttributes &a, const char *name) const
	Converts an attribute to a DoubleList.

IntList	attributeAsIntList_ (const XMLAttributes &a, const char *name) const
	Converts an attribute to an IntList.

StringList	attributeAsStringList_ (const XMLAttributes &a, const char *name) const
	Converts an attribute to an StringList.

bool	optionalAttributeAsString_ (std::string &value, const XMLAttributes &a, const char *name) const
	Assigns the attribute content to the String value if the attribute is present.

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

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

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

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

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

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

std::string	attributeAsString_ (const XMLAttributes &a, const char16_t *name) const
	Converts an attribute to a String.

Int	attributeAsInt_ (const XMLAttributes &a, const char16_t *name) const
	Converts an attribute to a Int.

double	attributeAsDouble_ (const XMLAttributes &a, const char16_t *name) const
	Converts an attribute to a double.

DoubleList	attributeAsDoubleList_ (const XMLAttributes &a, const char16_t *name) const
	Converts an attribute to a DoubleList.

IntList	attributeAsIntList_ (const XMLAttributes &a, const char16_t *name) const
	Converts an attribute to a IntList.

StringList	attributeAsStringList_ (const XMLAttributes &a, const char16_t *name) const
	Converts an attribute to a StringList.

bool	optionalAttributeAsString_ (std::string &value, const XMLAttributes &a, const char16_t *name) const
	Assigns the attribute content to the String value if the attribute is present.

bool	optionalAttributeAsInt_ (Int &value, const XMLAttributes &a, const char16_t *name) const
	Assigns the attribute content to the Int value if the attribute is present.

bool	optionalAttributeAsUInt_ (UInt &value, const XMLAttributes &a, const char16_t *name) const
	Assigns the attribute content to the UInt value if the attribute is present.

bool	optionalAttributeAsDouble_ (double &value, const XMLAttributes &a, const char16_t *name) const
	Assigns the attribute content to the double value if the attribute is present.

bool	optionalAttributeAsDoubleList_ (DoubleList &value, const XMLAttributes &a, const char16_t *name) const
	Assigns the attribute content to the DoubleList value if the attribute is present.

bool	optionalAttributeAsIntList_ (IntList &value, const XMLAttributes &a, const char16_t *name) const
	Assigns the attribute content to the IntList value if the attribute is present.

bool	optionalAttributeAsStringList_ (StringList &value, const XMLAttributes &a, const char16_t *name) const
	Assigns the attribute content to the StringList value if the attribute is present.

Detailed Description

XML Handler for Param files.

Constructor & Destructor Documentation

◆ ParamXMLHandler() [1/2]

ParamXMLHandler	(	Param &	param,
		const std::string &	filename,
		const std::string &	version
	)

Default constructor.

◆ ~ParamXMLHandler()

~ParamXMLHandler ( )

override

Destructor.

◆ ParamXMLHandler() [2/2]

ParamXMLHandler ( )

private

Not implemented.

Member Function Documentation

◆ onEndElement()

void onEndElement ( const char16_t * qname )

overridevirtual

Parsing method for closing tags.

Reimplemented from XMLHandler.

Reimplemented in ToolDescriptionHandler.

◆ onStartElement()

void onStartElement	(	const char16_t *	qname,
		const XMLAttributes &	attributes
	)

overridevirtual

Parsing method for opening tags.

Reimplemented from XMLHandler.

Reimplemented in ToolDescriptionHandler.

Member Data Documentation

◆ descriptions_

std::map<std::string, std::string> descriptions_

protected

Map of node descriptions (they are set at the end of parsing)

◆ [struct]

struct { ... } list_

Temporary data for parsing of item lists.

◆ param_

Param& param_

protected

Reference to the Param object to fill.

◆ path_

std::string path_

protected

The current absolute path (concatenation of nodes_ with : in between)

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ParamXMLHandler() [1/2]

◆ ~ParamXMLHandler()

◆ ParamXMLHandler() [2/2]

Member Function Documentation

◆ onEndElement()

◆ onStartElement()

Member Data Documentation

◆ descriptions_

◆ [struct]

◆ param_

◆ path_