SCWListStatsDialog.java

/*******************************************************************************
 * GenPlay, Einstein Genome Analyzer
 * Copyright (C) 2009, 2014 Albert Einstein College of Medicine
 * 
 * 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/>.
 * Authors: Julien Lajugie <julien.lajugie@einstein.yu.edu>
 *          Nicolas Fourel <nicolas.fourel@einstein.yu.edu>
 *          Eric Bouhassira <eric.bouhassira@einstein.yu.edu>
 * 
 * Website: <http://genplay.einstein.yu.edu>
 ******************************************************************************/
package edu.yu.einstein.genplay.gui.dialog.SCWListStatsDialog;

import java.awt.Component;
import java.awt.Dimension;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;

import javax.swing.JButton;
import javax.swing.JDialog;
import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.ScrollPaneConstants;
import javax.swing.filechooser.FileFilter;
import javax.swing.filechooser.FileNameExtensionFilter;
import javax.swing.table.TableCellRenderer;
import javax.swing.table.TableColumn;
import javax.swing.table.TableModel;

import edu.yu.einstein.genplay.dataStructure.list.genomeWideList.SCWList.SCWList;
import edu.yu.einstein.genplay.dataStructure.list.genomeWideList.SCWList.SCWListStats.SCWListStats;
import edu.yu.einstein.genplay.exception.ExceptionManager;
import edu.yu.einstein.genplay.util.FileChooser;
import edu.yu.einstein.genplay.util.Images;
import edu.yu.einstein.genplay.util.Utils;


/**
 * Dialog showing the statistics of a {@link SCWList}
 * @author Julien Lajugie
 */
public class SCWListStatsDialog extends JDialog {

	/** Generated serial ID */
	private static final long serialVersionUID = 8173952680722238489L;


	/**
	 * Shows the dialog
	 * @param parent the parent component of the dialog, can be null; see showDialog for details
	 * @param scwListStats {@link SCWListStats} to show in the dialog window
	 */
	public static void showDialog(Component parent, SCWListStats scwListStats) {
		SCWListStatsDialog scwListStatsDialog = new SCWListStatsDialog(scwListStats);
		scwListStatsDialog.setLocationRelativeTo(parent);
		scwListStatsDialog.setVisible(true);
	}


	/**
	 * Creates an instance of {@link SCWListStatsDialog}. Initialize the dialog and its subcomponents
	 * @param scwListStats stats to show in the dialog
	 */
	private SCWListStatsDialog(SCWListStats scwListStats) {
		super();
		// create the table
		TableModel statsTableModel = new SCWListStatsTableModel(scwListStats);
		final JTable jtStats = new JTable(statsTableModel);
		jtStats.setDefaultRenderer(Object.class, new SCWListStatsRenderer());
		// other table properties
		jtStats.setAutoResizeMode(JTable.AUTO_RESIZE_OFF);
		initializeColumnProperties(jtStats);

		// creates the scroll pane containing the table
		JScrollPane scrollPane = new JScrollPane(jtStats);
		scrollPane.getVerticalScrollBar().setUnitIncrement(Utils.SCROLL_INCREMENT_UNIT);
		scrollPane.setVerticalScrollBarPolicy(ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS);
		scrollPane.setPreferredSize(new Dimension(jtStats.getPreferredSize().width + 20, scrollPane.getPreferredSize().height));

		// create the ok button
		JButton jbOK = new JButton("OK");
		jbOK.addActionListener(new ActionListener() {
			@Override
			public void actionPerformed(ActionEvent e) {
				dispose();
			}
		});

		// create the ok button
		JButton jbSave = new JButton("Save");
		jbSave.addActionListener(new ActionListener() {
			@Override
			public void actionPerformed(ActionEvent e) {
				saveStats(jtStats);
			}
		});

		jbOK.setPreferredSize(jbSave.getPreferredSize());

		// add the components
		setLayout(new GridBagLayout());
		GridBagConstraints c = new GridBagConstraints();

		c.gridwidth = 2;
		add(scrollPane, c);

		c.gridwidth = 1;
		c.anchor = GridBagConstraints.LINE_START;
		c.insets = new Insets(10, 10, 10, 10);
		c.gridy = 1;
		add(jbSave, c);

		c.gridx = 1;
		c.anchor = GridBagConstraints.LINE_END;
		add(jbOK, c);

		// set dialog properties
		setIconImages(Images.getApplicationImages());
		setModalityType(ModalityType.APPLICATION_MODAL);
		pack();
		setResizable(false);
		getRootPane().setDefaultButton(jbOK);
	}


