/* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
 * Software engineering by Intevation GmbH
 *
 * This file is Free Software under the GNU AGPL (>=v3) 
 * and comes with ABSOLUTELY NO WARRANTY! Check out the
 * documentation coming with Dive4Elements River for details. 
 */

package org.dive4elements.river.artifacts.model;

import java.util.ArrayList;
import java.util.List;

import org.apache.log4j.Logger;

import org.dive4elements.artifacts.Artifact;
import org.dive4elements.artifacts.common.utils.DateUtils;

import org.dive4elements.river.model.BedHeightEpoch;
import org.dive4elements.river.model.BedHeightEpochValue;
import org.dive4elements.river.model.BedHeightSingle;
import org.dive4elements.river.model.BedHeightSingleValue;
import org.dive4elements.river.model.TimeInterval;

import org.dive4elements.river.artifacts.access.BedHeightAccess;


public class MiddleBedHeightCalculation extends Calculation {

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


    public CalculationResult calculate(BedHeightAccess access) {
        logger.info("MiddleBedHeightCalculation.calculate");

        int[] singleIds = access.getBedHeightSingleIDs();
        int[] epochIds  = access.getBedHeightEpochIDs();


        if (logger.isDebugEnabled()) {
            Artifact artifact = access.getArtifact();

            logger.debug("Artifact '" + artifact.identifier() + "' contains:");
            if (singleIds != null) {
                logger.debug("   " + singleIds.length + " single bedheight ids");
            }

            if (epochIds != null) {
                logger.debug("   " + epochIds.length + " epoch bedheight ids");
            }
        }

        List<BedHeightSingle> singles = getSingles(access, singleIds);
        List<BedHeightEpoch>  epochs  = getEpochs(access, epochIds);

        return buildCalculationResult(access, singles, epochs);
    }


    protected List<BedHeightSingle> getSingles(
        BedHeightAccess access,
        int[] ids
    ) {
        List<BedHeightSingle> singles = new ArrayList<BedHeightSingle>();

        for (int id: ids) {
            BedHeightSingle s = BedHeightSingle.getBedHeightSingleById(id);

            if (s != null) {
                singles.add(s);
            }
            else {
                logger.warn("Cannot find Single by id: " + id);
                // TODO ADD WARNING
            }
        }

        return singles;
    }


    protected List<BedHeightEpoch> getEpochs(
        BedHeightAccess access,
        int[] ids
    ) {
        List<BedHeightEpoch> epochs = new ArrayList<BedHeightEpoch>();

        for (int id: ids) {
            BedHeightEpoch e = BedHeightEpoch.getBedHeightEpochById(id);

            if (e != null) {
                epochs.add(e);
            }
            else {
                logger.warn("Cannot find Epoch by id: " + id);
                // TODO ADD WARNING
            }
        }

        return epochs;
    }


    protected CalculationResult buildCalculationResult(
        BedHeightAccess       access,
        List<BedHeightSingle> singles,
        List<BedHeightEpoch>  epochs
    ) {
        logger.info("MiddleBedHeightCalculation.buildCalculationResult");

        double kmLo = access.getLowerKM();
        double kmHi = access.getUpperKM();

        List<MiddleBedHeightData> data = new ArrayList<MiddleBedHeightData>();

        for (BedHeightSingle single: singles) {
            MiddleBedHeightData d = prepareSingleData(single, kmLo, kmHi);

            if (d != null) {
                data.add(d);
            }
        }

        for (BedHeightEpoch epoch: epochs) {
            MiddleBedHeightData d = prepareEpochData(epoch, kmLo, kmHi);

            if (d != null) {
                data.add(d);
            }
        }

        logger.debug("Calculation results in " + data.size() + " data objects.");

        return new CalculationResult((MiddleBedHeightData[])
            data.toArray(new MiddleBedHeightData[data.size()]), this);
    }


    protected MiddleBedHeightData prepareSingleData(
        BedHeightSingle single,
        double kmLo,
        double kmHi
    ) {
        logger.debug("Prepare data for single: " + single.getDescription());

        List<BedHeightSingleValue> values =
            BedHeightSingleValue.getBedHeightSingleValues(single, kmLo, kmHi);

        int year = single.getYear() != null ? single.getYear() : 0;

        MiddleBedHeightData data = new MiddleBedHeightData(
            year,
            year,
            single.getEvaluationBy(),
            single.getDescription());

        for (BedHeightSingleValue value: values) {
            if (value.getHeight() != null) {
                data.addAll(value.getStation().doubleValue(),
                    value.getHeight().doubleValue(),
                    value.getUncertainty().doubleValue(),
                    value.getSoundingWidth().doubleValue(),
                    value.getDataGap().doubleValue(),
                    value.getWidth().doubleValue(),
                    false);
             }
            else {
                data.addAll(value.getStation().doubleValue(),
                    0,
                    0,
                    0,
                    0,
                    0,
                    true);
            }
        }

        logger.debug("Single contains " + values.size() + " values");

        return data;
    }


    /** Create MiddleBedHeightData to return. */
    protected MiddleBedHeightData prepareEpochData(
        BedHeightEpoch epoch,
        double kmLo,
        double kmHi
    ) {
        logger.debug("Prepare data for epoch: " + epoch.getDescription());

        TimeInterval ti = epoch.getTimeInterval();

        List<BedHeightEpochValue> values =
            BedHeightEpochValue.getBedHeightEpochValues(epoch, kmLo, kmHi);

        MiddleBedHeightData data = new MiddleBedHeightData(
            DateUtils.getYearFromDate(ti.getStartTime()),
            DateUtils.getYearFromDate(ti.getStopTime()),
            epoch.getEvaluationBy(),
            epoch.getDescription()
        );

        for (BedHeightEpochValue value: values) {
            data.addKM(value.getStation().doubleValue());
            if (value.getHeight() != null) {
                data.addMiddleHeight(value.getHeight().doubleValue());
                data.addIsEmpty(false);
            }
            else {
                data.addMiddleHeight(Double.NaN);
                data.addIsEmpty(true);
            }
        }

        logger.debug("Epoch contains " + values.size() + " values");

        return data;
    }
}
// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :