System documentation of the GNU Image-Finding Tool

CSessionManager.h

/* -*- mode: c++ -*- 
*/
/* 

    GIFT, a flexible content based image retrieval system.
    Copyright (C) 1998, 1999, 2000, 2001, 2002, CUI University of Geneva

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*/
// -*- mode: c++ -*-
#ifndef _CSESSIONMANAGER
#define _CSESSIONMANAGER
#include "libMRML/include/uses-declarations.h"
#include <iostream>
#include <string>
#include <list>
#include <map>
#include "libMRML/include/CXMLElement.h"
#include "libMRML/include/CAccessorAdminCollection.h"
#include "libMRML/include/CI18nTranslator.h"
#include "libMRML/include/CAlgorithm.h"
#include "libMRML/include/CPropertySheetList.h"
#include "libMRML/include/CAccessorElement.h"
#include "libMRML/include/CAlgorithmCollection.h"
#include "libMRML/include/CQueryTreeBuilder.h"
#include "libMRML/include/CMutex.h" // multithreading
class CStaticQueryFactory;
class CAlgorithm;
class CSessionManager;
class CQueryTreeNode;
class CStaticQueryFactory;
class CSession{
protected:
  string mPreferredLanguage;
  typedef list<string> CLanguageList;
  CLanguageList mLanguages;
  CMutex mMutexSession;
  bool mIsOpen;
  string mUser;
  string mID;
  string mSessionName;
  CAlgorithm* mActiveAlgorithm;
  pair<CQueryContainer*,CQueryTreeNode*> mQueryTree;
  static CQueryTreeBuilder mQueryTreeBuilder;
public:
  //--------------------------------------------------
  CSession();
  CSession(string inUser,
           string inID,
           string inSessionName,
           CAlgorithm* inActiveAlgorithm
           );
  ~CSession();
  //--------------------------------------------------
  ostream& write(ostream& outStream)const;
  istream& read(istream& inStream);
  //--------------------------------------------------
  string getUser()const;
  void setUser(const string& inUser);
  string getID()const;
  void setID(const string& inID);
  string getSessionName()const;
  void setSessionName(const string& inSessionName);
  CAlgorithm* getActiveAlgorithm();
  bool setActiveAlgorithm(CAccessorAdminCollection& inCaller,
                          CAlgorithmCollection& inAlgorithmCollection,
                          CAlgorithm* inActiveAlgorithm,
                          CStaticQueryFactory& inBaseTypeFactory);
  //string  getActiveCollection()const;
  //  void setActiveCollection(const string& inCollection);
  //--------------------------------------------------
  CXMLElement* query(CSessionManager&     inCaller,
                     const CXMLElement& inQuery);
  //--------------------------------------------------
  CXMLElement* getRandomImages(CSessionManager& inCaller,
                                       const string& inAlgorithm,
                                       int inResultSize);
  
  //--------------------------------------------------
  bool open();
  //--------------------------------------------------
  bool close();
  //--------------------------------------------------
  bool rename(const string& inName);
  void CSession::clearLanguages();
  void CSession::addLanguage(string inLanguageCode);
  void CSession::commitLanguages(const CI18nTranslator& inTranslator);
  list<string> CSession::getLanguages()const;
  string CSession::getPreferredLanguage()const;

  //--------------------------------------------------
  string toXML(bool isPrivate)const;
};

class CSessionManager:public CAlgorithmCollection
                      //,public CAlgorithmIDListList
{
  CMutex mMutexSessionManager;
protected:
  CAccessorAdminCollection mAccessorAdminCollection;
  CI18nTranslator mI18nTranslator;
  typedef map<string,list<CSession> >   CUserToSessions;
  typedef map<string,CSession*>         CIDToSession;
  mutable CUserToSessions mUserToSessions;
  mutable CIDToSession    mIDToSession;
  CPropertySheetList* mPropertySheetList;
  CXMLElement* mPropertySheetSubtree;
  CStaticQueryFactory* mBaseTypeFactory;
public:
  CSessionManager(string inSessions,
                  string inConfiguration,
                  string inI18nFileName);
  //----------------------------------------
  CQuery* makeQuery(const string& inBaseType,
                    CAlgorithm& inAlgorithm);
  //----------------------------------------
  istream& read(istream&);
  ostream& write(ostream&);
  //----------------------------------------
  CXMLElement* openSession(string inUserName,
                           string inSessionID,
                           string inSessionName);
  //----------------------------------------
  CXMLElement* renameSession(string inSessionID,
                             string inSessionName);
  CXMLElement* deleteSession(string inSessionID);
  CXMLElement* closeSession(string inSessionID);
  CXMLElement* query(const string& inSessionID,
                     const CXMLElement& inRelevanceLevelList);
  //--------------------------------------------------
  CXMLElement* getRandomImages(const string& inSessionID,
                               const string& inAlgorithm,
                               int inResultSize);
  //--------------------------------------------------
  list<CAccessorElement>* getAllAccessorElements(const string& inSessionID,
                                                 const string& inAlgorithm
                                                 );
  //--------------------------------------------------
  list<TID>* getAllIDs(const string& inSessionID,
                       const string& inAlgorithm
                       );
  //----------------------------------------
  bool setAlgorithm(const string& inSessionID,
                    CAlgorithm* inAlgorithm);
  string newSession(const string& inUser,
                    const string& inSessionName);
  string newSession(const string& inID,
                    const string& inUser,
                    const string& inSessionName);
  void setSessionName(const string& inOldSessionName,
                      const string& inNewSessionName);
  //----------------------------------------
  //----------------------------------------
  string toXML(bool isPrivate=false)const;
  string toXMLSessions(const string& inUser,
                       bool isPrivate=false)const;
  string toXMLSessionConfiguration()const;
  pair<string,string> toXMLHandshake(const string& inUser);
  CXMLElement* getPropertySheet(string inSessionID,
                                string inAlgorithmID)const;
  //----------------------------------------
  void startPropertySheetSubtree();
  CXMLElement* getPropertySheetSubtree();
  void endPropertySheetSubtree();
  CXMLElement* getCollections()const;
  CXMLElement* getAlgorithms()const;
  bool clearSessionLanguages(const string& inSessionID);
  bool addSessionLanguage(const string& inSessionID,
                          const string& inLanguageCode);
  bool commitSessionLanguages(const string& inSessionID);
  list<string> getSessionLanguages(const string& inSessionID)const;
  void CSessionManager::translate(string inSessionID,
                                  CXMLElement& inoutToBeTranslated)const;
};

#endif

---

Need for discussion? Want to contribute? Contact