Formatter.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_H
#define LSST_MWI_PERSISTENCE_FORMATTER_H

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

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

namespace lsst {
namespace daf {
namespace base {

class Persistable;

} // namespace lsst::daf::base

namespace persistence {

// Forward declarations.
class LogicalLocation;


class Formatter : public lsst::daf::base::Citizen {
public:
    typedef std::shared_ptr<Formatter> Ptr;

    typedef Ptr (*FactoryPtr)(lsst::pex::policy::Policy::Ptr);


    virtual ~Formatter(void);

    virtual void write(
        lsst::daf::base::Persistable const* persistable, FormatterStorage::Ptr storage,
        lsst::daf::base::PropertySet::Ptr additionalData) = 0;

    virtual lsst::daf::base::Persistable* read(
        FormatterStorage::Ptr storage,
        lsst::daf::base::PropertySet::Ptr additionalData) = 0;

    virtual void update(
        lsst::daf::base::Persistable* persistable, FormatterStorage::Ptr storage,
        lsst::daf::base::PropertySet::Ptr additionalData) = 0;

    static Formatter::Ptr lookupFormatter(
        std::string const& persistableType,
        lsst::pex::policy::Policy::Ptr policy);
    static Formatter::Ptr lookupFormatter(
        std::type_info const& persistableType,
        lsst::pex::policy::Policy::Ptr policy);

protected:
    explicit Formatter(std::type_info const& type);
};

class FormatterRegistration {
public:
    FormatterRegistration(std::string const& persistableName,
                          std::type_info const& persistableType,
                          Formatter::FactoryPtr factory);
};

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

#endif