package gui;
 
import java.util.Properties;
 
import javax.swing.table.AbstractTableModel;
 
/**
 * @author Alexander Bolte - Bolte Consulting 2015
 * 
 *         This class provides a simple table model for presentation of
 *         Properties to a user in a JTable.
 */
public class PropertyTableModel extends AbstractTableModel {
	private static final long serialVersionUID = -3063971024649603117L;
	private Properties props = null;
	private String[] key = null;
	private final String[] cols = new String[] { "Property", "Value" };
 
	/**
	 * Constructs a new object of this class.
	 * 
	 * @param props
	 *            - an object of type Properties.
	 */
	public PropertyTableModel(Properties props) {
		this.props = props;
		key = this.props.keySet().toArray(new String[] { "" });
	}
 
	@Override
	public int getRowCount() {
		return key.length;
	}
 
	@Override
	public int getColumnCount() {
		return 2;
	}
 
	@Override
	public Object getValueAt(int rowIndex, int columnIndex) {
		if (columnIndex == 0) {
			return key[rowIndex];
		} else {
			return props.getProperty(key[rowIndex]);
		}
	}
 
	@Override
	public String getColumnName(int column) {
		return cols[column];
	}
 
	@Override
	public boolean isCellEditable(int row, int col) {
		if (col == 1) {
			return true;
		} else {
			return false;
		}
	}
 
	@Override
	public void setValueAt(Object value, int row, int col) {
		props.put(key[row], value);
 
		fireTableCellUpdated(row, col);
	}
 
	/**
	 * Returns the internal Properties object referenced by this table model.
	 * 
	 * @return a Properties object used by this table model.
	 */
	public Properties getProperties() {
		return props;
	}
 
	/**
	 * Returns the index of a given key for a property in a table as it is
	 * displayed to a user in a JTable top to bottom and stored internally in
	 * this table model.
 
	 * 
 
	 * 
	 * This method is intended to be used by calling procedures, which have to
	 * update a value for a certain property through a JTable presented to a
	 * user.
 
	 * 
 
	 * 
	 * An index returned by this method always reflects the index in a displayed
	 * JTable. Example: 
	 * Property 1 | Value 1
 
	 * Property 2 | Value 2
 
	 * Property 3 | Value 3
 
 
	 * 
	 * For a search value "Property 1" this method would return 0 in above
	 * example. Accordingly a search value "Property 3" would result in 2.
	 * 
	 * 
 
	 * 
 
	 * The performance of this method is expected to be poor, but Property files
	 * should not contain as many properties in order for us having to consider
	 * performance for this kind of task. 
 
	 * However we could replace this poor search with querying an internal hash
	 * table initialized when calling a constructor, which is a good idea for a
	 * future release.
	 * 
	 * @param searchVal
	 *            - a String providing the exact (case sensitive) name of a
	 *            property as it is stored in this table model.
	 * @return an int providing the index of a property in this table model
	 *         which can be used for updating a corresponding value.
	 */
	public int getIndex(String searchVal) {
		int index = -1;
 
		for (int i = 0; i < key.length; i++) {
			if (key[i].equals(searchVal)) {
				index = i;
				break;
			}
		}
 
		return index;
	}
}