cde/programs/dtinfo/DtMmdb/dstr/index_agent.h

   1 /*
   2  * CDE - Common Desktop Environment
   3  *
   4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
   5  *
   6  * These libraries and programs are free software; you can
   7  * redistribute them and/or modify them under the terms of the GNU
   8  * Lesser General Public License as published by the Free Software
   9  * Foundation; either version 2 of the License, or (at your option)
  10  * any later version.
  11  *
  12  * These libraries and programs are distributed in the hope that
  13  * they will be useful, but WITHOUT ANY WARRANTY; without even the
  14  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE. See the GNU Lesser General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with these librararies and programs; if not, write
  20  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  21  * Floor, Boston, MA 02110-1301 USA
  22  */
  23 /*
  24  * $XConsortium: index_agent.h /main/3 1996/06/11 17:17:20 cde-hal $
  25  *
  26  * Copyright (c) 1993 HAL Computer Systems International, Ltd.
  27  * All rights reserved.  Unpublished -- rights reserved under
  28  * the Copyright Laws of the United States.  USE OF A COPYRIGHT
  29  * NOTICE IS PRECAUTIONARY ONLY AND DOES NOT IMPLY PUBLICATION
  30  * OR DISCLOSURE.
  31  *
  32  * THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE
  33  * SECRETS OF HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.  USE,
  34  * DISCLOSURE, OR REPRODUCTION IS PROHIBITED WITHOUT THE
  35  * PRIOR EXPRESS WRITTEN PERMISSION OF HAL COMPUTER SYSTEMS
  36  * INTERNATIONAL, LTD.
  37  *
  38  *                         RESTRICTED RIGHTS LEGEND
  39  * Use, duplication, or disclosure by the Government is subject
  40  * to the restrictions as set forth in subparagraph (c)(l)(ii)
  41  * of the Rights in Technical Data and Computer Software clause
  42  * at DFARS 252.227-7013.
  43  *
  44  *          HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.
  45  *                  1315 Dell Avenue
  46  *                  Campbell, CA  95008
  47  *
  48  */
  49
  50
  51
  52 #ifndef _index_agent_h
  53 #define _index_agent_h 1
  54
  55 #include  "utility/funcs.h"
  56 #include  "utility/ostring.h"
  57 #include  "dynhash/data_t.h"
  58
  59 //**************************************************************
  60 // A abstract index_agent class
  61 //**************************************************************
  62
  63 class index_agent {
  64
  65 public:
  66    index_agent() ;
  67    virtual ~index_agent() ;
  68
  69    virtual Boolean insert(data_t& v) = 0;  // insert a key
  70    virtual Boolean remove(data_t& v) = 0;  // remove a key
  71    virtual Boolean member(data_t& v) = 0; // member test
  72    virtual void clean() = 0;               // remove all keys
  73
  74    virtual int no_keys() const { return n; }; // return key set size
  75
  76    virtual ostream& asciiOut(ostream& out) = 0;
  77    virtual istream& asciiIn(istream& in) = 0;
  78
  79 protected:
  80    unsigned int n;          // current key set size
  81
  82 };
  83
  84 #endif