OW_Index.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_INDEX_HPP_INCLUDE_GUARD_
#define OW_INDEX_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_String.hpp"
#include "OW_IntrusiveReference.hpp"
#include "OW_IntrusiveCountableBase.hpp"

namespace OW_NAMESPACE
{

struct IndexEntry;
class Index;
typedef IntrusiveReference<Index> IndexRef;

class OW_HDB_API Index : public IntrusiveCountableBase
{
public:
   virtual ~Index();
   enum EDuplicateKeysFlag
   {
      E_NO_DUPLICATES,
      E_ALLDUPLICATES
   };
   virtual void open(const char* fileName, EDuplicateKeysFlag allowDuplicates = E_NO_DUPLICATES) = 0;
   virtual void close() = 0;
   virtual IndexEntry findFirst(const char* key=0) = 0;
   virtual IndexEntry findNext() = 0;
   virtual IndexEntry findPrev() = 0;
   virtual IndexEntry find(const char* key) = 0;
   virtual bool add(const char* key, Int32 offset) = 0;
   virtual bool remove(const char* key, Int32 offset=-1L) = 0;
   virtual bool update(const char* key, Int32 newOffset) = 0;
   virtual void flush();
   static IndexRef createIndexObject();
};
struct OW_HDB_API IndexEntry
{
   IndexEntry() : key(), offset(-1) {}
   IndexEntry(const String& k, Int32 o) :
      key(k), offset(o) {}

   typedef Int32 IndexEntry::*safe_bool;
   operator safe_bool() const { return (offset != -1 && !key.empty()) ? &IndexEntry::offset : 0; }
   bool operator!() const { return !(offset != -1 && !key.empty()); }
   String key;
   Int32 offset;
};

} // end namespace OW_NAMESPACE

#endif

---