// $HeadURL$
// $Id$
//
// Copyright © 2006, 2010, 2011, 2012 by the President and Fellows of Harvard College.
//
// Screensaver is an open-source project developed by the ICCB-L and NSRB labs
// at Harvard Medical School. This software is distributed under the terms of
// the GNU General Public License.

package edu.harvard.med.screensaver.ui.arch.datatable;

import edu.harvard.med.screensaver.model.AbstractEntity;
import edu.harvard.med.screensaver.ui.arch.searchresults.SearchResults;


/**
 * DataTable subclass that add support for the display of a row's "detail"
 * in a subtable, where the detail data is packaged as a SearchResult
 *
 * @param E the type of each row's data object
 * @param D the type of each row's detail data SearchResult object
 * @author <a mailto="andrew_tolopko@hms.harvard.edu">Andrew Tolopko</a>
 * @author <a mailto="john_sullivan@hms.harvard.edu">John Sullivan</a>
 */
public abstract class DataTableWithRowDetail<R extends AbstractEntity,K,P,D extends SearchResults> extends DataTable<R>
{
  // static members

  //private static final String[] CAPABILITIES = { "viewRowDetail" };

  // instance data members

  private D _rowDetail;
  private boolean _isRowDetailVisible;


  // public constructors and methods

  protected DataTableWithRowDetail()
  {
    //super(CAPABILITIES);
  }

  protected void makeRowDetail(R entity)
  {
  }

  public D getRowDetail()
  {
    return _rowDetail;
  }

  public void setRowDetail(D rowDetail)
  {
    _rowDetail = rowDetail;
  }

  @SuppressWarnings("unchecked")
  public String showRowDetail()
  {
    if (getDataTableModel().isRowAvailable()) {
      R entity = getRowData();
      makeRowDetail(entity);
      _isRowDetailVisible = true;
    }
    return REDISPLAY_PAGE_ACTION_RESULT;
  }

  public String hideRowDetail()
  {
    _isRowDetailVisible = false;
    return REDISPLAY_PAGE_ACTION_RESULT;
  }

  public boolean isRowDetailVisible()
  {
    return _isRowDetailVisible;
  }

  // protected methods

//  @Override
//  protected void setEditMode(boolean isEditMode)
//  {
//    hideRowDetail();
//    super.setEditMode(isEditMode);
//  }


  // private methods

}