CAlgorithm Class Reference

#include <CAlgorithm.h>

Inheritance diagram for CAlgorithm:

List of all members.

Public Member Functions
virtual void	addChild (const string &, const char *const *const inAttributeList=0)
virtual void	addChild (CXMLElement *inChild)
bool	configure (CAlgorithmCollection &inBaseConfiguration)
void	mergeAttributes (const CAlgorithm &inAlgorithm)
void	mergeChildLists (const CAlgorithm &inAlgorithm)
string	getCollectionID () const
double	getWeight () const
string	getAlgorithmName () const
pair< bool, string >	getType () const
pair< bool, string >	getInheritsFrom () const
string	getBaseType () const
string	getID () const
string	toOldMRML () const
void	setDefault (CAlgorithm &inDefault)
CAlgorithm *	clone () const
	CAlgorithm (const char *, const char *const *const inAttributeList=0)
	CAlgorithm (const string &, const list< pair< string, string > > &inList)
	CAlgorithm (const CXMLElement &inAlgorithm)
	CAlgorithm (const CAlgorithm &inAlgorithm)

---

Detailed Description

An algorithm is a CXMLElement which is linked to a CSessionManager together they are able to build CQuery trees.

: Wolfgang Müller

Definition at line 43 of file CAlgorithm.h.

---

Constructor & Destructor Documentation

CAlgorithm::CAlgorithm	(	const char *	inName,
		const char *const *const	inAttributeList = 0
	)

hand things through to the CXMLElement constructor

Definition at line 69 of file CAlgorithm.cc.

Referenced by addChild(), and clone().

                                                    :
  CXMLElement(inName,inAttributeList){
};

CAlgorithm::CAlgorithm	(	const string &	inName,
		const list< pair< string, string > > &	inList
	)

hand things through to the CXMLElement constructor

Definition at line 75 of file CAlgorithm.cc.

00076                                                              :
00077   CXMLElement(inName,inAttributeList){
00078 };
//----------------------------------------

CAlgorithm::CAlgorithm

(

const CXMLElement &

inAlgorithm

)

construct CAlgorithm from XML Element

clone this

Definition at line 42 of file CAlgorithm.cc.

                                                    :
  CXMLElement(inAlgorithm){
  
};

CAlgorithm::CAlgorithm

(

const CAlgorithm &

inAlgorithm

)

copy constructor

clone this

Definition at line 37 of file CAlgorithm.cc.

                                                   :
  CXMLElement(inAlgorithm){
  
};

---

Member Function Documentation

void CAlgorithm::addChild	(	const string &	inName,
		const char *const *const	inAttributeList = 0
	)			[virtual]

Same as in CXMLElement, but making a CAlgorithm instead

Add a child with the given attributes to the current node, and MAKE THIS CHILD THE NEW CURRENT NODE.

Reimplemented from CXMLElement.

Definition at line 51 of file CAlgorithm.cc.

References CXMLElement::addChild(), and CAlgorithm().

Referenced by configure(), startAlgorithmCollectionElement(), and CCommunicationHandler::startAlgorithmElement().

                                                  {
  //initialize new child
  CXMLElement::addChild(static_cast
      <CXMLElement*>(new CAlgorithm(inName.c_str(),
                  inAttributeList)));
}

void CAlgorithm::addChild

(

CXMLElement *

inChild

)

[virtual]

Same as in CXMLElement, but making a CAlgorithm instead

Add a child with the given attributes to the current node, and MAKE THIS CHILD THE NEW CURRENT NODE.

Reimplemented from CXMLElement.

Definition at line 63 of file CAlgorithm.cc.

References CXMLElement::addChild().

                                             {
    //initialize new child
    CXMLElement::addChild(inChild);
}

bool CAlgorithm::configure

(

CAlgorithmCollection &

inBaseConfiguration

)

reading an attribute for strings

here we extend the inheritance mechanism. We do not only look at parents, but also at the default values provided by the configuration.

this is virtual in order to plug in other methods of inheritance

See also:

: CXMLElement.h::stringReadAttribute In the long run, we would like to get of build query tree in this class and move it elsewhere.

The first step of this separation is the configure function, which does nothing else but putting the inherited values and the default values into the attribute list of this. After that no inheritance is necessary, and we can get at all the attributes using CXMLElement::createNamedValueList;

reading attributes with defaults Building a query tree out of the information we have gathered true indicates success...

Definition at line 179 of file CAlgorithm.cc.

References addChild(), mrml_const::algorithm, CXMLElement::child_list_begin(), CXMLElement::child_list_end(), configure(), CAlgorithmCollection::containsAlgorithmByType(), CAlgorithmCollection::getAlgorithmByType(), getBaseType(), CXMLElement::getFather(), CXMLElement::getName(), getType(), CXMLElement::mChildren, mergeAttributes(), and CXMLElement::moveUp().

Referenced by configure(), and CSession::setActiveAlgorithm().

                                                                   {
  //
  // merge this with the default algorithm of this type
  //
  cout << this << endl;
  cout << "1" << flush;
  if((this->getType().first)
     &&(inBaseConfiguration.containsAlgorithmByType(this->getType().second))){
    mergeAttributes(inBaseConfiguration.getAlgorithmByType(this->getType().second));

    CAlgorithm& lDefault(inBaseConfiguration.getAlgorithmByType(this->getType().second));

    //HACK clone children from default if this childlist is empty or contains 
    //only text nodes.
    int lSize=0;
    for(lCChildren::const_iterator i=mChildren.begin();
  i!=mChildren.end();
  i++){
      if((*i)->getName()==mrml_const::algorithm){
  lSize++;
      }
    }
    if(!lSize){
  cout << "°°"
       << endl;

  //  mCurrentChild=this;
  for(lCChildren::const_iterator i=lDefault.child_list_begin();
      i!=lDefault.child_list_end();
      i++){
    cout << " || "
         << mChildren.size()
         << ((CAlgorithm*)(*i))->getBaseType()
         << endl;
    addChild((*i)->clone(true));
    moveUp();
  }
    }
    cout << "NUMBER OF CHILDREN that are ALGORITHMS " 
   << lSize
   << endl;
    //mergeChildLists(inBaseConfiguration.getAlgorithmByType(this->getType().second));
  }
  cout << "2" << flush;
  // merge with the configuration of the father
  if(getFather()){
    mergeAttributes(*(CAlgorithm*)(getFather()));
  }
  cout << "3" << flush;


  // 
  // 3. Then build the query trees of the children and 
  // add each child both to the query finding structure
  // as to the query tree.
  //
  for(CXMLElement::lCChildren::const_iterator i=child_list_begin();
      i!=child_list_end();
      i++){
    CXMLElement* lDereferencedI=*i;
    
    if(lDereferencedI->getName()==mrml_const::algorithm){
      CAlgorithm*  iAlgorithm=(CAlgorithm*)(lDereferencedI);
      cout << "." << flush;
      iAlgorithm->configure(inBaseConfiguration);
    }
  }
  if(getFather()){
    //mergeChildLists(*(CAlgorithm*)(getFather()));
  }
  cout << "4" << flush;
}

void CAlgorithm::mergeAttributes

(

const CAlgorithm &

inAlgorithm

)

merging the attributes of two algorithms. This is useful: 1. for the initial configuration 2. for changing the configuration.

At present this merges attribute lists givig priority to the values in *this.

FIXME: slow way of merging

merging two algorithms.

general rule: if something is contained already in *this the value of *this will be kept.

first: default values.

Definition at line 259 of file CAlgorithm.cc.

References CAttributeList::add(), CAttributeList::check(), CAttributeList::find(), and CXMLElement::mAttributes.

Referenced by configure().

                                                             {
  if(&inAlgorithm){
    //STOOPID way of merging, takes n log n time instead of n
    for(CAttributeList::const_iterator
    i=inAlgorithm.mAttributes.begin();
  i!=inAlgorithm.mAttributes.end();
  i++){
      //add attributes which are not yet found
      if(mAttributes.find(i->first)==mAttributes.end()){
#ifdef SINGLE
  mAttributes.add(i->first,i->second);
#else
  mAttributes.check();
  mAttributes.add(i->first,i->second.first);
#endif
      }
    }
  }
}

void CAlgorithm::mergeChildLists

(

const CAlgorithm &

inAlgorithm

)

merging the child lists of two algorithms. This is useful: 1. for the initial configuration 2. for changing the configuration.

At present this merges attribute lists givig priority to the values in *this.

FIXME: slow way of merging

Definition at line 279 of file CAlgorithm.cc.

References CXMLElement::child_list_begin(), CXMLElement::child_list_end(), and CXMLElement::mChildren.

                                                             {
  if(&inAlgorithm){
    //merge child lists
    copy(inAlgorithm.child_list_begin(),
   inAlgorithm.child_list_end(),
   inserter(mChildren,
      child_list_end()));
  }
}

string CAlgorithm::getCollectionID

(

)

const

get the name of the collection to be treated by this algorithm

Definition at line 81 of file CAlgorithm.cc.

References mrml_const::collection_id, and CXMLElement::stringReadAttribute().

Referenced by CQuery::CQuery(), CQMultiple::setAlgorithm(), CQInvertedFile::setAlgorithm(), and CQHierarchy::setAlgorithm().

                                       {
  return stringReadAttribute(mrml_const::collection_id).second;
};

double CAlgorithm::getWeight

(

)

const

get the name of the algorithm

Definition at line 96 of file CAlgorithm.cc.

References mrml_const::cui_weight, and CXMLElement::doubleReadAttribute().

Referenced by CQueryTreeBuilder::buildQueryTree().

                                 {
  if(doubleReadAttribute(mrml_const::cui_weight).first){
    return (doubleReadAttribute(mrml_const::cui_weight).second);
  }else{
    return 1;
  }
};

string CAlgorithm::getAlgorithmName

(

)

const

get the name of the algorithm

Definition at line 86 of file CAlgorithm.cc.

References mrml_const::algorithm_name, and CXMLElement::stringReadAttribute().

                                        {
  return stringReadAttribute(mrml_const::algorithm_name).second;
};

pair< bool, string > CAlgorithm::getType

(

)

const

get the type of the algorithm

Definition at line 105 of file CAlgorithm.cc.

References mrml_const::algorithm_type, and CXMLElement::stringReadAttribute().

Referenced by CAlgorithmCollection::addAlgorithm(), and configure().

                                          {
  return stringReadAttribute(mrml_const::algorithm_type);
};

pair< bool, string > CAlgorithm::getInheritsFrom

(

)

const

The father inside the configuration

Definition at line 110 of file CAlgorithm.cc.

References CXMLElement::stringReadAttribute().

                                                  {
  return stringReadAttribute("cui-inherits-from");
};

string CAlgorithm::getBaseType

(

)

const

get the basetype of the algorithm

Definition at line 115 of file CAlgorithm.cc.

References mrml_const::cui_base_type, and CXMLElement::stringReadAttribute().

Referenced by CQueryTreeBuilder::buildQueryTree(), CQueryTreeNode::configure(), and configure().

                                   {
  return stringReadAttribute(mrml_const::cui_base_type).second;
};

string CAlgorithm::getID

(

)

const

get the id of the algorithm

Definition at line 91 of file CAlgorithm.cc.

References mrml_const::algorithm_id, and CXMLElement::stringReadAttribute().

Referenced by CQueryTreeBuilder::buildQueryTree(), CSession::setActiveAlgorithm(), toOldMRML(), and CSession::toXML().

                             {
  return stringReadAttribute(mrml_const::algorithm_id).second;
};

string CAlgorithm::toOldMRML

(

)

const

puts out a flat algorithm tag with just ID and name

Definition at line 120 of file CAlgorithm.cc.

References mrml_const::algorithm, mrml_const::algorithm_id, mrml_const::algorithm_name, getID(), and CXMLElement::getName().

                                 {
  return string("<"
    + mrml_const::algorithm 
    + " " 
    + mrml_const::algorithm_name
    + "=\"")
    + getName()
    + "\" " 
    + mrml_const::algorithm_id
    + "=\""
    + getID()
    + "\"/>\n";
};

void CAlgorithm::setDefault

(

CAlgorithm &

inDefault

)

set the default we do not take any destroy responsability

CAlgorithm * CAlgorithm::clone

(

)

const

clone this

clone this

Definition at line 33 of file CAlgorithm.cc.

References CAlgorithm().

Referenced by CAlgorithmCollection::makeAlgorithmByType().

                                  {
  return new CAlgorithm(*this);
};

---

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

• gift/libMRML/include/CAlgorithm.h
• gift/libMRML/cc/CAlgorithm.cc