	/**
	 * Computes the width of the specified column.
	 * The width is equal to the largest row of the column
	 * @param jtStats
	 * @param column
	 * @param columnIndex
	 * @return the width of the largest row of the specified column
	 */
	private int computeColumnWidth(JTable jtStats, TableColumn column, int columnIndex) {
		// header row width
		Object value = column.getHeaderValue();
		TableCellRenderer renderer = column.getHeaderRenderer();
		renderer = jtStats.getTableHeader().getDefaultRenderer();
		Component component = renderer.getTableCellRendererComponent(jtStats, value, false, false, -1, columnIndex);
		int columnWidth = component.getPreferredSize().width;

		// other row width
		for (int rowIndex = 0; rowIndex < jtStats.getRowCount(); rowIndex++) {
			TableCellRenderer cellRenderer = jtStats.getCellRenderer(rowIndex, columnIndex);
			component = jtStats.prepareRenderer(cellRenderer, rowIndex, columnIndex);
			int rowWidth = component.getPreferredSize().width + jtStats.getIntercellSpacing().width;
			columnWidth = Math.max(columnWidth, rowWidth);
		}
		return columnWidth;
	}


	/**
	 * This method initializes column properties
	 */
	private void initializeColumnProperties (JTable jtStats) {
		TableColumn column = null;
		String[] columnHeaders = SCWListStatsTableModel.COLUMN_HEADERS;
		for (int columnIndex = 0; columnIndex < jtStats.getColumnCount(); columnIndex++) {
			column = jtStats.getColumnModel().getColumn(columnIndex);
			column.setResizable(false);
			column.setHeaderValue(columnHeaders[columnIndex]);

			int columnWidth = computeColumnWidth(jtStats, column, columnIndex) + 5;
			column.setPreferredWidth(columnWidth);
		}
	}


	/**
	 * Saves the statistics in a file
	 */
	private void saveStats(JTable jtStats) {
		FileFilter[] filters = {new FileNameExtensionFilter("TSV file (*.TSV)", "tsv")};
		File selectedFile = FileChooser.chooseFile(getRootPane(), FileChooser.SAVE_FILE_MODE, "Save Stats in TSV File", filters, false, new File("stats.tsv"));
		if(selectedFile != null) {
			try {
				writeStatsToFile(jtStats, selectedFile);
			} catch (IOException e) {
				ExceptionManager.getInstance().caughtException(Thread.currentThread(), e);
			}
		}
	}


	/**
	 * Writes the stats of the specified table into the specified file
	 * @param jtStats
	 * @param file
	 * @throws IOException
	 */
	private void writeStatsToFile(JTable jtStats, File file) throws IOException {
		BufferedWriter writer = null;
		try{
			writer = new BufferedWriter(new FileWriter(file));
			for (int column = 0; column < jtStats.getColumnCount(); column++) {
				writer.write(jtStats.getColumnModel().getColumn(column).getHeaderValue() + "\t");
			}
			writer.newLine();
			for (int row = 0; row < jtStats.getRowCount(); row++) {
				for (int column = 0; column < jtStats.getColumnCount(); column++) {
					writer.write(jtStats.getModel().getValueAt(row, column) + "\t");
				}
				writer.newLine();
			}
		} finally {
			if (writer != null) {
				writer.close();
			}
		}
	}
}