XML handler for ToolDescriptionFile. More...

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

Inheritance diagram for ToolDescriptionHandler:

Collaboration diagram for ToolDescriptionHandler:

Constructors and destructor
Param	p_

Internal::ToolExternalDetails	tde_

Internal::ToolDescription	td_

std::vector< Internal::ToolDescription >	td_vec_

String	tag_

bool	in_ini_section_

	ToolDescriptionHandler (const String &filename, const String &version)
	Constructor. More...

	~ToolDescriptionHandler () override
	Destructor. More...

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	writeTo (std::ostream &os) override
	Writes the contents to a stream. More...

const std::vector< ToolDescription > &	getToolDescriptions () const

void	setToolDescriptions (const std::vector< ToolDescription > &td)

	ToolDescriptionHandler ()

	ToolDescriptionHandler (const ToolDescriptionHandler &rhs)

ToolDescriptionHandler &	operator= (const ToolDescriptionHandler &rhs)

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 }

Public Member Functions inherited from ParamXMLHandler
	ParamXMLHandler (Param &param, const String &filename, const String &version)
	Default constructor. More...

	~ParamXMLHandler () override
	Destructor. More...

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

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

Public Member Functions inherited from XMLHandler
	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 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

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

Protected Attributes inherited from ParamXMLHandler
String	path_
	The current absolute path (concatenation of nodes_ with : in between) More...

Param &	param_
	Reference to the Param object to fill. More...

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

struct {
String	name

String	type

std::vector< std::string >	stringlist

IntList	intlist

DoubleList	doublelist

std::vector< std::string >	tags

String	description

String	restrictions

Int	restrictions_index

}	list_
	Temporary data for parsing of item lists. 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...

Detailed Description

XML handler for ToolDescriptionFile.

Note: Do not use this class. It is only needed in ToolDescriptionFile.

Constructor & Destructor Documentation

◆ ToolDescriptionHandler() [1/3]

ToolDescriptionHandler	(	const String &	filename,
		const String &	version
	)

Constructor.

◆ ~ToolDescriptionHandler()

~ToolDescriptionHandler ( )

override

Destructor.

◆ ToolDescriptionHandler() [2/3]

ToolDescriptionHandler ( )

private

◆ ToolDescriptionHandler() [3/3]

ToolDescriptionHandler ( const ToolDescriptionHandler & rhs )

private

Member Function Documentation

◆ characters()

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

override

◆ endElement()

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

override

◆ getToolDescriptions()

const std::vector<ToolDescription>& getToolDescriptions ( ) const

◆ operator=()

ToolDescriptionHandler& operator= ( const ToolDescriptionHandler & rhs )

private

◆ setToolDescriptions()

void setToolDescriptions ( const std::vector< ToolDescription > & td )

◆ startElement()

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

override

◆ writeTo()

void writeTo ( std::ostream & )

overridevirtual

Writes the contents to a stream.

Reimplemented from XMLHandler.

Member Data Documentation

◆ in_ini_section_

bool in_ini_section_

protected

◆ p_

Param p_

protected

◆ tag_

String tag_

protected

◆ td_

Internal::ToolDescription td_

protected

◆ td_vec_

std::vector<Internal::ToolDescription> td_vec_

protected

◆ tde_

Internal::ToolExternalDetails tde_

protected

Constructors and destructor

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ToolDescriptionHandler() [1/3]

◆ ~ToolDescriptionHandler()

◆ ToolDescriptionHandler() [2/3]

◆ ToolDescriptionHandler() [3/3]

Member Function Documentation

◆ characters()

◆ endElement()

◆ getToolDescriptions()

◆ operator=()

◆ setToolDescriptions()

◆ startElement()

◆ writeTo()

Member Data Documentation

◆ in_ini_section_

◆ p_

◆ tag_

◆ td_

◆ td_vec_

◆ tde_