##
# This software was developed and / or modified by Raytheon Company,
# pursuant to Contract DG133W-05-CQ-1067 with the US Government.
# 
# U.S. EXPORT CONTROLLED TECHNICAL DATA
# This software product contains export-restricted data whose
# export/transfer/disclosure is restricted by U.S. law. Dissemination
# to non-U.S. persons whether in the United States or abroad requires
# an export license or other authorization.
# 
# Contractor Name:        Raytheon Company
# Contractor Address:     6825 Pine Street, Suite 340
#                         Mail Stop B8
#                         Omaha, NE 68106
#                         402.291.0100
# 
# See the AWIPS II Master Rights File ("Master Rights File.pdf") for
# further licensing information.
##


import PointDataView, PointDataContainer, NoDataException, PointDataRetrieve

#
# Python module to request forecast time point data.  Split out of
# PointDataContainer.py.
#  
#    
#     SOFTWARE HISTORY
#    
#    Date            Ticket#       Engineer       Description
#    ------------    ----------    -----------    --------------------------
#    25Apr2012       14688         rferrel        Initial Creation.
#    03Apr2013       1735          rferrel        Use DbQueryRequest to get forecast times
#                                                  and added option to limit number returned.
#    31Oct2016       5979          njensen        Cast to primitives for compatibility
# 
#
    
##
# This is a base file that is not intended to be overridden.
##

class ForecastPointDataRetrieve(PointDataRetrieve.PointDataRetrieve):

    def __init__(self, pluginName, site, parameters, keyId='forecastHr', refTime=None, constraint={}, maxSize=99, forecastTimesLimit=-999):
        self.forecastTimesLimit = forecastTimesLimit
        super(ForecastPointDataRetrieve, self).__init__(pluginName, site, parameters, keyId, refTime, constraint, maxSize)
    
    def _query(self, parameters, maxSize):
        fctTimes = self.__queryForecastTimes()
        self.__javaPdc = self.__requestForecastData(fctTimes, parameters)
        pdvDict = self._organizeData(self.__javaPdc)        
        self.pdc = PointDataContainer.PointDataContainer(pdvDict, self.__javaPdc, self.refTime)
    
    def __queryForecastTimes(self):
        from com.raytheon.uf.common.dataquery.requests import DbQueryRequest
        from com.raytheon.uf.viz.core.requests import ThriftClient
        from java.lang import Integer
        request = DbQueryRequest()
        request.setConstraints(self._buildConstraints(self.refTime))
        request.addRequestField('dataTime.fcstTime')
        request.setOrderByField('dataTime.fcstTime')
        request.setDistinct(True)
        iForecastTimesLimit = Integer(self.forecastTimesLimit)
        if (self.forecastTimesLimit > 0) :
            request.setLimit(iForecastTimesLimit)
        return ThriftClient.sendRequest(request).getFieldObjects('dataTime.fcstTime', iForecastTimesLimit.getClass())
    
    def __requestForecastData(self, availableHours, parameters):
        from com.raytheon.viz.pointdata import PointDataRequest
        from com.raytheon.uf.common.time import DataTime
        from java.lang import String
        import jep
        dtsLen = len(availableHours)
        dts = jep.jarray(dtsLen, DataTime)
        for i in range(dtsLen):
            dts[i] = DataTime(self.refTime, int(availableHours[i]))
        constraints = self._buildConstraints(None) #fctTimes are explicitly set so we don't need to constrain those
        params = jep.jarray(len(parameters), String)
        for i in range(len(parameters)):
            params[i] = String(parameters[i])
        if self.site:
            stations = jep.jarray(1, String)
            stations[0] = String(self.site)
        else:
            stations = None
        return PointDataRequest.requestPointData(dts,
            self.pluginName, params, stations,
            constraints)
    
def retrieve(pluginName, site, parameters, keyId='forecastHr', refTime=None, constraint={}, maxSize=99, forecastTimesLimit=-999):
    ret = ForecastPointDataRetrieve(pluginName, site, parameters, keyId, refTime, constraint, maxSize, forecastTimesLimit)
    return ret.pdc