/*
 * CDE - Common Desktop Environment
 *
 * Copyright (c) 1993-2012, The Open Group. All rights reserved.
 *
 * These libraries and programs are free software; you can
 * redistribute them and/or modify them under the terms of the GNU
 * Lesser General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * These libraries and programs are distributed in the hope that
 * they will be useful, but WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with these libraries and programs; if not, write
 * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301 USA
 */
/*
 * $XConsortium: mphf_index.h /main/5 1996/07/18 14:39:04 drk $
 *
 * Copyright (c) 1993 HAL Computer Systems International, Ltd.
 * All rights reserved.  Unpublished -- rights reserved under
 * the Copyright Laws of the United States.  USE OF A COPYRIGHT
 * NOTICE IS PRECAUTIONARY ONLY AND DOES NOT IMPLY PUBLICATION
 * OR DISCLOSURE.
 * 
 * THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE
 * SECRETS OF HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.  USE,
 * DISCLOSURE, OR REPRODUCTION IS PROHIBITED WITHOUT THE
 * PRIOR EXPRESS WRITTEN PERMISSION OF HAL COMPUTER SYSTEMS
 * INTERNATIONAL, LTD.
 * 
 *                         RESTRICTED RIGHTS LEGEND
 * Use, duplication, or disclosure by the Government is subject
 * to the restrictions as set forth in subparagraph (c)(l)(ii)
 * of the Rights in Technical Data and Computer Software clause
 * at DFARS 252.227-7013.
 *
 *          HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.
 *                  1315 Dell Avenue
 *                  Campbell, CA  95008
 * 
 */


#ifndef _mphf_index_h
#define _mphf_index_h 1

#include "utility/funcs.h"
#include "index/index.h"
#include "index/fast_mphf.h"
#include "index/inv_lists.h"

/**********************************************************/
// An index class consisted of a MPHF object and an 
// inverted list.
/**********************************************************/
class mphf_index : public c_index
{

public:
   mphf_index() ;
   virtual ~mphf_index() ;

   void init_data_member(fast_mphf_handler*, inv_lists_handler*);

   MMDB_SIGNATURES(mphf_index);

// insert index functions
   virtual Boolean batch_index_begin() ;
   virtual Boolean batch_index_end() ;
   virtual Boolean insert_key_loc(const handler&, const oid_t&) ;
   virtual Boolean insert_key_loc(const oid_t&, const oid_t&) ;
   virtual Boolean load(const char* key_set) ;
  
// remove index functions
   virtual Boolean remove_loc(handler&, const oid_t& ) ;
   virtual Boolean remove_loc(const oid_t&, const oid_t& );

// update index function
   virtual Boolean update_streampos(handler& old_obj,     
                                    handler& new_obj,
                                    mmdb_pos_t pos
                                   ) ;

// retrieval functions
   virtual oid_list_handler* get_loc_list(const oid_t&);
   virtual oid_list_handler* get_loc_list(const handler&);
   virtual int invlist_length(handler&) ;

   virtual oid_t first_of_invlist(int ind);
   virtual oid_t first_of_invlist(const handler&);

//
   size_t handler_to_inv_idx(const handler& query);

// status inquiry functions
   virtual Boolean sorted() const { return false; };  

// io function
   friend ostream& operator <<(ostream&, mphf_index&);

protected:

protected:
   fstream* v_key_loc_pair_out;

private:
   fast_mphf_handler *v_mphf;     // hash func

   char* f_key_file_name; 
};
   
HANDLER_SIGNATURES(mphf_index)

#endif