Packager.java

/* The MIT License (MIT)
 *
 * Copyright (c) 2015 Reinventing Geospatial, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.rgi.packager;

import java.util.concurrent.CancellationException;
import java.util.concurrent.atomic.AtomicInteger;

import com.rgi.common.TaskMonitor;
import com.rgi.store.tiles.TileHandle;
import com.rgi.store.tiles.TileStoreException;
import com.rgi.store.tiles.TileStoreReader;
import com.rgi.store.tiles.TileStoreWriter;

/**
 * Package tiles from a tile store into a GeoPackage or append to an existing GeoPackage.
 *
 * @author Steven D. Lander
 * @author Luke D. Lambert
 *
 */
public class Packager
{
    private final TaskMonitor     taskMonitor;
    private final TileStoreReader tileStoreReader;
    private final TileStoreWriter tileStoreWriter;
    private static boolean cancel = false;

    /**
     * Constructor
     * @param taskMonitor
     *             Mechanism by which packager progress is monitored
     * @param tileStoreReader
     *             Input tile store
     * @param tileStoreWriter
     *             Destination tile store
     */
    public Packager(final TaskMonitor     taskMonitor,
                    final TileStoreReader tileStoreReader,
                    final TileStoreWriter tileStoreWriter)
    {
        this.taskMonitor     = taskMonitor;

        this.tileStoreReader = tileStoreReader;
        this.tileStoreWriter = tileStoreWriter;
    }

    /**
     * Starts the packaging job
     * @throws TileStoreException
     *             when {@link TileStoreReader#countTiles()} or
     *             {@link TileStoreReader#stream()} throws
     */
    public void execute() throws TileStoreException
    {
        this.taskMonitor.setMaximum((int)this.tileStoreReader.countTiles());

        final AtomicInteger tileCount = new AtomicInteger(0);
        this.tileStoreReader.stream().forEach(tileHandle ->
        {
            if(cancel)
            {
                throw new CancellationException("Cancelled");
            }
            try
            {
                this.tileStoreWriter.addTile(tileHandle.getCrsCoordinate(this.tileStoreWriter.getTileOrigin()),
                                             tileHandle.getZoomLevel(),
                                             tileHandle.getImage());

                this.taskMonitor.setProgress(tileCount.incrementAndGet());
            }
            catch(final TileStoreException | IllegalArgumentException ex)
            {
                // TODO: report this somewhere else?
                System.err.printf("Tile z: %d, x: %d, y: %d failed to get copied into the package: %s\n",
                                  tileHandle.getZoomLevel(),
                                  tileHandle.getColumn(),
                                  tileHandle.getRow(),
                                  ex.getMessage());
            }
        });
    }

    /**
     * Cancels the execution of the
     * packaging job
     */
    public static void cancel()
    {
    	Packager.cancel = true;
    }
}