XML Handler for Param files. More...

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

Inheritance diagram for ParamXMLHandler:

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

virtual	~ParamXMLHandler ()
	Destructor. More...

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

virtual void	startElement (const XMLCh const uri, const XMLCh const local_name, const XMLCh *const qname, const xercesc::Attributes &attributes)
	Parsing method for opening tags. More...

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

virtual	~XMLHandler ()
	Destructor. More...

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

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

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

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

String	errorString ()
	Returns the last error description. More...

void	fatalError (const xercesc::SAXParseException &exception)

void	error (const xercesc::SAXParseException &exception)

void	warning (const xercesc::SAXParseException &exception)

Protected Attributes
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

StringList stringlist

IntList intlist

DoubleList doublelist

StringList tags

String description

String restrictions

Int restrictions_index

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

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

Private Member Functions
	ParamXMLHandler ()
	Not implemented. More...

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

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

Protected Member Functions inherited from XMLHandler
bool	equal_ (const XMLCh a, const XMLCh b) const
	Returns if two Xerces strings are equal. More...

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

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

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

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

Detailed Description

XML Handler for Param files.

Constructor & Destructor Documentation

◆ ParamXMLHandler() [1/2]

ParamXMLHandler	(	Param &	param,
		const String &	filename,
		const String &	version
	)

Default constructor.

◆ ~ParamXMLHandler()

virtual ~ParamXMLHandler ( )

virtual

Destructor.

◆ ParamXMLHandler() [2/2]

ParamXMLHandler ( )

private

Not implemented.

Member Function Documentation

◆ endElement()

virtual void endElement	(	const XMLCh *const	uri,
		const XMLCh *const	localname,
		const XMLCh *const	qname
	)

virtual

Parsing method for closing tags.

Reimplemented from XMLHandler.

Reimplemented in ToolDescriptionHandler.

◆ startElement()

virtual void startElement	(	const XMLCh *const	uri,
		const XMLCh *const	localname,
		const XMLCh *const	qname,
		const xercesc::Attributes &	attrs
	)

virtual

Parsing method for opening tags.

Reimplemented from XMLHandler.

Reimplemented in ToolDescriptionHandler.

Member Data Documentation

◆ description

String description

◆ descriptions_

std::map<String, String> descriptions_

protected

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

◆ doublelist

DoubleList doublelist

◆ intlist

IntList intlist

◆ list_

struct { ... } list_

Temporary data for parsing of item lists.

◆ name

String name

◆ param_

Param& param_

protected

Reference to the Param object to fill.

◆ path_

String path_

protected

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

◆ restrictions

String restrictions

◆ restrictions_index

Int restrictions_index

◆ stringlist

StringList stringlist

◆ tags

StringList tags

◆ type

String type

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

◆ endElement()

◆ startElement()

Member Data Documentation

◆ description

◆ descriptions_

◆ doublelist

◆ intlist

◆ list_

◆ name

◆ param_

◆ path_

◆ restrictions

◆ restrictions_index

◆ stringlist

◆ tags

◆ type