/*
    * Copyright (c) 2003-2008 by Cosylab d. d.
    *
    * This file is part of CosyBeans-Common.
    *
    * CosyBeans-Common 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.
   *
   * CosyBeans-Common 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 CosyBeans-Common.  If not, see <http://www.gnu.org/licenses/>.
   */
  
  package com.cosylab.gui.components;
  
  import com.cosylab.gui.components.table.DefaultObjectTableEngine;
  import com.cosylab.gui.components.table.MutableTableModelRows;
  import com.cosylab.gui.components.table.ObjectTableEngine;
  import com.cosylab.gui.components.table.TableRow;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.HashMap;
  import java.util.Iterator;
  import java.util.Map;
  import java.util.Set;
  
  
  /**
   * <code>TableModel</code>, which accepts new items as objects and converts
   * them to new rows. This model acts as <code>Set</code> for Objects, it does
   * not hold them in constant order and does not permit multiple entries with
   * same object.
   *
   * @author <a href="mailto:igor.kriznar@cosylab.com">Igor Kriznar</a>
   */
  public class ObjectTableModel extends MutableTableModelRows implements Set
  {
  	private static final long serialVersionUID = 1L;
  	private ObjectTableEngine objectTableEngine;
  	private Map<Object, TableRow> objects2rows = new HashMap<Object, TableRow>();
  
  	/**
  	 * Creates new empty model.
  	 */
  	public ObjectTableModel()
  	{
  		super();
  	}
  
  	/**
  	 * Creates new model with engine.
  	 *
  	 * @param engine the table engine
  	 */
  	public ObjectTableModel(ObjectTableEngine engine)
  	{
  		this();
  		setObjectTableEngine(engine);
  	}
  
  	/* (non-Javadoc)
  	 * @see java.util.Set#size()
  	 */
  	public int size()
  	{
  		return objects2rows.size();
  	}
  
  	/* (non-Javadoc)
  	 * @see java.util.Set#clear()
  	 */
  	public synchronized void clear()
  	{
  		Object[] o = objects2rows.keySet().toArray();
  
  		for (int i = 0; i < o.length; i++) {
  			remove(o[i]);
  		}
  	}
  
  	/* (non-Javadoc)
  	 * @see java.util.Set#isEmpty()
  	 */
  	public boolean isEmpty()
  	{
  		return objects2rows.isEmpty();
  	}
  
  	/* (non-Javadoc)
  	 * @see java.util.Set#toArray()
  	 */
  	public synchronized Object[] toArray()
 	{
 		return objects2rows.keySet().toArray();
 	}
 
 	/* (non-Javadoc)
 	 * @see java.util.Set#add(java.lang.Object)
 	 */
 	public synchronized boolean add(Object o)
 	{
 		if (objects2rows.containsKey(o)) {
 			return false;
 		}
 
 		TableRow row = getObjectTableEngine().getTableRow(o);
 
 		if (row == null) {
 			return false;
 		}
 
 		addRow(row);
 		objects2rows.put(o, row);
 
 		return true;
 	}
 
 	/* (non-Javadoc)
 	 * @see java.util.Set#contains(java.lang.Object)
 	 */
 	public synchronized boolean contains(Object o)
 	{
 		return objects2rows.containsKey(o);
 	}
 
 	/* (non-Javadoc)
 	 * @see java.util.Set#remove(java.lang.Object)
 	 */
 	public synchronized boolean remove(Object o)
 	{
 		TableRow r = objects2rows.get(o);
 
 		if (r == null) {
 			return false;
 		}
 
 		removeRow(r);
 		objects2rows.remove(o);
 		getObjectTableEngine().releaseTableRow(o, r);
 
 		return true;
 	}
 
 	/* (non-Javadoc)
 	 * @see java.util.Set#addAll(java.util.Collection)
 	 */
 	public synchronized boolean addAll(Collection c)
 	{
 		boolean b = false;
 		Iterator it = c.iterator();
 
 		while (it.hasNext()) {
 			Object o = it.next();
 
 			if (!objects2rows.containsKey(o)) {
 				b = true;
 				add(o);
 			}
 		}
 
 		return b;
 	}
 
 	/* (non-Javadoc)
 	 * @see java.util.Set#containsAll(java.util.Collection)
 	 */
 	public synchronized boolean containsAll(Collection c)
 	{
 		return objects2rows.keySet().containsAll(c);
 	}
 
 	/* (non-Javadoc)
 	 * @see java.util.Set#removeAll(java.util.Collection)
 	 */
 	public synchronized boolean removeAll(Collection c)
 	{
 		if (c == null || c.isEmpty()) {
 			return false;
 		}
 
 		Iterator it = c.iterator();
 
 		while (it.hasNext()) {
 			remove(it.next());
 		}
 
 		return true;
 	}
 
 	/* (non-Javadoc)
 	 * @see java.util.Set#retainAll(java.util.Collection)
 	 */
 	public synchronized boolean retainAll(Collection c)
 	{
 		ArrayList<Object> rem = new ArrayList<Object>(objects2rows.size());
 		Iterator<Object> it = objects2rows.keySet().iterator();
 
 		while (it.hasNext()) {
 			Object key = it.next();
 
 			if (!c.contains(key)) {
 				rem.add(key);
 			}
 		}
 
 		return removeAll(rem);
 	}
 
 	/* (non-Javadoc)
 	 * @see java.util.Set#iterator()
 	 */
 	public Iterator iterator()
 	{
 		return objects2rows.keySet().iterator();
 	}
 
 	/* (non-Javadoc)
 	 * @see java.util.Set#toArray(java.lang.Object[])
 	 */
 	@SuppressWarnings("unchecked")
 	public synchronized Object[] toArray(Object[] a)
 	{
 		return objects2rows.keySet().toArray(a);
 	}
 
 	/**
 	 * Return engine, which converts objects to table rows. If engine was not
 	 * set before, call to this method initializes this model to
 	 * <code>DefaultObjectTableEngine</code>.
 	 *
 	 * @return object to row converter
 	 */
 	public ObjectTableEngine getObjectTableEngine()
 	{
 		if (objectTableEngine == null) {
 			objectTableEngine = new DefaultObjectTableEngine();
 		}
 
 		return objectTableEngine;
 	}
 
 	/**
 	 * Sets new object to for converter. Setting new factory is only alllowed
 	 * with empty model.
 	 *
 	 * @param objectTableEngine new object to row converter
 	 *
 	 * @throws IllegalStateException if model is not empty
 	 */
 	public void setObjectTableEngine(ObjectTableEngine objectTableEngine)
 	{
 		if (size() > 0) {
 			throw new IllegalStateException(
 			    "objectTableEngine can be changed only on empty model.");
 		}
 
 		this.objectTableEngine = objectTableEngine;
 	}
 
 	/* (non-Javadoc)
 	 * @see javax.swing.table.AbstractTableModel#setValueAt(java.lang.Object, int, int)
 	 */
 	public synchronized void setValueAt(Object aValue, int rowIndex,
 	    int columnIndex)
 	{
 		if (rowIndex < 0 || rowIndex >= getRowCount() || columnIndex < 0
 		    || columnIndex >= getColumnCount()) {
 			return;
 		}
 
 		TableRow tr = getRow(rowIndex);
 
 		Iterator it = objects2rows.keySet().iterator();
 
 		while (it.hasNext()) {
 			Object o = it.next();
 
 			if (tr == objects2rows.get(o)) {
 				getObjectTableEngine().setValue(aValue, o, tr, columnIndex);
 
 				return;
 			}
 		}
 	}
 	/* (non-Javadoc)
 	 * @see com.cosylab.gui.components.table.TableModelRows#getColumnName(int)
 	 */
 	public String getColumnName(int column) {
 		return getObjectTableEngine().getColumnName(column);
 	}
 }
 
 /* __oOo__ */