Derived class of XMLParser that keeps its DOMDocuments when parsing an XML disk file, and returns the cached DOMDocument if the file hasn't changed. More...

#include <XMLParser.h>

Inheritance diagram for nidas::core::XMLCachingParser:

[legend]

Public Member Functions
xercesc::DOMDocument *	parse (const std::string &xmlFile) throw (nidas::core::XMLException,nidas::util::IOException)
	Parse from a file. More...

void	setDOMValidation (bool val)
	DOMBuilder::setFilter is not yet implemented in xerces c++ 2.6.0 void setFilter(xercesc::DOMBuilderFilter* filter) More...

void	setDOMValidateIfSchema (bool val)
	Enable/disable schema validation. More...

void	setDOMNamespaces (bool val)
	Enable/disable namespace processing. More...

void	setXercesSchema (bool val)
	Enable/disable schema support. More...

void	setXercesSchemaFullChecking (bool val)
	Enable/disable full schema constraint checking, including checking which may be time-consuming or memory intensive. More...

void	setDOMDatatypeNormalization (bool val)
	Enable/disable datatype normalization. More...

void	setXercesUserAdoptsDOMDocument (bool val)
	Control who owns DOMDocument pointer. More...

void	setXercesHandleMultipleImports (bool val)

void	setXercesDoXInclude (bool val)

xercesc::DOMDocument *	parse (const std::string &xmlFile, bool verbose=true) throw (nidas::core::XMLException)

xercesc::DOMDocument *	parse (xercesc::InputSource &source) throw (nidas::core::XMLException)

Static Public Member Functions
static XMLCachingParser *	getInstance () throw (nidas::core::XMLException)

static void	destroyInstance ()

static time_t	getFileModTime (const std::string &name) throw (nidas::util::IOException)
	Parse from an InputSource. More...

Protected Member Functions
	XMLCachingParser () throw (nidas::core::XMLException)

	~XMLCachingParser ()

Protected Attributes
std::map< std::string, time_t >	_modTimeCache

std::map< std::string, xercesc::DOMDocument * >	_docCache

nidas::util::Mutex	_cacheLock

xercesc::DOMImplementation *	_impl

xercesc::DOMBuilder *	_parser

XMLErrorHandler	_errorHandler

Static Protected Attributes
static XMLCachingParser *	_instance = 0

static nidas::util::Mutex	_instanceLock

Private Member Functions
	XMLCachingParser (const XMLCachingParser &)
	No copying. More...

XMLCachingParser &	operator= (const XMLCachingParser &)
	No assignment. More...

Detailed Description

Derived class of XMLParser that keeps its DOMDocuments when parsing an XML disk file, and returns the cached DOMDocument if the file hasn't changed.

Constructor & Destructor Documentation

XMLCachingParser::XMLCachingParser	(		)
throw	(	nidas::core::XMLException
	)

protected

Referenced by getInstance().

XMLCachingParser::~XMLCachingParser ( )

protected

References _cacheLock, and _docCache.

nidas::core::XMLCachingParser::XMLCachingParser ( const XMLCachingParser & )

private

No copying.

Member Function Documentation

void XMLCachingParser::destroyInstance ( )

static

References _instance, and _instanceLock.

Referenced by nidas::core::DSMServerApp::main().

time_t XMLCachingParser::getFileModTime	(	const std::string &	name	)
throw	(	nidas::util::IOException
	)

static

Parse from an InputSource.

This is not cached.

XMLCachingParser * XMLCachingParser::getInstance	(		)
throw	(	nidas::core::XMLException
	)

static

References _instance, _instanceLock, and XMLCachingParser().

Referenced by nidas::core::DSMServerApp::parseXMLConfigFile(), and nidas::dynld::XMLConfigService::Worker::run().

XMLCachingParser& nidas::core::XMLCachingParser::operator= ( const XMLCachingParser & )

private

No assignment.

xercesc::DOMDocument * XMLParser::parse	(	const std::string &	xmlFile,
		bool	verbose = `true`
	)
throw	(	nidas::core::XMLException
	)

inherited

References NLOG, and verbose.

Referenced by PConfig::loadFile(), main(), parse(), nidas::core::Datasets::parseXML(), nidas::core::ProjectConfigs::parseXML(), and PacketDecode::run().

xercesc::DOMDocument * XMLParser::parse	(	xercesc::InputSource &	source	)
throw	(	nidas::core::XMLException
	)

inherited

xercesc::DOMDocument * XMLCachingParser::parse	(	const std::string &	xmlFile	)
throw	(	nidas::core::XMLException,
		nidas::util::IOException
	)

Parse from a file.

