Persistence.cc

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 __GNUC__
#  define __attribute__(x) /*NOTHING*/
#endif
static char const* SVNid __attribute__((unused)) = "$Id$";

#include "lsst/daf/persistence/Persistence.h"

#include <boost/regex.hpp>

#include "lsst/daf/persistence/Formatter.h"
#include "lsst/daf/persistence/LogicalLocation.h"
#include "lsst/daf/base/Persistable.h"
#include "lsst/pex/policy/Policy.h"
#include "lsst/daf/persistence/FormatterStorage.h"

namespace lsst {
namespace daf {
namespace persistence {

Persistence::Persistence(lsst::pex::policy::Policy::Ptr policy) :
    lsst::daf::base::Citizen(typeid(*this)), _policy(policy) {
}

Persistence::~Persistence(void) {
}

FormatterStorage::Ptr Persistence::_getStorage(std::string const& storageType,
                                               LogicalLocation const& location,
                                               bool persist) {
    lsst::pex::policy::Policy::Ptr policyPtr;
    if (_policy && _policy->exists(storageType)) {
        policyPtr = _policy->getPolicy(storageType);
    }
    return FormatterStorage::createInstance(storageType, location, persist, policyPtr);
}

FormatterStorage::Ptr Persistence::getPersistStorage(std::string const& storageType,
                                            LogicalLocation const& location) {
    return _getStorage(storageType, location, true);
}

FormatterStorage::Ptr Persistence::getRetrieveStorage(std::string const& storageType,
                                             LogicalLocation const& location) {
    return _getStorage(storageType, location, false);
}

void Persistence::persist(
    lsst::daf::base::Persistable const& persistable, FormatterStorage::List const& storageList,
    lsst::daf::base::PropertySet::Ptr additionalData) {
    // Get the policies for all Formatters, if present
    std::string policyName = "Formatter";
    lsst::pex::policy::Policy::Ptr policyPtr;
    if (_policy && _policy->exists(policyName)) {
        policyPtr = _policy->getPolicy(policyName);
    }
    // Find the appropriate Formatter.
    Formatter::Ptr f =
        Formatter::lookupFormatter(typeid(persistable), policyPtr);
    // Use the Formatter instance to write the Persistable to each FormatterStorage
    // in turn.  Commit the transactions (in order) when all writing is
    // complete.
    for (FormatterStorage::List::const_iterator it = storageList.begin();
         it != storageList.end(); ++it) {
        (*it)->startTransaction();
        f->write(&persistable, *it, additionalData);
    }
    for (FormatterStorage::List::const_iterator it = storageList.begin();
         it != storageList.end(); ++it) {
        (*it)->endTransaction();
    }
}

lsst::daf::base::Persistable* Persistence::unsafeRetrieve(
    std::string const& persistableType, FormatterStorage::List const& storageList,
    lsst::daf::base::PropertySet::Ptr additionalData) {
    // Get the policies for all Formatters, if present
    std::string policyName = "Formatter";
    lsst::pex::policy::Policy::Ptr policyPtr;
    if (_policy && _policy->exists(policyName)) {
        policyPtr = _policy->getPolicy(policyName);
    }
    // Find the appropriate Formatter.
    Formatter::Ptr f = Formatter::lookupFormatter(persistableType, policyPtr);
    // Use the Formatter instance to read from the first FormatterStorage; then update
    // from each additional FormatterStorage in turn.
    lsst::daf::base::Persistable* persistable = 0;
    for (FormatterStorage::List::const_iterator it = storageList.begin();
         it != storageList.end(); ++it) {
        (*it)->startTransaction();
        if (!persistable) {
            persistable = f->read(*it, additionalData);
        } else {
            f->update(persistable, *it, additionalData);
        }
    }
    for (FormatterStorage::List::const_iterator it = storageList.begin();
         it != storageList.end(); ++it) {
        (*it)->endTransaction();
    }
    return persistable;
}

lsst::daf::base::Persistable::Ptr Persistence::retrieve(
    std::string const& persistableType, FormatterStorage::List const& storageList,
    lsst::daf::base::PropertySet::Ptr additionalData) {
    return lsst::daf::base::Persistable::Ptr(
        unsafeRetrieve(persistableType, storageList, additionalData));
}

Persistence::Ptr Persistence::getPersistence(
    lsst::pex::policy::Policy::Ptr policy) {
    return Persistence::Ptr(new Persistence(policy));
}

lsst::pex::policy::Policy::Ptr Persistence::getPolicy() const
{
    return _policy;
}


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