TileReadersOptionWindow.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.suite.uielements.windows;

import java.awt.Dimension;
import java.awt.GridBagLayout;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.function.Consumer;

import javax.swing.BorderFactory;
import javax.swing.BoxLayout;
import javax.swing.JComponent;
import javax.swing.JPanel;

import utility.SimpleGridBagConstraints;

import com.rgi.store.tiles.TileStoreException;
import com.rgi.store.tiles.TileStoreReader;
import com.rgi.suite.tilestoreadapter.TileStoreReaderAdapter;

/**
 * Window that prompts the user for input required to read tile stores
 *
 * @author Luke Lambert
 *
 */
public class TileReadersOptionWindow extends NavigationWindow
{
    private static final long serialVersionUID = 5667756189513470272L;

    private final Collection<TileStoreReaderAdapter>    readerAdapters;
    private final Consumer<Collection<TileStoreReader>> readerConsumer;

    private boolean needsInput = false;

    /**
     * Constructor
     *
     * @param readerAdapters
     *             A collection of {@link TileStoreReaderAdapter}s which may
     *             require additional input to create {@link TileStoreReader}s
     * @param readerConsumer
     *             Callback mechanism to consume {@link TileStoreReader}s once
     *             they've been created
     */
    public TileReadersOptionWindow(final Collection<TileStoreReaderAdapter> readerAdapters, final Consumer<Collection<TileStoreReader>> readerConsumer)
    {
        if(readerAdapters == null || readerAdapters.size() < 1)
        {
            throw new IllegalArgumentException("Adapter collection may not be null or empty");
        }

        this.setTitle("File Options");
        this.setResizable(false);

        this.contentPanel.setLayout(new BoxLayout(this.contentPanel, BoxLayout.PAGE_AXIS));

        this.readerAdapters = readerAdapters;
        this.readerConsumer = readerConsumer;

        for(final TileStoreReaderAdapter adapter : this.readerAdapters)
        {
            if(adapter != null)
            {
                this.needsInput |= adapter.needsInput();

                final JPanel readerPanel = new JPanel(new GridBagLayout());

                readerPanel.setBorder(BorderFactory.createTitledBorder(adapter.getFile().getName()));

                int rowCount = 0;

                for(final Collection<JComponent> row : adapter.getReaderParameterControls())
                {
                    int columnCount = 0;
                    for(final JComponent column : row)
                    {
                        final Dimension dimension = column.getPreferredSize();

                        // This is a work-around to resize (and then stretch) the middle column to fit our input form layout
                        if(dimension == null || (columnCount == 1 &&
                           (dimension.getWidth()  < 1 ||
                            dimension.getHeight() < 1)))
                        {

                            column.setPreferredSize(new Dimension(220, 25));
                        }

                        readerPanel.add(column, new SimpleGridBagConstraints(columnCount, rowCount, columnCount == 1));

                        ++columnCount;
                    }

                    ++rowCount;
                }

                this.contentPanel.add(readerPanel);
            }
        }

        this.pack();
    }

    @Override
    public boolean execute()
    {
        this.readerConsumer.accept(this.getReaders());
        return true;
    }

    /**
     * Test to see if any additional input is actually required before
     *
     * @return true if none of the input {@link TileStoreReaderAdapter}s
     *             require additional information to create their respective
     *             {@link TileStoreReader}
     */
    public boolean needsInput()
    {
        return this.needsInput;
    }

    @Override
    protected String processName()
    {
        return "File Options";
    }

    private Collection<TileStoreReader> getReaders()
    {
        final List<TileStoreReader> readers = new ArrayList<>();

        this.readerAdapters
            .stream()
            .forEach(adapter -> { try
                                  {
                                      readers.addAll(adapter.getTileStoreReaders());
                                  }
                                  catch(final TileStoreException ex)
                                  {
                                      this.error(String.format("There was an error opening %s: %s",
                                                               adapter.getFile().getName(),
                                                               ex.getMessage()));
                                  }
                                });

        return readers;
    }
}