CLucene - a full-featured, c++ search engine
API Documentation

---

FSDirectory.h

Go to the documentation of this file.

/*------------------------------------------------------------------------------
* Copyright (C) 2003-2006 Ben van Klinken and the CLucene Team
* 
* Distributable under the terms of either the Apache License (Version 2.0) or 
* the GNU Lesser General Public License, as specified in the COPYING file.
------------------------------------------------------------------------------*/
#ifndef _lucene_store_FSDirectory_
#define _lucene_store_FSDirectory_


#include "Directory.h"
#include "IndexInput.h"
#include "IndexOutput.h"
#include <string>
#include <vector>

//#include "Lock.h"
//#include "LockFactory.h"
//#include "CLucene/util/VoidMap.h"
CL_CLASS_DEF(util,StringBuffer)

   CL_NS_DEF(store)

        class CLUCENE_EXPORT FSDirectory:public Directory{
        private:
                class FSIndexOutput;
                class FSIndexInput;
                friend class FSDirectory::FSIndexOutput;
                friend class FSDirectory::FSIndexInput;

        protected:
                FSDirectory(const char* path, const bool createDir, LockFactory* lockFactory=NULL);
        private:
                char* directory;
                char* lockDir;
                int refCount;
                void create();
                
                static const char* LOCK_DIR;
                static const char* getLockDir();
                char* getLockPrefix() const;
                static bool disableLocks;

                void priv_getFN(char* buffer, const char* name) const;
                bool useMMap;

        protected:
                bool doDeleteFile(const char* name);

        public:
                ~FSDirectory();

                void list(std::vector<std::string>* names) const;

                bool fileExists(const char* name) const;

                const char* getDirName() const; 
                

                static FSDirectory* getDirectory(const char* file, const bool create, LockFactory* lockFactory=NULL);

                int64_t fileModified(const char* name) const;
                       
                //static
                static int64_t fileModified(const char* dir, const char* name);

                //static
                int64_t fileLength(const char* name) const;

                IndexInput* openInput(const char* name);
                IndexInput* openInput(const char* name, int32_t bufferSize);

                IndexInput* openMMapFile(const char* name, int32_t bufferSize=LUCENE_STREAM_BUFFER_SIZE);

                void renameFile(const char* from, const char* to);

        void touchFile(const char* name);

                IndexOutput* createOutput(const char* name);

      void close();

          void setUseMMap(bool value){ useMMap = value; }
          bool getUseMMap() const{ return useMMap; }

          TCHAR* toString() const;

          static const char* DirectoryType(){ return "FS"; }
          const char* getDirectoryType() const{ return "FS"; }
        
        static void setDisableLocks(bool doDisableLocks) { disableLocks = doDisableLocks; }
        
        static bool getDisableLocks() { return disableLocks; }

  };

CL_NS_END
#endif

---

clucene.sourceforge.net