/*
    * This file is a part of CAST project.
    * (c) Copyright 2007, AGH University of Science & Technology
    * https://caribou.iisg.agh.edu.pl/trac/cast
    *
    * Licensed under the Eclipse Public License, Version 1.0 (the "License").
    * You may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * http://www.eclipse.org/legal/epl-v10.html
   */
  /*
   * File: TabularData.java
   * Created: 2008-06-17
   * Author: entrop, kpietak
   * $Id: TabularData.java 2308 2009-01-12 22:33:45Z kpietak $
   */
  
  package pl.edu.agh.cast.rawdata;
  
  import java.util.HashSet;
  import java.util.LinkedList;
  import java.util.List;
  import java.util.Set;
  
  import pl.edu.agh.cast.rawdata.logging.AbstractRawDataMonitorable;
  import pl.edu.agh.cast.rawdata.logging.IRawDataObserver;
  
  /**
   * Contains list of rows. Rows don't need to have the same count of columns.
   * 
   * @author AGH CAST Team
   */
  public class TabularData extends AbstractRawDataMonitorable {
  
  	/**
  	 * List containing table rows.
  	 */
  	protected LinkedList<DataRow> rows;
  
  	/**
  	 * Default constructor.
  	 */
  	public TabularData() {
  		rows = new LinkedList<DataRow>();
  	}
  
  	/**
  	 * Add a specified row to the end of table.
  	 * 
  	 * @param newRow
  	 *            row to add
  	 */
  	public void addRow(DataRow newRow) {
  		newRow.setRowNumber(rows.size());
  		rows.add(newRow);
  	}
  
  	/**
  	 * Restores specified rows as first row in table. Notifies attached monitors if row is successfully restored.
  	 * 
  	 * @param row
  	 *            row to restore
  	 * @throws IllegalArgumentException
  	 *             when specified row has unspecified row number
  	 */
  	public void restoreAsFirst(DataRow row) {
  		if (row.getRowNumber() == DataRow.UNSPECIFIED_ROW_NUMBER) {
  			throw new IllegalArgumentException(
  			        "Cannot insert row with unspecified row number. Use addRow method instead. " + //$NON-NLS-1$
  			                "Row which was supposed to be added: " //$NON-NLS-1$
  			                + row.toString());
  		} else {
  			rows.addFirst(row);
  			notifyRestored(row);
  		}
  	}
  
  	/**
  	 * Returns distinct values from all rows specified columns.
  	 * 
  	 * @param columnIndex
  	 *            column index
  	 * @param numberOfRowsToIgnore
  	 *            number of rows to ignore
  	 * @return set of distinct values
  	 */
  	public Set<String> getAllRowValues(int columnIndex, int numberOfRowsToIgnore) {
  		Set<String> possibleValues = new HashSet<String>();
  
  		int i = 0;
  		for (DataRow row : getAllRows()) {
  			i++;
  			if (i <= numberOfRowsToIgnore) {
  				continue;
  			}
  
  			String columnValue = null;
  
  			if (columnIndex < row.size()) {
 				columnValue = row.get(columnIndex).trim();
 			}
 
 			if (columnValue != null) {
 				possibleValues.add(columnValue);
 			}
 		}
 
 		return possibleValues;
 	}
 
 	/**
 	 * Adds list of rows on the end of data table.
 	 * 
 	 * @param newRows
 	 *            rows to add
 	 */
 	public void addRows(List<DataRow> newRows) {
 		for (DataRow newRow : newRows) {
 			addRow(newRow);
 		}
 	}
 
 	public List<DataRow> getAllRows() {
 		return rows;
 	}
 
 	/**
 	 * Removes the specified row from table. Notifies attached monitors.
 	 * 
 	 * @param toDelete
 	 *            row to delete
 	 * @return true if row was successfully removed
 	 */
 	public boolean removeRow(DataRow toDelete) {
 		boolean res = rows.remove(toDelete);
 		if (res) {
 			notifyRemoved(toDelete);
 		}
 		return res;
 
 	}
 
 	/**
 	 * Returns column count.
 	 * 
 	 * @return column count which is maximum size of all rows.
 	 */
 	public int getColumnsCount() {
 		int maxRowSize = 0;
 
 		for (DataRow row : rows) {
 			if (maxRowSize < row.size()) {
 				maxRowSize = row.size();
 			}
 		}
 		return maxRowSize;
 	}
 
 	/**
 	 * Returns table rows count.
 	 * 
 	 * @return table rows count
 	 */
 	public int size() {
 		return rows.size();
 	}
 
 	/**
 	 * Gets row in table by row number.
 	 * 
 	 * @param row
 	 *            row number
 	 * @return row
 	 */
 	public DataRow get(int row) {
 		return rows.get(row);
 	}
 
 	/**
 	 * Checks if table is empty.
 	 * 
 	 * @return true if table is empty, false otherwise.
 	 */
 	public boolean isEmpty() {
 		return rows.isEmpty();
 	}
 
 	private void notifyRemoved(DataRow row) {
 		for (IRawDataObserver observer : getObservers()) {
 			observer.notifyRemoved(row);
 		}
 	}
 
 	private void notifyRestored(DataRow row) {
 		for (IRawDataObserver observer : getObservers()) {
 			observer.notifyRestored(row);
 		}
 	}
 }