Abstract class as processor provider interface. More...

#include <procProviderInterface.hpp>

Inheritance diagram for _Wolframe::proc::ProcessorProviderInterface:

Public Member Functions
virtual	~ProcessorProviderInterface ()
	Destructor. More...

virtual cmdbind::CommandHandler *	cmdhandler (const std::string &command, const std::string &docformat) const =0
	Create a command handler for a specific command and doc format. More...

virtual cmdbind::ProtocolHandler *	protocolHandler (const std::string &protocol) const =0
	Create a new protocol handler for a command and for a document format (e.g. XML,JSON,...) More...

virtual bool	hasProtocol (const std::string &protocol) const =0
	Find out if a protocol with a specific name exists. More...

virtual bool	hasCommand (const std::string &command) const =0
	Find out if there exists a command handler for a specific command without creating it. More...

virtual db::Database *	transactionDatabase () const =0
	Get the database for transactions. More...

virtual db::Transaction *	transaction (const std::string &name) const =0
	Get a database transaction object for the given name. More...

virtual db::Transaction *	transaction (const std::string &dbname, const std::string &name) const =0
	Get a database transaction object for a transaction identified by name on an alternative database than the default transaction database. More...

virtual const langbind::AuthorizationFunction *	authorizationFunction (const std::string &name) const =0
	Get an authorization function by name. More...

virtual const langbind::AuditFunction *	auditFunction (const std::string &name) const =0
	Get an audit function by name. More...

virtual const types::NormalizeFunction *	normalizeFunction (const std::string &name) const =0
	Get a normalization function. More...

virtual const types::NormalizeFunctionType *	normalizeFunctionType (const std::string &name) const =0
	Get a normalization function type. More...

virtual const langbind::FormFunction *	formFunction (const std::string &name) const =0
	Get a form function. More...

virtual const types::FormDescription *	formDescription (const std::string &name) const =0
	Get a form description. More...

virtual const langbind::FilterType *	filterType (const std::string &name) const =0
	Get a filter type. More...

virtual const types::CustomDataType *	customDataType (const std::string &name) const =0
	Get a custom data type. More...

virtual cmdbind::DoctypeDetector *	doctypeDetector () const =0
	Create a new document type and format detector (defined in modules) More...

virtual const std::string &	referencePath () const =0
	Get the application configuration reference path. More...

Detailed Description

Abstract class as processor provider interface.

Constructor & Destructor Documentation

virtual _Wolframe::proc::ProcessorProviderInterface::~ProcessorProviderInterface ( )

inlinevirtual

Destructor.

Member Function Documentation

virtual const langbind::AuditFunction* _Wolframe::proc::ProcessorProviderInterface::auditFunction ( const std::string & name ) const

pure virtual

Get an audit function by name.

Parameters

[in] name name of the audit function

Returns: reference to function

Implemented in _Wolframe::proc::ProcessorProvider.

virtual const langbind::AuthorizationFunction* _Wolframe::proc::ProcessorProviderInterface::authorizationFunction ( const std::string & name ) const

pure virtual

Get an authorization function by name.

Parameters

[in] name name of the authorization function

Returns: reference to function

Implemented in _Wolframe::proc::ProcessorProvider.

virtual cmdbind::CommandHandler* _Wolframe::proc::ProcessorProviderInterface::cmdhandler	(	const std::string &	command,
		const std::string &	docformat
	)		const

pure virtual

Create a command handler for a specific command and doc format.

Parameters

[in]	command	name of the command
[in]	docformat	document format, e.g. "XML","JSON"

Returns: the constructed command handler (owned now by the caller)

Implemented in _Wolframe::proc::ProcessorProvider.

virtual const types::CustomDataType* _Wolframe::proc::ProcessorProviderInterface::customDataType ( const std::string & name ) const

pure virtual

Get a custom data type.

Parameters

[in] name name of the type

Returns: reference to the custom data type

Implemented in _Wolframe::proc::ProcessorProvider.

virtual cmdbind::DoctypeDetector* _Wolframe::proc::ProcessorProviderInterface::doctypeDetector ( ) const

pure virtual

