CAlgorithmCollection Class

# CAlgorithmCollection Class Reference

[CADIHash.h Index] [CADIHash.h Hierarchy]

The algorithm collection is kind of a factory for CQuery structures: We provide a list of algorithms which correspond to so-called "basetypes" More...

`#include <../libInvertedFile/include/CAlgorithmCollection.h>`

Inherits: CBaseTypeFactory

## Public Members

- CAlgorithm* getAlgorithmInConstruction ()
- void startAlgorithmConstruction (CAlgorithm* inAlgorithm)
- CAlgorithmCollection (string inConfigFileName)
- ~CAlgorithmCollection ()
- void addAlgorithm (CAlgorithm* inAlgorithm)
- CAlgorithm& getAlgorithmByType (const string& inType)
- bool containsAlgorithmByType (const string& inType)
- CAlgorithm* makeAlgorithmByType (const string& inType)
- CAlgorithm* getDefaultAlgorithm ()
- CAlgorithm* makeDefaultAlgorithm ()
- CXMLElement* getAlgorithmList (const CXMLElement& inGetAlgorithms)
- string toXML (bool inIsPrivate=false)
- CXMLElement* toXMLElement ()

## Protected Members

- CContent::const_iterator begin ()
- CContent::const_iterator end ()

## Detailed Description

The algorithm collection is kind of a factory for CQuery structures:

We provide a list of algorithms which correspond to so-called "basetypes". At present there are only two: bayesian and inverted_file.

Each algorithm which will be configured in the configuration file will have a basetype. Corresponding to this there is generated a CQuery structure for each algorithm out of the configuration.

@Author Wolfgang Mueller

## CAlgorithm* getAlgorithmInConstruction()

returns a pointer to the algorithm in construction

## CAlgorithmCollection(string inConfigFileName)

Constructor

## ~CAlgorithmCollection()

Destructor destroys all members of CContent

## void addAlgorithm(CAlgorithm* inAlgorithm)

adding a completely built algorithm XML document tree

## CAlgorithm& getAlgorithmByType(const string& inType)

Algorithm for TYPE => permits configuring probably only the pointered version is interesting

## bool containsAlgorithmByType(const string& inType)

Algorithm for TYPE => permits configuring probably only the pointered version is interesting

## CAlgorithm* makeAlgorithmByType(const string& inType)

Creates a new algorithm for agiven type by cloning what you would get with getAlgorithm. The values made here will be used as default in the subsequent CQuery building process.

## CAlgorithm* getDefaultAlgorithm()

A default algorithm for the default sessionThis algorithm will be given by the ONE ALGORITHM which has the type "adefault"

## CAlgorithm* makeDefaultAlgorithm()

creates a copy of what you'd get with

## CXMLElement* getAlgorithmList(const CXMLElement& inGetAlgorithms)

For handshaking:This makes you a list of all algorithms which work with a given query paradigm.

## string toXML(bool inIsPrivate=false)

for shandshake and for state output

## CXMLElement* toXMLElement()

for get-algorithms: the output is an CXMLElement, containingan algorithm-list element.

## CContent::const_iterator begin()

for being able to read all the content

## CContent::const_iterator end()

for being able to read all the content

| Kdoc