butlerLocation.py

Go to the documentation of this file.

#!/usr/bin/env python

# 
# 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/>.
#


"""This module defines the ButlerLocation class."""

import lsst.daf.base as dafBase

class ButlerLocation(object):
    """ButlerLocation is a struct-like class that holds information needed to
    persist and retrieve an object using the LSST Persistence Framework.
    
    Mappers should create and return ButlerLocations from their
    map_{datasetType} methods."""

    def __init__(self, pythonType, cppType, storageName, locationList, dataId):
        self.pythonType = pythonType
        self.cppType = cppType
        self.storageName = storageName
        if hasattr(locationList, '__iter__'):
            self.locationList = locationList
        else:
            self.locationList = [locationList]
        self.additionalData = dafBase.PropertySet()
        for k, v in dataId.iteritems():
            self.additionalData.set(k, v)

    def __str__(self):
        s = "%s at %s(%s)" % (self.pythonType, self.storageName,
                ", ".join(self.locationList))
        return s

    def getPythonType(self):
        return self.pythonType

    def getCppType(self):
        return self.cppType

    def getStorageName(self):
        return self.storageName

    def getLocations(self):
        return self.locationList

    def getAdditionalData(self):
        return self.additionalData