Create a new document type and format detector (defined in modules)

Returns: a document type and format detector reference allocated (owned and deleted by the caller)

Implemented in _Wolframe::proc::ProcessorProvider.

virtual const langbind::FilterType* _Wolframe::proc::ProcessorProviderInterface::filterType ( const std::string & name ) const

pure virtual

Get a filter type.

Parameters

[in] name name of the filter

Returns: constant filter reference

Implemented in _Wolframe::proc::ProcessorProvider.

virtual const types::FormDescription* _Wolframe::proc::ProcessorProviderInterface::formDescription ( const std::string & name ) const

pure virtual

Get a form description.

Parameters

[in] name name of the form

Returns: reference to the form description

Implemented in _Wolframe::proc::ProcessorProvider.

virtual const langbind::FormFunction* _Wolframe::proc::ProcessorProviderInterface::formFunction ( const std::string & name ) const

pure virtual

Get a form function.

Parameters

[in] name name of the function

Returns: reference to the function

Implemented in _Wolframe::proc::ProcessorProvider.

virtual bool _Wolframe::proc::ProcessorProviderInterface::hasCommand ( const std::string & command ) const

pure virtual

Find out if there exists a command handler for a specific command without creating it.

Parameters

[in] command name of the command

Returns: true, if yes

Implemented in _Wolframe::proc::ProcessorProvider.

virtual bool _Wolframe::proc::ProcessorProviderInterface::hasProtocol ( const std::string & protocol ) const

pure virtual

Find out if a protocol with a specific name exists.

Parameters

[in] protocol name of the protocol

Returns: true, if yes

Implemented in _Wolframe::proc::ProcessorProvider.

virtual const types::NormalizeFunction* _Wolframe::proc::ProcessorProviderInterface::normalizeFunction ( const std::string & name ) const

pure virtual

Get a normalization function.

Parameters

[in] name name of the function

Returns: reference to normalization function

Implemented in _Wolframe::proc::ProcessorProvider.

virtual const types::NormalizeFunctionType* _Wolframe::proc::ProcessorProviderInterface::normalizeFunctionType ( const std::string & name ) const

pure virtual

Get a normalization function type.

Parameters

[in] name name of the function type

Returns: reference to normalization function type

Implemented in _Wolframe::proc::ProcessorProvider.

virtual cmdbind::ProtocolHandler* _Wolframe::proc::ProcessorProviderInterface::protocolHandler ( const std::string & protocol ) const

pure virtual

Create a new protocol handler for a command and for a document format (e.g. XML,JSON,...)

Parameters

[in] protocol name of the protocol

Implemented in _Wolframe::proc::ProcessorProvider.

virtual const std::string& _Wolframe::proc::ProcessorProviderInterface::referencePath ( ) const

pure virtual

Get the application configuration reference path.

Returns: the reference path

Implemented in _Wolframe::proc::ProcessorProvider.

virtual db::Transaction* _Wolframe::proc::ProcessorProviderInterface::transaction ( const std::string & name ) const

pure virtual

Get a database transaction object for the given name.

Parameters

[in] name name of the transaction

Returns: allocated transaction object now owned by the caller and to destroy by the caller with delete

Implemented in _Wolframe::proc::ProcessorProvider.

virtual db::Transaction* _Wolframe::proc::ProcessorProviderInterface::transaction	(	const std::string &	dbname,
		const std::string &	name
	)		const

pure virtual

Get a database transaction object for a transaction identified by name on an alternative database than the default transaction database.

Parameters

[in]	dbname	name of the alternative database
[in]	name	name of the transaction

Returns: allocated transaction object now owned by the caller and to destroy by the caller with delete

Implemented in _Wolframe::proc::ProcessorProvider.

virtual db::Database* _Wolframe::proc::ProcessorProviderInterface::transactionDatabase ( ) const

pure virtual

Get the database for transactions.

Returns: reference to database

Implemented in _Wolframe::proc::ProcessorProvider.

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

include/processor/procProviderInterface.hpp

Project Wolframe

The Straight Path to Successful Projects

Wolframe, 0.0.3

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Documentation

Downloads

Contact Us