indexlist_impl.h

Go to the documentation of this file.

/**************************************************************
 **
 ** @file index/indexlist_impl.h
 **
 ** Copyright (C) 2012  Xpace, LLC.  All rights reserved
 **
 ** www.xpace.net
 **
 **************************************************************/

#ifndef XPACE_INDEXLIST_IMPL_H
#define XPACE_INDEXLIST_IMPL_H

#include <QtCore/QCache>

#include "base/config.h"

#include "index/indexlist.h"

namespace Xpace
{
  struct loadIndexPools;

  class indexListImpl : public ConfigImpl
  {
  public:
    indexListImpl
      ();

    // open an already-existing index list,
    // or create one with this configuration
    indexListImpl
      (const Configuration& config,   // if reading, config from ii file goes here
       bool overwrite);

    ~indexListImpl
      ();

    // how many indexes
    uint getCount
      ()
      const;

    const Configuration& getIndexConfig
      (uint indexNum)
      const;

    uint getIndexByField
      (const String& tag,
       size_t pos)
      const;

    // get an index by name
    Index& openIndex
      (const String& indexName,
       uint* indexNum,
       Configuration = Configuration());
    const Index& openIndex
      (const String& indexName,
       uint* indexNum,
       Configuration = Configuration())
      const;

    // get an index by number
    Index& openIndex
      (uint indexNum,
       Configuration = Configuration());    
    const Index& openIndex
      (uint indexNum,
       Configuration = Configuration())
      const;  

    // add a named index; return index number
    uint addIndex
      (Index&);

    // add an index by number
    void addIndex
      (uint indexNum,
       Index&);     

    #ifdef XPACE_SCURSOR_H
    // bulk index from SCursor
    bool build
      (SCursor*,
       IndexList::BuildStatus* = 0,
       Index::WriteStatus* = 0);
    #endif

    #ifdef XPACE_TABLE_H
    // bulk index from TableCursor
    bool build
      (Table*,
       IndexList::BuildStatus* = 0,
       Index::WriteStatus* = 0);
    #endif

    // write in current state
    bool write
      (Index::WriteStatus* = 0);

    bool range
      (const Configuration& /*rangeConfig*/,
       Index::WriteStatus* /*status*/)
    {
      // TODO
      return false;
    }

    // merge index lists
    static
    bool merge
      (const Configuration& /*config*/,
       const std::vector<IndexList*>& /*indexLists*/,
       Index::WriteStatus* = 0)
    {
      // TODO
      return false;
    }

    struct indexDesc
    {
      File::Position oStart;
      File::Position oRoot;
      File::Position size;
    };

    // ref-count
    void ref
      ();
    bool unref
      ();

    static size_t HashTableBytes;

  private:
    QAtomicInt ref_count;

    indexListImpl
      (const indexListImpl&);
    indexListImpl& operator=
      (const indexListImpl&);

    Index& find_index
      (size_t indexNum,
       Configuration config)
      const;

    mutable File index_file;
    mutable File index_list_file;

    uint64 doc_count;

    mutable std::vector<Index> index_list;
    mutable std::vector<Configuration> config_list;
    std::map<String, size_t> name_list;
    std::map<String, std::vector<size_t> > field_list;

    struct index_list_header
    {
      index_list_header
        ()
      {
      };
      index_list_header
        (uint16 vers,
         uint16 rel,
         uint64 first,
         uint64 count) :
          version(vers),
          relative(rel),
          firstDoc(first),
          docCount(count)
      {
      };

      uint16 version;
      uint16 relative;   // bool; refs are relative to this list, not database
      uint64 firstDoc;
      uint64 docCount;
    };

    std::vector<indexDesc> index_desc_list;

    loadIndexPools* load_index_pools;
  };
}

#endif