package uk.ac.starlink.topcat.plot2;

import java.awt.BorderLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
import javax.swing.Action;
import javax.swing.AbstractAction; 
import javax.swing.Box;
import javax.swing.DefaultComboBoxModel;
import javax.swing.Icon;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JComponent;
import javax.swing.JPanel;
import javax.swing.JTextField;
import uk.ac.starlink.table.StarTable;
import uk.ac.starlink.table.TableSource;
import uk.ac.starlink.table.gui.LabelledComponentStack;
import uk.ac.starlink.topcat.AuxWindow;
import uk.ac.starlink.topcat.ControlWindow;
import uk.ac.starlink.topcat.LineBox;
import uk.ac.starlink.topcat.ResourceIcon;
import uk.ac.starlink.topcat.RowSubset;
import uk.ac.starlink.ttools.plot2.Plotter;
import uk.ac.starlink.ttools.plot2.ReportKey;
import uk.ac.starlink.ttools.plot2.ReportMap;
import uk.ac.starlink.ttools.plot2.ReportMeta;
import uk.ac.starlink.util.gui.ShrinkWrapper;

/**
 * Displays plot reports.
 *
 * @author   Mark Taylor
 * @since    11 Dec 2014
 */
public class ReportPanel extends JPanel {

    private final Factory<Plotter<?>> plotterFact_;
    private final JComboBox<RowSubset> subsetSelector_;
    private final Map<ReportKey<?>,JComponent> boxMap_;
    private final DefaultComboBoxModel<RowSubset> subsetSelModel_;
    private final JPanel reportHolder_;
    private Map<RowSubset,ReportMap> reports_;

    /**
     * Constructor.
     *
     * @param  plotterFact   object that can supply the Plotter
     *                       currently associated with this report panel
     */
    public ReportPanel( Factory<Plotter<?>> plotterFact ) {
        super( new BorderLayout() );
        plotterFact_ = plotterFact;
        subsetSelModel_ = new DefaultComboBoxModel<RowSubset>();
        subsetSelector_ = new JComboBox<RowSubset>( subsetSelModel_ );
        subsetSelector_.addItemListener( new ItemListener() {
            public void itemStateChanged( ItemEvent evt ) {
                updateDisplay();
            }
        } );
        add( new LineBox( "Subset", new ShrinkWrapper( subsetSelector_ ),
                          true ),
             BorderLayout.NORTH );
        reportHolder_ = new JPanel( new BorderLayout() );
        add( reportHolder_, BorderLayout.CENTER );
        boxMap_ = new LinkedHashMap<ReportKey<?>,JComponent>();
        reports_ = new HashMap<RowSubset,ReportMap>();
    }

    /**
     * Updates the reports that can be displayed by this component.
     * They are supplied as a map keyed by RowSubset.
     *
     * @param  reports   map of subsets to plot reports
     */
    public void submitReports( Map<RowSubset,ReportMap> reports ) {
        reports_ = reports;
        Object selected = subsetSelModel_.getSelectedItem();
        subsetSelModel_.removeAllElements();
        boolean hasSelected = false;
        for ( RowSubset rset : reports.keySet() ) {
            subsetSelModel_.addElement( rset );
            if ( rset.equals( selected ) ) {
                subsetSelModel_.setSelectedItem( rset );
                hasSelected = true;
            }
        }
        if ( ! hasSelected ) {
            subsetSelModel_.setSelectedItem( subsetSelModel_.getSize() > 0
                                           ? subsetSelModel_.getElementAt( 0 )
                                           : null );
        }
        updateDisplay();
    }

    /**
     * Updates this component's appearance to match its current state.
     */
    private void updateDisplay() {
        displayReport( reports_.get( subsetSelector_.getSelectedItem() ) );
    }

    /** 
     * Displays the content of a particular report map.
     *
     * @param  report  plot report to display
     */
    private void displayReport( ReportMap report ) {

        /* Assemble a list of key-string pairs to display. */
        Map<ReportKey<?>,JComponent> componentMap =
            new LinkedHashMap<ReportKey<?>,JComponent>();
        if ( report != null ) {
            for ( ReportKey<?> key : report.keySet() ) {
                if ( key.isGeneralInterest() ) {
                    componentMap.put( key,
                                      createReportComponent( key, report ) );
                }
            }
        }

        /* Ensure that the display component has slots for each of the
         * items we are going to display.  If not, throw it out and
         * position a new one that does. */
        if ( ! boxMap_.keySet().containsAll( componentMap.keySet() ) ) {
            boxMap_.clear();
            LabelledComponentStack stack = new LabelledComponentStack();
            for ( ReportKey<?> key : componentMap.keySet() ) {
                JComponent box = Box.createHorizontalBox();
                stack.addLine( key.getMeta().getLongName(), null, box, true );
                boxMap_.put( key, box );
            }
            reportHolder_.removeAll();
            reportHolder_.add( stack );
            reportHolder_.revalidate();
        }

        /* Display the report items in the display component. */
        for ( Map.Entry<ReportKey<?>,JComponent> entry : boxMap_.entrySet() ) {
            ReportKey<?> key = entry.getKey();
            JComponent box = entry.getValue();
            box.removeAll();
            JComponent cmp = componentMap.get( key );
            if ( cmp != null ) {
                box.add( cmp );
            }
            box.revalidate();
        }
    }

    /**
     * Returns a GUI component that presents an entry from a report map
     * to the user.
     *
     * @param  key  key
     * @param  map   report map containing key
     * @return  component
     */
    private <T> JComponent createReportComponent( ReportKey<T> key,
                                                  ReportMap map ) {

        /* If it's a table, provide buttons for exporting the content. */
        if ( StarTable.class.isAssignableFrom( key.getValueClass() ) ) {
            AuxWindow auxWin = ControlWindow.getInstance();
            ReportMeta meta = key.getMeta();
            final StarTable table = (StarTable) map.get( key );
            TableSource tsrc = new TableSource() {
                public StarTable getStarTable() {
                    return table;
                }
            };
            String dataType = meta.getLongName();
            String tcLabel = meta.getShortName();
            Action importAct =
                auxWin.createImportTableAction( dataType, tsrc, tcLabel );
            Action saveAct = auxWin.createSaveTableAction( dataType, tsrc );
            importAct.putValue( Action.NAME, "Import" );
            saveAct.putValue( Action.NAME, "Save" );
            Icon picon = plotterFact_.getItem().getPlotterIcon();
            if ( picon != null ) {
                importAct.putValue( Action.SMALL_ICON,
                                    ResourceIcon.toImportIcon( picon ) );
                saveAct.putValue( Action.SMALL_ICON,
                                  ResourceIcon.toSaveIcon( picon ) );
            }
            Box buttBox = Box.createHorizontalBox();
            buttBox.add( new JButton( importAct ) );
            buttBox.add( Box.createHorizontalStrut( 5 ) );
            buttBox.add( new JButton( saveAct ) );
            buttBox.add( Box.createHorizontalGlue() );
            return buttBox;
        }

        /* Otherwise, stringify it. */
        else {
            T value = map.get( key );
            JTextField field = new JTextField();
            field.setText( value == null ? null : key.toText( value ) );
            field.setCaretPosition( 0 );
            field.setEditable( false );
            return field;
        }
    }
}
