File: CQuery.h

package info (click to toggle)
gnuift 0.1.14%2Bds-1
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 5,632 kB
  • ctags: 2,973
  • sloc: cpp: 15,867; sh: 8,281; ansic: 1,812; perl: 1,007; php: 651; makefile: 483; lisp: 344
file content (231 lines) | stat: -rw-r--r-- 5,605 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
/* -*- mode: c++ -*- 
*/
/* 

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

     Copyright (C) 2003, 2004 Bayreuth University
      2005 Bamberg University
    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++ -*- 

#include "libMRML/include/CAccessorElement.h"
#include "libMRML/include/CXMLElement.h"
/**
 *
 * CQuery.h 
 * (abstract) parent of query structures.
 * Goal of this structure is to process a query
 * and to digest within--session feedback
 * this tries not to contain anything application 
 * specific
 *
*
*
* modification history:
*
* WM 19990805 creation
*
*
*
* compiler defines used:
* _CQUERY avoids double inclusion
*
*/
#ifndef _CQUERY
#define _CQUERY
#include "libMRML/include/uses-declarations.h"
#include <memory>
#include <map>
#include "libMRML/include/CSelfDestroyPointer.h"
#include "libMRML/include/CIDRelevanceLevelPairList.h"
#include "libMRML/include/CXMLElement.h"

//#include "CWeightingFunctionPointerList.h"
//#include "CWeightingFunctionPointerHash.h"

#include "libMRML/include/CAlgorithm.h"
#include "libMRML/include/CAccessor.h"
#include "libMRML/include/CAccessorAdminCollection.h"
#include "libMRML/include/CAccessorAdmin.h"
#include "libMRML/include/CMagic.h" //public CMagic

class CScoreBoard;
class CAccessor;


/** The Query manager for Queries on inverted Files */
class CQuery:public CMagic{

protected:
  /**  
       needed to translate URLs to IDs 
       this is a pointer, only because we cannot change references 
       it does not imply any destruction responsability 
  */
  CAccessor* mAccessor;
  /** 
      This is where the the Accessor comes from.
      Also the AccessorAdmin is not to be deleted by this.
  */
  CAccessorAdmin* mAccessorAdmin;
  /**  
       Where to get CAccessorAdmins from.
	 
  */
  CAccessorAdminCollection* mAccessorAdminCollection;


  /**  the structure containing everything we know about the algorithm 
       used 
       do not destroy this
  */
  CAlgorithm* mAlgorithm;
  
  /** A child of this.
      We want to store the child together with a weight.
  */
  class lCChild{
  public:
    /** the child itself */
    CQuery* mQuery;
    /** the weight */
    double  mWeight;
  };
  /** type for children of this */
  typedef list<lCChild> lCChildren;
  /** The children of this.
   */
  lCChildren mChildren;
  
  

protected:
  /**
   *
   * Initializer, used by both construcors
   *
   */
  virtual void init()=0;
    
public:
  /**
   *
   * default constructor
   * 
   */
  CQuery();
  /**
   *
   * destructor
   * 
   */
  virtual ~CQuery();
  /**
   *
   * this constructor takes all the information ANY CQuery needs
   * to configure itself.
   *
   * inAccessorAdminCollection The CQuery needs to know where to get the right
   *                      accessor from.
   * inAlgorithm          This structure contains all the information
   *                      about the algorithm, including which accessor
   *                      to get.
   * 
   */
  CQuery(CAccessorAdminCollection& inAccessorAdminCollection,
	 CAlgorithm&          inAlgorithm);
    
  /** adding a child to this. We expect children to be 
      nonzero and initialised when they are entered. 
      *this assumes no destruction responsabilities for the entered
      data. 
   */
  void addChild(CQuery* inChild,
		double inWeight=1);


  /**
   *
   * do a query
   *
   */
  virtual CXMLElement* query(const CXMLElement& inQuery);
  
  /**
   *
   * @short a query which returns ID/RelevanceLevel pairs instead of
   * instead of URL/RelevanceLevel pairs
   *
   */
  virtual CIDRelevanceLevelPairList* fastQuery(const CXMLElement& inQuery,
					       int inNumberOfInterestingImages,
					       double inDifferenceToBest)=0;

  /**
   *
   * get some random images (handed through to accessor)
   *
   */
  virtual CXMLElement* getRandomImages(int inNumberOfInterestingImages)const;
  /**
   *
   * get some random images (handed through to accessor)
   *
   */
  virtual CIDRelevanceLevelPairList* getRandomIDs(int inNumberOfInterestingImages)const;
  /**
   *
   * get the IDs of all images (handed through to accessor)
   *
   */
  virtual list<TID>* getAllIDs()const;
  /**
   *
   * get the IDs of all images (handed through to accessor)
   *
   */
  virtual list<CAccessorElement>* getAllAccessorElements()const;
  /**
   *
   * set the Algorithm.
   * set a new algorithm. Build a new query if necessary.
   *
   */
  virtual bool setAlgorithm(CAlgorithm& inAlgorithm);
  /**
   *
   * get the Algorithm.
   * same scheme as in setCollection
   *
   */
  const CAlgorithm& getAlgorithm()const;

  /**
     it might be necessary to wait until all the children
     are added before ending the initialisation phase.

     This function is called by CAlgorithm.

   */
   virtual void finishInit();
     
}; /* end of class */

#endif