TimeSeriesFactory.java

/*
 * Copyright (C) 2010 Brockmann Consult GmbH (info@brockmann-consult.de)
 *
 * 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 GNU General Public License along
 * with this program; if not, see http://www.gnu.org/licenses/
 */

package org.esa.snap.timeseries.core.timeseries.datamodel;

import com.bc.ceres.core.Assert;
import com.bc.ceres.core.ProgressMonitor;
import org.esa.snap.core.datamodel.Product;
import org.esa.snap.timeseries.core.TimeSeriesMapper;
import org.esa.snap.util.ProductUtils;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Factory class for creating instances of {@link AbstractTimeSeries}.
 *
 * <p><i>Note that this class is not yet public API. Interface may change in future releases.</i></p>
 *
 * @author Thomas Storm
 */
public class TimeSeriesFactory {

    private TimeSeriesFactory() {
    }

    /**
     * Creates a new TimeSeries from a given time series product. The given product has to be a time series product.
     * This method should only be called by the reader
     *
     * @param product a time series product
     *
     * @return a time series wrapping the given product
     */
    public static AbstractTimeSeries create(Product product, ProgressMonitor pm) {
        final TimeSeriesImpl timeSeries = new TimeSeriesImpl(product, pm);
        TimeSeriesMapper.getInstance().put(product, timeSeries);
        return timeSeries;
    }

    /**
     * Creates a new TimeSeries with a given name, a list of product locations and a list of variables (which are
     * placeholders for bands)
     *
     * @param timeSeriesName   a name for the time series
     * @param productLocations locations where to find the data the time series is based on
     * @param variableNames    the variables the time series is based on
     *
     * @return a time series
     */
    public static AbstractTimeSeries create(String timeSeriesName,
                                            List<ProductLocation> productLocations,
                                            List<String> variableNames) {
        try {
            Assert.notNull(productLocations, "productLocations");
            Assert.argument(productLocations.size() > 0, "productLocations must contain at least one location.");
            Assert.notNull(variableNames, "variableNames");
            Assert.argument(variableNames.size() > 0, "variableNames must contain at least one variable name.");
            Assert.argument(timeSeriesName != null && timeSeriesName.trim().length() > 0, "timeSeriesName must not be null or empty.");

            if (noSourceProductsAvailable(productLocations)) {
                return null;
            }

            final Product referenceProduct = getFirstReprojectedSourceProduct(productLocations);
            final Product timeSeriesProduct = new Product(timeSeriesName, TimeSeriesImpl.TIME_SERIES_PRODUCT_TYPE,
                                                          referenceProduct.getSceneRasterWidth(),
                                                          referenceProduct.getSceneRasterHeight());
            timeSeriesProduct.setDescription("A time series product");
            ProductUtils.copyGeoCoding(referenceProduct, timeSeriesProduct);
            timeSeriesProduct.setPreferredTileSize(referenceProduct.getPreferredTileSize());

            final AbstractTimeSeries timeSeries = new TimeSeriesImpl(timeSeriesProduct, productLocations, variableNames);
            TimeSeriesMapper.getInstance().put(timeSeriesProduct, timeSeries);
            return timeSeries;
        } catch (Throwable e) {
            e.printStackTrace();
        }
        return null;
    }

    private static Product getFirstReprojectedSourceProduct(List<ProductLocation> productLocations) {
        final ProductLocation firstLocation = productLocations.get(0);
        return firstLocation.getProducts(ProgressMonitor.NULL).values().iterator().next();
    }

    private static boolean noSourceProductsAvailable(List<ProductLocation> productLocations) {
        final Map<String, Product> productList = new HashMap<>();
        for (ProductLocation productLocation : productLocations) {
            productList.putAll(productLocation.getProducts(ProgressMonitor.NULL));
        }
        return productList.isEmpty();
    }

}