CQHierarchy Class Reference

#include <CQHierarchy.h>

Inheritance diagram for CQHierarchy:

List of all members.

Public Member Functions
	CQHierarchy ()
	~CQHierarchy ()
	CQHierarchy (CAccessorAdminCollection &inAccessorAdminCollection, CAlgorithm &inAlgorithm)
virtual CIDRelevanceLevelPairList *	fastQuery (const CXMLElement &inQuery, int inNumberOfInterestingImages, double inDifferenceToBest)
virtual bool	setAlgorithm (CAlgorithm &inAlgorithm)
Protected Member Functions
void	init ()
Protected Attributes
list< TID >	mCurrentPath

---

Detailed Description

This is a simple hierarchy based browser.

: Wolfgang Müller

Definition at line 80 of file CQHierarchy.h.

---

Constructor & Destructor Documentation

CQHierarchy::CQHierarchy

(

)

default constructor

default constructor SHOULD NOT BE CALLED

Definition at line 44 of file CQHierarchy.cc.

                        {
  assert(0);
};

CQHierarchy::~CQHierarchy

(

)

we need to unregister the accessors used

destructor: at present empty

Definition at line 72 of file CQHierarchy.cc.

                         {

  cout << "destroying this "
       << __FILE__
       << __LINE__
       << flush
       << endl;

  //i thought i will need this, but at present I do not have this impression
  //it does not hurt, so we leave it in
};

CQHierarchy::CQHierarchy	(	CAccessorAdminCollection &	inAccessorAdminCollection,
		CAlgorithm &	inAlgorithm
	)

In fact, what we are doing here is to get ourselves an accessor ACURL2FTS to do a proper fastQuery

constructor see CQuery

Definition at line 51 of file CQHierarchy.cc.

References init(), CQuery::mAccessor, CQuery::mAccessorAdmin, and CAccessorAdmin::openAccessor().

00052                                         :
00053   CQuery(inAccessorAdminCollection,
00054    inAlgorithm){
00055   {
00056 
00057     // mproxy has been filled in a reasonable way 
00058     // by CQuery::CQuery
00059     mAccessor=mAccessorAdmin->openAccessor("hierarchy");
00060 
00061     init();
00062 
00063     assert(mAccessor);
00064   }
00065 };
    

---

Member Function Documentation

void CQHierarchy::init

(

)

[protected, virtual]

sets mCurrentPosition to 0

There is no special initialisation to do, so this function is empty

Implements CQuery.

Definition at line 35 of file CQHierarchy.cc.

References mCurrentPath.

Referenced by CQHierarchy().

                      {
  mCurrentPath.clear();
};

CIDRelevanceLevelPairList * CQHierarchy::fastQuery	(	const CXMLElement &	inQuery,
		int	inNumberOfInterestingImages,
		double	inDifferenceToBest
	)			[virtual]

enables moving in the hierarchy. You can either move down (i.e. you select an image) or up in the hierarchy (by getting a cui-hierarchy-move-up signal as query). RICHLY COMMENTED IN THE *.cc FILE.

Parameters:

	inQuery	an CXMLElement containing a query-step element
	inNumberOfInterestingImages	preferred number of result images (ignored)
	inDifferenceToBest	preferred relevance cutoff (ignored)

Implements CQuery.

Definition at line 107 of file CQHierarchy.cc.

References CXMLElement::child_list_begin(), CXMLElement::child_list_end(), mrml_const::cui_hierarchy_up, mrml_const::image_location, CQuery::mAccessor, mCurrentPath, CAccessor::URLToID(), mrml_const::user_relevance, mrml_const::user_relevance_element, and mrml_const::user_relevance_element_list.

                                       {

  CIDRelevanceLevelPairList* lReturnValue(0);

  /*
    AS FOR ANY CALL TO FASTQUERY
    the inQuery parameter contains a "query-step" element.
    
    we are interested in children that contain
    a "relevance-level-element-list" or a 
    "cui-hierarchy-up" element.
   */
  for(list<CXMLElement*>::const_iterator i=inQuery.child_list_begin();
      i!=inQuery.child_list_end();
      i++){// iterating over all the children of the inQuery element.

     cout << "I:The name of this tree element: "
   << endl
   << (*i)->getName()
   << endl;
     if((*i)->getName()==mrml_const::cui_hierarchy_up){
       // this is when a cui-hierarchy-up element was found
       if(mCurrentPath.size()){
   cout << "MOVING UP ";
   copy(mCurrentPath.begin(),
        mCurrentPath.end(),
        ostream_iterator<TID>(cout,","));
   cout << endl;       
   mCurrentPath.pop_back();
   copy(mCurrentPath.begin(),
        mCurrentPath.end(),
        ostream_iterator<TID>(cout,","));
   return ((CAcHierarchy*)mAccessor)->getChildren(mCurrentPath);
       }
       return new CIDRelevanceLevelPairList();
     }
     if((*i)->getName()==mrml_const::user_relevance_element_list){
       // if an user-relevance-element-list was found       
       for(list<CXMLElement*>::const_iterator j=(*i)->child_list_begin();
     j!=(*i)->child_list_end();
     j++){//iterate over all the children
   cout << "J:The name of this tree element: "
        << endl
        << (*j)->getName()
        << endl;
   if((*j)->getName()==mrml_const::user_relevance_element){
     // if the current child is a user-relevance-element
     if(((*j)->stringReadAttribute(mrml_const::image_location).first)
        &&
        ((*j)->stringReadAttribute(mrml_const::user_relevance).first)){
       // get the image-location and the user-relevance attributes
       if((*j)->doubleReadAttribute(mrml_const::user_relevance).second){
         //the relevance of this element != 0
         if(!lReturnValue){
     // if the return value is still undefined
     // (i.e. there was no previous element with (user-relevance != 0)
     list<TID> lOldCurrentPath=mCurrentPath;
     // add this element to the path
     mCurrentPath.push_back(mAccessor->URLToID((*j)->stringReadAttribute(mrml_const::image_location).second).second);
     
     cout << "The new mCurrentPath: ";
     copy(mCurrentPath.begin(),
          mCurrentPath.end(),
          ostream_iterator<TID>(cout,","));
     cout << endl;
     
     // get the children of this node from the accessor
     lReturnValue=((CAcHierarchy*)mAccessor)->getChildren(mCurrentPath);
     if(lReturnValue){// if there are children:
       // return them
       return lReturnValue;
     }else{
       // if not:
       // take the old path, get it's children, and return them
       mCurrentPath=lOldCurrentPath;
       lReturnValue=((CAcHierarchy*)mAccessor)->getChildren(mCurrentPath);
       return lReturnValue;
     }
         }
       }
     }
   }
       }
     }
  }
  // if nothing else was found,
  // display the first selection:
  mCurrentPath.clear();// clear the path
  return ((CAcHierarchy*)mAccessor)->getChildren(mCurrentPath);//children of root node
};

bool CQHierarchy::setAlgorithm

(

CAlgorithm &

inAlgorithm

)

[virtual]

set the Algorithm.

Reimplemented from CQuery.

Definition at line 85 of file CQHierarchy.cc.

References CAccessorAdmin::closeAccessor(), CAlgorithm::getCollectionID(), CAccessorAdminCollection::getProxy(), CQuery::mAccessor, CQuery::mAccessorAdmin, CQuery::mAccessorAdminCollection, CQuery::mAlgorithm, CAccessorAdmin::openAccessor(), and CQuery::setAlgorithm().

                                                      {
  if(mAlgorithm && mAlgorithm->getCollectionID()==inAlgorithm.getCollectionID()){
    
    return true;
    
  }else{
    //close the old collection, if exsisting
    if(mAccessorAdmin)
      mAccessorAdmin->closeAccessor("hierarchy");
    //
    mAccessorAdmin=&mAccessorAdminCollection->getProxy(inAlgorithm.getCollectionID());
    mAccessor=mAccessorAdmin->openAccessor("hierarchy");
    
    assert(mAccessor);
    //
    return (CQuery::setAlgorithm(inAlgorithm) && mAccessor);
  }
};

---

Member Data Documentation

list<TID> CQHierarchy::mCurrentPath [protected]

The current position in the hierarchy

Definition at line 84 of file CQHierarchy.h.

Referenced by fastQuery(), and init().

---

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

• gift/libGIFTQuHierarchy/include/CQHierarchy.h
• gift/libGIFTQuHierarchy/cc/CQHierarchy.cc