/*
 * ECatalog is a database front-end, with two main features:
 * 1. Use of preferences
 *  A preference-based approach, where the user is allowed to define the importance of each criterion.
 *  Then the items are ranked accordingly to his criteria.
 * 2. Trade-off analysis
 *  A cooperative database approach, where the system "argues" with the user about his criteria.
 *  When there are no matching items, the system explains the minimal conflicting set and
 *  give some possible strong and weak relaxations about his criteria.
 * This package also containts the software and the set-up details used for our User Study,
 * comparing the use or not of the two previous features mentioned above.
 *
 * Copyright (C) 2006 David Portabella Clotet, Artificial Intelligence Laboratory, EPFL
 * 
 * This file is part of ecatalog-1.0.zip
 * 
 * ECatalog is free software and a free user study set-up;
 * 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 2 of the License, or
 * (at your option) any later version.
 * 
 * ECatalog 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 ECatalog; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 * @version 1.0
 * @author David Portabella
 * To contact the author:
 * email: david@portabella.name and david.portabella@epfl.ch
 * 
 * More information about ECatalog:
 *  http://sourceforge.net/projects/ecatalog/
 *  http://icwww.epfl.ch/~portabel/ecatalogs/
 */

package utils.itemTable;

import java.awt.Color;
import javax.swing.table.TableCellRenderer;

/* The class concerned with the table rendering */
abstract public class ItemTableRenderer {

    /* Get the number of columns */
    abstract public int getNbrColumns();

    /* Get the number of rows for each item */
    abstract public int getNbrItemRows();

    /* Get the column name
     * @param itemRow  the row index (not the table row, but the item row)
     * @param tableCol  the column index
     */
    abstract public String getColumnName(int itemRow, int tableCol);


    /* Get the horizontal and vertical span
     * @param itemRow  the row index (not the table row, but the item row)
     * @param tableCol  the column index
     */
    abstract public CellSpan getCellSpan(int itemRow, int tableCol); 


    /* Get the cell size
     * @param itemRow   the row index (not the table row, but the item row)
     * @param tableCol  the column index
     * @result          the size for the specified cell.
     cellSize.width == -1 means no width preference (use default)
     cellSize.height == -1 means no height preference (use default)
     cellSize == null means no width nor height preference (use default)
    */
    abstract public CellSize getCellSize(int itemRow, int tableCol);


    /* Get the cell which will be rendered, given itemRow and tableCol
     * @param itemRow  the row index (not the table row, but the item row)
     * @param tableCol  the column index
     * @retrun the cell to be used. (change [int,int] by a class width itemRow and tableCol attributes)
     */
    abstract public CellIndex getVisibleCell(int itemRow, int tableCol);

    /* the class implementing this interface should know to extract the information from the Item 
     * @param item      the item from where to extract the requested information
     * @param itemRow   the row index (not the table row, but the item row)
     * @param tableCol  the column index
     */
    abstract public Object getValueAt(Object item, int itemRow, int tableCol);

    /* gets the renderer for the specified cell 
     * @param itemRow  the row index (not the table row, but the item row)
     * @param tableCol  the column index
     * @result a renderer for this cell, or null if non specified (in this case, the default one should be used)
     */
    public ItemTableCellRenderer getItemTableCellRenderer(int itemIndex, int itemRow, int tableCol) {
	return null;
    }

    public boolean isCellEditable(int itemIndex, int rowItem, int tableCol) {
	return false;
    }


    /* gets the editor for the specified cell 
     * @param itemRow  the row index (not the table row, but the item row)
     * @param tableCol  the column index
     * @result an editor for this cell, or null if non specified (in this case, the default one should be used)
     */
    public ItemTableCellEditor getItemTableCellEditor(int itemIndex, int itemRow, int tableCol) {
	return null;
    }

    /* Return the attribute index associated to the cell specified by itemRow,tableCol.
     * @param itemRow  the row index (not the table row, but the item row)
     * @param tableCol  the column index

     * @ result         the attribute index associated to the cell specified by itemRow,tableCol.
     *                  If that cell is not associated to any attribute, return -1
     */
    public int getItemAttributeIndex(int itemRow, int tableCol) {
	return -1;
    }
}