Public Member Functions
zorba::ExternalModule Class Reference

An external module represents a group of external functions, all belonging to the same target namespace. More...

#include <zorba/external_module.h>

List of all members.

Public Member Functions

virtual void destroy ()
 Function used for destroying the ExternalModule object passed as parameter.
virtual ExternalFunctiongetExternalFunction (const String &aLocalname)=0
virtual String getURI () const =0
virtual ~ExternalModule ()

Detailed Description

An external module represents a group of external functions, all belonging to the same target namespace.

Class ExternalModule provides the interface for retrieving the target namespace URI and/or the implementation of each contained external function by function name.

An external module can be a library module by itself, or be a component of a library module.

Instances of this class must be implemented by the application and provide storage for the implementations of the external functions. The instances must be registered in the static context in order for the functions to be accessible by a query (see here for more details.).

Examples:
external_functions.cpp.

Definition at line 44 of file external_module.h.


Constructor & Destructor Documentation

virtual zorba::ExternalModule::~ExternalModule ( )
inlinevirtual

Definition at line 47 of file external_module.h.


Member Function Documentation

virtual void zorba::ExternalModule::destroy ( )
inlinevirtual

Function used for destroying the ExternalModule object passed as parameter.

The user needs to override this function if the module passed as parameter was created using the createModule function which is used for dynamically loading modules from a shared library.

Definition at line 71 of file external_module.h.

virtual ExternalFunction* zorba::ExternalModule::getExternalFunction ( const String aLocalname)
pure virtual
Returns:
the implementation of the function with the given name.
virtual String zorba::ExternalModule::getURI ( ) const
pure virtual
Returns:
the target namespace URI of the module.

The documentation for this class was generated from the following file:
blog comments powered by Disqus