Index.h

#ifndef __INDEX_H__
#define __INDEX_H__

// tools
#include "tools/ToolsConfig.h"

// storage
#include "storage/NameHash.h"
#include "storage/RTree.h"



class Index {

public:

  Index();

  virtual ~Index();

  enum ReadWrite { 
    ReadOnly, 
    ReadAndWrite  
  };
    
  virtual void open(const stdString &filename,
                    ReadWrite readwrite=ReadOnly) = 0;
                
    const std::string& getFilename()
    {   return filename; }

    const std::string& getDirectory()
    {   return dirname; }
    
    const stdString &getFullName()
    {   return fullname; }

    virtual void close() = 0;
    
    class Result
    {
    public:

        Result(RTree *tree, const stdString &directory);

        ~Result();

        RTree *getRTree() const
        {   return tree; }
        
        const stdString &getDirectory() const
        {   return directory; }
        
    private:

        // This class maintains the RTree pointer. Prohibit copy.
        PROHIBIT_DEFAULT_COPY(Result);

        RTree *tree;
        stdString directory;
    };
    
    virtual Result *addChannel(const stdString &channel) = 0;

    virtual Result *findChannel(const stdString &channel) = 0;
    
    class NameIterator {

    public:
        virtual ~NameIterator();
        
        virtual bool isValid() const = 0;
        
        virtual const stdString &getName() const = 0;
        
        virtual void  next() = 0;
    };

    virtual NameIterator *iterator() = 0;

protected:

    PROHIBIT_DEFAULT_COPY(Index);
    
    void setFilename(const stdString &full_name);
    
    void clearFilename();
    
private:

    stdString filename;
    
    stdString dirname;

    stdString fullname;
};


#endif