This will return the DOMDocument pointer of the a previous parse result if the file has not been modified since the last time it was parsed. The pointer to the DOMDocuemnt is owned by XMLCachingParser and the user should not call doc->release();

References nidas::core::XMLParser::parse().

Referenced by nidas::core::DSMServerApp::parseXMLConfigFile(), and nidas::dynld::XMLConfigService::Worker::run().

void XMLParser::setDOMDatatypeNormalization ( bool val )

inherited

Enable/disable datatype normalization.

See /link http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderFeatures

Parameters

val	If true let the validation process do its datatype normalization that is defined in the used schema language. If false disable datatype normalization. The XML 1.0 attribute value normalization always occurs though. Default: false.

Referenced by PConfig::loadFile(), main(), and nidas::core::DSMServerApp::parseXMLConfigFile().

void XMLParser::setDOMNamespaces ( bool val )

inherited

Enable/disable namespace processing.

See /link http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderFeatures

Parameters

val	If true perform namespace processing. Default: false.

Referenced by PConfig::loadFile(), main(), and nidas::core::DSMServerApp::parseXMLConfigFile().

void XMLParser::setDOMValidateIfSchema ( bool val )

inherited

Enable/disable schema validation.

See /link http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderFeatures

Parameters

val	If true the parser will validate the document only if a grammar is specified. If false validation is determined by the state of the validation feature, see setDOMValidation(). Default: false.

Referenced by PConfig::loadFile(), main(), and nidas::core::DSMServerApp::parseXMLConfigFile().

void XMLParser::setDOMValidation ( bool val )

inherited

DOMBuilder::setFilter is not yet implemented in xerces c++ 2.6.0 void setFilter(xercesc::DOMBuilderFilter* filter)

Enable/disable validation. See /link http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderFeatures

Parameters

val	Boolean value specifying whether to report all validation errors. Default: false.

Referenced by PConfig::loadFile(), main(), and nidas::core::DSMServerApp::parseXMLConfigFile().

void XMLParser::setXercesDoXInclude ( bool val )

inherited

Referenced by PConfig::loadFile(), main(), and nidas::core::DSMServerApp::parseXMLConfigFile().

void XMLParser::setXercesHandleMultipleImports ( bool val )

inherited

Referenced by PConfig::loadFile(), main(), and nidas::core::DSMServerApp::parseXMLConfigFile().

void XMLParser::setXercesSchema ( bool val )

inherited

Enable/disable schema support.

See /link http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderFeatures

Parameters

val	If true enable the parser's schema support. Default: false.

Referenced by PConfig::loadFile(), main(), and nidas::core::DSMServerApp::parseXMLConfigFile().

void XMLParser::setXercesSchemaFullChecking ( bool val )

inherited

Enable/disable full schema constraint checking, including checking which may be time-consuming or memory intensive.

Currently, particle unique attribution constraint checking and particle derivation restriction checking are controlled by this option. See /link http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderFeatures

Parameters

val	If true enable schema constraint checking. Default: false.

Referenced by PConfig::loadFile(), main(), and nidas::core::DSMServerApp::parseXMLConfigFile().

void XMLParser::setXercesUserAdoptsDOMDocument ( bool val )

inherited

Control who owns DOMDocument pointer.

See /link http://xml.apache.org/xerces-c/program-dom.html#DOMBuilderFeatures

Parameters

val If true the caller will adopt the DOMDocument that is returned from the parse method and thus is responsible to call DOMDocument::release() to release the associated memory. The parser will not release it. The ownership is transferred from the parser to the caller. If false the returned DOMDocument from the parse method is owned by the parser and thus will be deleted when the parser is released.

Member Data Documentation

nidas::util::Mutex nidas::core::XMLCachingParser::_cacheLock

protected

Referenced by ~XMLCachingParser().

std::map<std::string,xercesc::DOMDocument*> nidas::core::XMLCachingParser::_docCache

protected

Referenced by ~XMLCachingParser().

XMLErrorHandler nidas::core::XMLParser::_errorHandler

protectedinherited

xercesc::DOMImplementation* nidas::core::XMLParser::_impl

protectedinherited

XMLCachingParser * XMLCachingParser::_instance = 0

staticprotected

Referenced by destroyInstance(), and getInstance().

n_u::Mutex XMLCachingParser::_instanceLock

staticprotected

Referenced by destroyInstance(), and getInstance().

std::map<std::string,time_t> nidas::core::XMLCachingParser::_modTimeCache

protected

xercesc::DOMBuilder* nidas::core::XMLParser::_parser

protectedinherited

The documentation for this class was generated from the following files:

nidas/core/XMLParser.h
nidas/core/XMLParser.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation