CAccessorAdmin Class Reference

#include <CAccessorAdmin.h>

List of all members.

Public Member Functions
CAccessor *	openAccessor (string inType)
void	closeAccessor (string inType)
void	setCollectionElement (CXMLElement *)
const CXMLElement *	getCollectionElement () const
const CXMLElement *	getQueryParadigmList () const
list< string > *	getAvailableIndices () const
string	toXML (bool isPrivate=false) const
CXMLElement *	toXMLElement () const
	CAccessorAdmin (CAccessorFactoryContainer &inFactoryContainer)
	~CAccessorAdmin ()
string	getAlgorithmIDListID () const
string	getName () const
string	getID () const
Protected Types
typedef map< string, CContentElement >	CContent
Protected Attributes
CAccessorFactoryContainer &	mFactoryContainer
CSelfDestroyPointer< CXMLElement >	mCollectionElement
CContent	mContent
Friends
class	CSortByName_pAP
Classes
class	CContentElement

---

Detailed Description

CAccessorAdmin: The goal of this is to make it possible to have a list containing accessors to all possible collections, without really opening the accessors.

The accessor proxy is in fact an open/close counter for accessors. This permits multiple query structures to share just one accessor, and it avoids having to open all kinds of accessors when starting the program.

Definition at line 45 of file CAccessorAdmin.h.

---

Member Typedef Documentation

typedef map<string,CContentElement> CAccessorAdmin::CContent [protected]

Typedef: The content is a map of string to content element In this map is noted, which accessors are open for the collection with the given ID.

Definition at line 72 of file CAccessorAdmin.h.

---

Constructor & Destructor Documentation

CAccessorAdmin::CAccessorAdmin

(

CAccessorFactoryContainer &

inFactoryContainer

)

Constructor

Definition at line 42 of file CAccessorAdmin.cc.

                                                                           :
  mFactoryContainer(inFactoryContainer),
  mContent()
{
};

CAccessorAdmin::~CAccessorAdmin

(

)

destructor

Definition at line 152 of file CAccessorAdmin.cc.

References mContent.

                               {
  for(CContent::const_iterator i=mContent.begin();
      i!=mContent.end();
      i++){
    printf("%s:%d:%s,%p\n",__FILE__,__LINE__,"DELETING",i->second.mAccessor);
    delete i->second.mAccessor;
  }
}

---

Member Function Documentation

CAccessor * CAccessorAdmin::openAccessor

(

string

inType

)

open an accessor.

This is the important part for the outside: Open or close inverted file accessors. Several queries can share one accessor, the accessor will be constructed when the first CQuery needs it, and it will be deleted, when the last one does not need it any more:

Definition at line 48 of file CAccessorAdmin.cc.

References mCollectionElement, mContent, mFactoryContainer, and CAccessorFactoryContainer::openAccessor().

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

                                                    {  
  CContent::const_iterator lFound=mContent.find(inName);
  if(lFound==mContent.end()){
    mContent[inName].mOpenCloseCounter=0;
    mContent[inName].mAccessor=0;
  }
  {
    if(!(mContent[inName].mOpenCloseCounter)){
      mContent[inName].mAccessor=mFactoryContainer.openAccessor(inName,
                *mCollectionElement);
      mContent[inName].mOpenCloseCounter++;
      cerr << endl
     << "CAccessorAdmin::openAccessor:"
     << inName << endl
     << " NEWLY GENERATED." << endl;
    }else{
      mContent[inName].mOpenCloseCounter++;
      cerr << endl
     << "CAccessorAdmin::openAccessor:"
     << inName << endl
     << " REUSED. (" << mContent[inName].mOpenCloseCounter++ << " times in use)"<< endl;
    }
    return mContent[inName].mAccessor;
  }
  assert(!"Execution should never arive here");
};

void CAccessorAdmin::closeAccessor

(

string

inType

)

closing an accessor.

See also:

openAccessor

Definition at line 75 of file CAccessorAdmin.cc.

References CAccessorFactoryContainer::closeAccessor(), CMutex::lock(), mContent, mFactoryContainer, and CMutex::unlock().

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

                                               {
  if(gMutex){
    gMutex->lock();
  }
  CContent::iterator lFound=mContent.find(inName);

  cout << __FILE__ << ":" << __LINE__ 
       << "PID:" << getpid()
       << "OpenCloseCounter["
       << inName
       << "]"
       << (mContent[inName].mOpenCloseCounter) << endl;
  
  //this is a hack. See the changelog for thisx
#ifdef __GIFT_FREE_UNUSED_ACCESSORS
  if((lFound!=mContent.end())
     &&
     !(--(mContent[inName].mOpenCloseCounter))){
    delete lFound->second.mAccessor;
    mContent.erase(lFound);

    mFactoryContainer.closeAccessor(inName);
  }
#endif
  if(gMutex){
    gMutex->unlock();
  }
};

