FormatterStorage.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/*
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

#ifndef LSST_MWI_PERSISTENCE_FORMATTER_STORAGE_H
#define LSST_MWI_PERSISTENCE_FORMATTER_STORAGE_H

#include <memory>
#include <map>
#include <string>
#include <typeinfo>

#include "lsst/daf/base/Citizen.h"
#include "lsst/pex/policy.h"

namespace lsst {
namespace daf {
namespace persistence {

class LogicalLocation;

class FormatterStorage : public lsst::daf::base::Citizen {
public:
    typedef std::shared_ptr<FormatterStorage> Ptr;
    typedef std::vector<Ptr> List;

    virtual ~FormatterStorage(void);

    virtual void setPolicy(lsst::pex::policy::Policy::Ptr policy) = 0;

    virtual void setPersistLocation(LogicalLocation const& location) = 0;

    virtual void setRetrieveLocation(LogicalLocation const& location) = 0;

    virtual void startTransaction(void) = 0;
    virtual void endTransaction(void) = 0;

    static Ptr createInstance(std::string const& name,
                              LogicalLocation const& location,
                              bool persist,
                              lsst::pex::policy::Policy::Ptr policy);

protected:
    explicit FormatterStorage(std::type_info const& type);

    void verifyPathName(std::string const& pathName);

private:
    // Do not copy or assign a FormatterStorage instance.
    FormatterStorage(FormatterStorage const&);
    FormatterStorage& operator=(FormatterStorage const&);
};

}}} // lsst::daf::persistence


#endif