XMLFile Class Reference

Base class for loading/storing XML files that have a handler derived from XMLHandler. More...

#include <OpenMS/FORMAT/XMLFile.h>

Inheritance diagram for XMLFile:

Collaboration diagram for XMLFile:

Public Member Functions
	XMLFile ()
	Default constructor.
	XMLFile (const String &schema_location, const String &version)
	Constructor that sets the schema location.
virtual	~XMLFile ()
	Destructor.
bool	isValid (const String &filename, std::ostream &os)
	Checks if a file validates against the XML schema.
const String &	getVersion () const
	return the version of the schema

Protected Member Functions
void	parse_ (const String &filename, XMLHandler *handler)
	Parses the XML file given by filename using the handler given by handler.
void	parseBuffer_ (const std::string &buffer, XMLHandler *handler)
	Parses the in-memory buffer given by buffer using the handler given by handler.
void	save_ (const String &filename, XMLHandler *handler) const
	Stores the contents of the XML handler given by handler in the file given by filename.
void	enforceEncoding_ (const String &encoding)

Protected Attributes
String	schema_location_
	XML schema file location.
String	schema_version_
	Version string.
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.

Detailed Description

Base class for loading/storing XML files that have a handler derived from XMLHandler.

Constructor & Destructor Documentation

XMLFile() [1/2]

XMLFile

(

)

Default constructor.

XMLFile() [2/2]

XMLFile	(	const String &	schema_location,
		const String &	version
	)

Constructor that sets the schema location.

~XMLFile()

virtual ~XMLFile ( )

virtual

Destructor.

Member Function Documentation

enforceEncoding_()

void enforceEncoding_ ( const String &  encoding )

protected

getVersion()

const String & getVersion

(

)

const

return the version of the schema

isValid()

bool isValid	(	const String &	filename,
		std::ostream &	os
	)

Checks if a file validates against the XML schema.

Error messages are printed to the error stream, unless redirected with the attribute os .

Parameters

[in]	filename	The name of the file to validate.
[in,out]	os	The ostream where error messages should be send.

Exceptions

Exception::FileNotFound	is thrown if the file cannot be found
Exception::NotImplemented	is thrown if there is no schema available for the file type

parse_()

void parse_ ( const String &  filename, XMLHandler *  handler  )

protected

Parses the XML file given by filename using the handler given by handler.

Parameters

[in]	filename	The XML file to parse
[in]	handler	The XML handler to use for parsing

Exceptions

Exception::FileNotFound	is thrown if the file is not found
Exception::ParseError	is thrown if an error occurred during the parsing

parseBuffer_()

void parseBuffer_ ( const std::string &  buffer, XMLHandler *  handler  )

protected

Parses the in-memory buffer given by buffer using the handler given by handler.

Parameters

[in]	buffer	The buffer to parse
[in]	handler	The XML handler to use for parsing

Note

Currently the buffer needs to be plain text, gzip buffer is not supported.

Exceptions

Exception::ParseError

is thrown if an error occurred during the parsing

save_()

void save_ ( const String &  filename, XMLHandler *  handler  ) const

protected

Stores the contents of the XML handler given by handler in the file given by filename.

Parameters

[in]	filename	The output filename
[in]	handler	The XML handler containing the content to write

Exceptions

Exception::UnableToCreateFile

is thrown if the file cannot be created

Member Data Documentation

enforced_encoding_

String enforced_encoding_

protected

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

schema_location_

String schema_location_

protected

XML schema file location.

schema_version_

String schema_version_

protected

Version string.