strusModule  0.17
Public Member Functions | Public Attributes | List of all members
strus::StorageModule Struct Reference

Structure that contains all storage module objects. More...

#include <storageModule.hpp>

Inheritance diagram for strus::StorageModule:
strus::ModuleEntryPoint

Public Member Functions

 StorageModule (const PostingIteratorJoinConstructor *postingIteratorJoinConstructor_, const WeightingFunctionConstructor *weightingFunctionConstructor_, const SummarizerFunctionConstructor *summarizerFunctionConstructor_, const char *version_3rdparty=0, const char *license_3rdparty=0)
 Storage module constructor. More...
 
 StorageModule (const DatabaseConstructor *databaseConstructor_, const char *version_3rdparty=0, const char *license_3rdparty=0)
 Storage module constructor for alternative database implementation. More...
 
 StorageModule (const VectorStorageConstructor *vectorStorageConstructor_, const char *version_3rdparty=0, const char *license_3rdparty=0)
 Storage module constructor for alternative vector storage interface. More...
 
- Public Member Functions inherited from strus::ModuleEntryPoint
 ModuleEntryPoint (Type type_, unsigned short version_major, unsigned short version_minor, const char *version_3rdparty_=0, const char *license_3rdparty_=0)
 Constructor for derived classes. More...
 

Public Attributes

DatabaseConstructor databaseConstructor
 alternative key value store database More...
 
StatisticsProcessorConstructor statisticsProcessorConstructor
 alternative packing/unpacking of statistics messages More...
 
VectorStorageConstructor vectorStorageConstructor
 alternative vectorspace model for mapping vectors to features More...
 
const
PostingIteratorJoinConstructor
postingIteratorJoinConstructor
 join operator function for postings More...
 
const
WeightingFunctionConstructor
weightingFunctionConstructor
 alternative weighting functions for ranking More...
 
const
SummarizerFunctionConstructor
summarizerFunctionConstructor
 summarizer functions More...
 
const
ScalarFunctionParserConstructor
scalarFunctionParserConstructor
 scalar function parsers More...
 
- Public Attributes inherited from strus::ModuleEntryPoint
char signature [8]
 signature of the module (string + major version) More...
 
Type type
 type of the module More...
 
unsigned short modversion_minor
 minor version of the module More...
 
unsigned short compversion_major
 major version of components in the module More...
 
unsigned short compversion_minor
 minor version of components in the module More...
 
unsigned int _reserved [6]
 reserved for future use More...
 
const char * version_3rdparty
 3rd party version info More...
 
const char * license_3rdparty
 3rd party license text More...
 

Additional Inherited Members

- Public Types inherited from strus::ModuleEntryPoint
enum  Type { Analyzer, Storage, Trace }
 The module types supported. More...
 
enum  {
  ErrorNone =0, ErrorUnknownModuleType =1, ErrorSignature =11, ErrorModMinorVersion =12,
  ErrorCompMajorVersion =21, ErrorCompMinorVersion =22, ErrorOpenModule =31, ErrorNoEntryPoint =32
}
 
typedef void * Handle
 
- Static Public Member Functions inherited from strus::ModuleEntryPoint
static void closeHandle (Handle &hnd)
 

Detailed Description

Structure that contains all storage module objects.

Constructor & Destructor Documentation

strus::StorageModule::StorageModule ( const PostingIteratorJoinConstructor postingIteratorJoinConstructor_,
const WeightingFunctionConstructor weightingFunctionConstructor_,
const SummarizerFunctionConstructor summarizerFunctionConstructor_,
const char *  version_3rdparty = 0,
const char *  license_3rdparty = 0 
)

Storage module constructor.

Parameters
[in]postingIteratorJoinConstructor_(0,0) terminated list of posting iterator join operators or 0
[in]weightingFunctionConstructor_(0,0) terminated list of weighting functions or 0
[in]summarizerFunctionConstructor_(0,0) terminated list of summarizers or 0
strus::StorageModule::StorageModule ( const DatabaseConstructor databaseConstructor_,
const char *  version_3rdparty = 0,
const char *  license_3rdparty = 0 
)
explicit

Storage module constructor for alternative database implementation.

Parameters
[in]databaseConstructor_alternative database implementation
strus::StorageModule::StorageModule ( const VectorStorageConstructor vectorStorageConstructor_,
const char *  version_3rdparty = 0,
const char *  license_3rdparty = 0 
)
explicit

Storage module constructor for alternative vector storage interface.

Parameters
[in]vectorStorageConstructor_alternative vector storage interface

Member Data Documentation

DatabaseConstructor strus::StorageModule::databaseConstructor

alternative key value store database

const PostingIteratorJoinConstructor* strus::StorageModule::postingIteratorJoinConstructor

join operator function for postings

const ScalarFunctionParserConstructor* strus::StorageModule::scalarFunctionParserConstructor

scalar function parsers

StatisticsProcessorConstructor strus::StorageModule::statisticsProcessorConstructor

alternative packing/unpacking of statistics messages

const SummarizerFunctionConstructor* strus::StorageModule::summarizerFunctionConstructor

summarizer functions

VectorStorageConstructor strus::StorageModule::vectorStorageConstructor

alternative vectorspace model for mapping vectors to features

const WeightingFunctionConstructor* strus::StorageModule::weightingFunctionConstructor

alternative weighting functions for ranking


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