/*
 * Copyright 2012-2017 Red Hat, Inc.
 *
 * This file is part of Thermostat.
 *
 * Thermostat 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 2, or (at your
 * option) any later version.
 *
 * Thermostat 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 GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 *
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.storage.core;

import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

import com.redhat.thermostat.common.utils.LoggingUtils;
import com.redhat.thermostat.storage.model.TimeStampedPojo;

/**
 * Get a {@link List} of {@link TimeStampedPojo}s in a given time interval
 * range.
 *
 * @see VmLatestPojoListGetter
 */
public class VmTimeIntervalPojoListGetter <T extends TimeStampedPojo> extends AbstractGetter<T> {

    // The query for VmTimeIntervalPojoListGetter should query for since <= timestamp < to
    // in order not to miss data for multiple consecutive queries of the form [a, b), [b, c), ...
    // If the query were since < timestamp < to then queries of (a, b), (b, c), ... would
    // result in missed data at the endpoints (b, ...)
    public static final String VM_INTERVAL_QUERY_FORMAT = "QUERY %s WHERE '"
            + Key.AGENT_ID.getName() + "' = ?s AND '"
            + Key.VM_ID.getName() + "' = ?s AND '" 
            + Key.TIMESTAMP.getName() + "' >= ?l AND '"
            + Key.TIMESTAMP.getName() + "' < ?l SORT '"
            + Key.TIMESTAMP.getName() + "' DSC";

    private static final Logger logger = LoggingUtils.getLogger(VmTimeIntervalPojoListGetter.class);

    private final Storage storage;
    private final Category<T> cat;
    private final String query;

    public VmTimeIntervalPojoListGetter(Storage storage, Category<T> cat) {
        this.storage = storage;
        this.cat = cat;
        this.query = String.format(VM_INTERVAL_QUERY_FORMAT, cat.getName());
    }

    public List<T> getLatest(VmRef vmRef, long since, long to) {
        PreparedStatement<T> query = buildQuery(vmRef, since, to);
        return getLatestOrEmpty(query);
    }

    protected PreparedStatement<T> buildQuery(VmRef vmRef, long since, long to) {
        StatementDescriptor<T> desc = new StatementDescriptor<>(cat, query);
        PreparedStatement<T> stmt = null;
        try {
            stmt = storage.prepareStatement(desc);
            stmt.setString(0, vmRef.getHostRef().getAgentId());
            stmt.setString(1, vmRef.getVmId());
            stmt.setLong(2, since);
            stmt.setLong(3, to);
        } catch (DescriptorParsingException e) {
            // should not happen, but if it *does* happen, at least log it
            logger.log(Level.SEVERE, "Preparing query '" + desc + "' failed!", e);
        }
        return stmt;
    }

    // package private for tests
    String getQueryLatestDesc() {
        return query;
    }
}