void CAccessorAdmin::setCollectionElement

(

CXMLElement *

inElement

)

Once this is working this will replace about every set/get function which follows

Definition at line 34 of file CAccessorAdmin.cc.

References mCollectionElement.

                                                               {
  mCollectionElement=inElement;
};

const CXMLElement * CAccessorAdmin::getCollectionElement

(

)

const

Definition at line 38 of file CAccessorAdmin.cc.

References mCollectionElement.

                                                            {
  return mCollectionElement;
};

const CXMLElement * CAccessorAdmin::getQueryParadigmList

(

)

const

Definition at line 140 of file CAccessorAdmin.cc.

References mCollectionElement.

                                                            {
  for(list<CXMLElement*>::const_iterator i(mCollectionElement->child_list_begin());
      i!=mCollectionElement->child_list_end();
      i++){
    if((*i)->getName()=="query-paradigm-list"){
      return *i;
    }
  }
  return 0;
};

list< string > * CAccessorAdmin::getAvailableIndices

(

)

const

Definition at line 162 of file CAccessorAdmin.cc.

                                                      {
  list<string>* lReturnValue=new list<string>();

  lReturnValue->push_back("inverted_file");

  return lReturnValue;
};

string CAccessorAdmin::toXML

(

bool

isPrivate = false

)

const

generate out put for shandshake message

Definition at line 104 of file CAccessorAdmin.cc.

References CXMLHelper::addAttribute(), mrml_const::collection, mrml_const::collection_id, mrml_const::collection_name, mrml_const::cui_algorithm_id_list_id, getAlgorithmIDListID(), mCollectionElement, CXMLHelper::setEmpty(), CXMLHelper::setName(), and CXMLHelper::toString().

                                               {

  CXMLHelper lHelper;

  lHelper.setName(mrml_const::collection);
  lHelper.setEmpty();
  lHelper.addAttribute(mrml_const::collection_id,mCollectionElement->stringReadAttribute(mrml_const::collection_id).second);
  lHelper.addAttribute(mrml_const::collection_name,mCollectionElement->stringReadAttribute(mrml_const::collection_name).second);
  lHelper.addAttribute(mrml_const::cui_algorithm_id_list_id,getAlgorithmIDListID());
  

  string lReturnValue=lHelper.toString();
  return lReturnValue;
}

CXMLElement * CAccessorAdmin::toXMLElement

(

)

const

pack the content of this into an CXMLElement with elementname "collection"

Definition at line 120 of file CAccessorAdmin.cc.

References mCollectionElement.

                                              {
  CXMLElement* lReturnValue(0);

  if(mCollectionElement){
    lReturnValue=new CXMLElement(*mCollectionElement);
  }

  return lReturnValue;
}

string CAccessorAdmin::getAlgorithmIDListID

(

)

const

Definition at line 130 of file CAccessorAdmin.cc.

References mrml_const::cui_algorithm_id_list_id, and mCollectionElement.

Referenced by toXML().

                                                {
  return mCollectionElement->stringReadAttribute(mrml_const::cui_algorithm_id_list_id).second;
}

string CAccessorAdmin::getName

(

)

const

Definition at line 133 of file CAccessorAdmin.cc.

References mrml_const::collection_name, and mCollectionElement.

                                   {
  return mCollectionElement->stringReadAttribute(mrml_const::collection_name).second;
}

string CAccessorAdmin::getID

(

)

const

Definition at line 136 of file CAccessorAdmin.cc.

References mrml_const::collection_id, and mCollectionElement.

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

---

Friends And Related Function Documentation

friend class CSortByName_pAP [friend]

for sorting

Definition at line 121 of file CAccessorAdmin.h.

---

Member Data Documentation

CAccessorFactoryContainer& CAccessorAdmin::mFactoryContainer [protected]

Factory for making all kinds of accessors

Definition at line 50 of file CAccessorAdmin.h.

Referenced by closeAccessor(), and openAccessor().

CSelfDestroyPointer<CXMLElement> CAccessorAdmin::mCollectionElement [protected]

Definition at line 52 of file CAccessorAdmin.h.

Referenced by getAlgorithmIDListID(), getCollectionElement(), getID(), getName(), getQueryParadigmList(), openAccessor(), CSortByName_pAP::operator()(), setCollectionElement(), toXML(), and toXMLElement().

CContent CAccessorAdmin::mContent [protected]

The content is a map of string to content element

Definition at line 74 of file CAccessorAdmin.h.

Referenced by closeAccessor(), openAccessor(), and ~CAccessorAdmin().

---

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

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