be_io_dbrecstore.h

Go to the documentation of this file.

/******************************************************************************
 * This software was developed at the National Institute of Standards and
 * Technology (NIST) by employees of the Federal Government in the course
 * of their official duties. Pursuant to title 17 Section 105 of the
 * United States Code, this software is not subject to copyright protection
 * and is in the public domain. NIST assumes no responsibility whatsoever for
 * its use by other parties, and makes no guarantees, expressed or implied,
 * about its quality, reliability, or any other characteristic.
 ******************************************************************************/
#ifndef __BE_DBRECSTORE_H__
#define __BE_DBRECSTORE_H__
 
#include <be_io_recordstore.h>
 
/*
 * This file contains the class declaration for an implementation of a
 * RecordStore using a on-disk database.
 */
namespace BiometricEvaluation {
 
        namespace IO {
 
                class DBRecordStore : public RecordStore {
                public:
 
                        DBRecordStore(
                            const std::string &pathname,
                            const std::string &description);
 
                        DBRecordStore(
                            const std::string &pathname,
                            IO::Mode mode = IO::Mode::ReadOnly);
 
                        /*
                         * Destructor.
                         */
                        ~DBRecordStore();
 
                        /*
                         * Implementation of the RecordStore interface.
                         */
 
                        /*
                         * We need the base class insert() and replace() as well
                         * otherwise, they are hidden by the declarations below.
                         */
                        using RecordStore::insert;
                        using RecordStore::replace;
 
                        Memory::uint8Array
                        read(
                            const std::string &key) const override;
 
                        void insert(
                            const std::string &key,
                            const void *const data,
                            const uint64_t size)
                            override;
 
                        void remove(
                            const std::string &key)
                            override;
 
                        uint64_t length(
                            const std::string &key) const override;
 
                        void flush(
                            const std::string &key) const override;
 
                        RecordStore::Record sequence(
                            int cursor = BE_RECSTORE_SEQ_NEXT)
                            override;
 
                        std::string
                        sequenceKey(
                            int cursor = BE_RECSTORE_SEQ_NEXT)
                            override;
 
                        void setCursorAtKey(
                            const std::string &key)
                            override;
 
                        void move(
                            const std::string &pathname)
                            override;
 
                        uint64_t getSpaceUsed() const override;
                        void sync() const override;
                        unsigned int getCount() const override;
                        std::string getPathname() const override;
                        std::string getDescription() const override;
                        void changeDescription(
                            const std::string &description) override;
 
                        /* Prevent copying of DBRecordStore objects */
                        DBRecordStore(const DBRecordStore&) = delete;
                        DBRecordStore& operator=(const DBRecordStore&) = delete;
 
                private:
                        class Impl;
                        std::unique_ptr<DBRecordStore::Impl> pimpl;
                };
        }
}
#endif  /* __BE_DBRECSTORE_H__ */