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

---

Directory.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_Directory
#define _lucene_store_Directory


#include "CLucene/util/VoidMapSetDefinitions.h"
#include "CLucene/LuceneThreads.h"
#include <string>

CL_CLASS_DEF(store,Lock)
CL_CLASS_DEF(store,IndexInput)
CL_CLASS_DEF(store,IndexOutput)
CL_CLASS_DEF(store,LockFactory)
CL_CLASS_DEF(store,LuceneLock)

CL_NS_DEF(store)

        class CLUCENE_EXPORT Directory: LUCENE_REFBASE {
        protected:
                LockFactory* lockFactory;
                
                Directory(){
                }
                // Removes an existing file in the directory. 
                virtual bool doDeleteFile(const char* name) = 0;
        public:
                DEFINE_MUTEX(THIS_LOCK)
           
                virtual ~Directory();

                // Returns an null terminated array of strings, one for each file in the directory. 
                char** list() const;
                virtual void list(std::vector<std::string>* names) const = 0;
                       
                // Returns true iff a file with the given name exists. 
                virtual bool fileExists(const char* name) const = 0;

                // Returns the time the named file was last modified. 
                virtual int64_t fileModified(const char* name) const = 0;

                // Returns the length of a file in the directory. 
                virtual int64_t fileLength(const char* name) const = 0;

                // Returns a stream reading an existing file. 
                virtual IndexInput* openInput(const char* name) = 0;
                virtual IndexInput* openInput(const char* name, int32_t bufferSize);

                virtual void touchFile(const char* name) = 0;

                // Removes an existing file in the directory. 
                virtual bool deleteFile(const char* name, const bool throwError=true);
                
                // Renames an existing file in the directory.
                //      If a file already exists with the new name, then it is replaced.
                //      This replacement should be atomic. 
                virtual void renameFile(const char* from, const char* to) = 0;

                // Creates a new, empty file in the directory with the given name.
                //      Returns a stream writing this file. 
                virtual IndexOutput* createOutput(const char* name) = 0;

                // Construct a {@link Lock}.
                // @param name the name of the lock file
                virtual LuceneLock* makeLock(const char* name);

                virtual void clearLock(const char* name);
                
                // Closes the store. 
                virtual void close() = 0;
                
                virtual TCHAR* toString() const = 0;

                virtual const char* getDirectoryType() const = 0;
                
                void setLockFactory( LockFactory* lockFactory );
                
                LockFactory* getLockFactory();
                
                virtual TCHAR* getLockID();
        };
CL_NS_END
#endif

---

clucene.sourceforge.net