package fr.ifremer.quadrige3.ui.swing.table;
   
   /*-
    * #%L
    * Quadrige3 Core :: Quadrige3 UI Common
    * $Id:$
    * $HeadURL:$
    * %%
    * Copyright (C) 2017 Ifremer
   * %%
   * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU Affero General Public License as published by
   * the Free Software Foundation, either version 3 of the License, or
   * (at your option) any later version.
   * 
   * This program 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 Affero General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   * #L%
   */
  
  import com.google.common.collect.Lists;
  import fr.ifremer.quadrige3.ui.core.dto.CommentAware;
  import org.apache.commons.collections4.CollectionUtils;
  import org.jdesktop.swingx.table.TableColumnModelExt;
  import org.nuiton.jaxx.application.swing.table.AbstractApplicationTableModel;
  
  import java.util.Collections;
  import java.util.List;
  
  /**
   * <p>Abstract AbstractTableModel class.</p>
   *
   * @param <R> type of AbstractRowUIModel
   * @author Ludovic Pecquot <ludovic.pecquot@e-is.pro>
   */
  public abstract class AbstractTableModel<R extends AbstractRowUIModel<?, ?>> extends AbstractApplicationTableModel<R> {
  
      public static final String DEFAULT_STATE_CONTEXT = "DEFAULT_STATE_CONTEXT";
      private AbstractTableUIModel tableUIModel;
  
      /**
       * <p>Constructor for AbstractTableModel.</p>
       *
       * @param columnModel a {@link TableColumnModelExt} object.
       * @param createNewRow a boolean.
       * @param createEmptyRowIsEmpty a boolean.
       */
      public AbstractTableModel(TableColumnModelExt columnModel, boolean createNewRow, boolean createEmptyRowIsEmpty) {
          super(columnModel, createNewRow, createEmptyRowIsEmpty);
      }
  
      /**
       * First column idenitifer for editing.
       *
       * @return Column idenitifer
       */
      public abstract ColumnIdentifier<R> getFirstColumnEditing();
  
      /** {@inheritDoc} */
      @Override
      public boolean isCellEditable(int rowIndex, int columnIndex, org.nuiton.jaxx.application.swing.table.ColumnIdentifier<R> propertyName) {
  
          // the CheckTableColumn (identified by 'selected' property) is always editable
          if (AbstractRowUIModel.PROPERTY_SELECTED.equals(propertyName.getPropertyName())) {
              return true;
          }
  
          R row = getEntry(rowIndex);
  
          // "comment" property on a CommentAware row is editable even if the row is not editable
          if ((row instanceof CommentAware) && "comment".equals(propertyName.getPropertyName())) {
              return true;
          }
  
          // if the row is editable (such a new row) this method force to return true
          if (!row.isEditable()) {
              return false;
          }
  
          // otherwise, try to get the super implementation
          try {
              return super.isCellEditable(rowIndex, columnIndex, propertyName);
          } catch (NullPointerException e) {
              // if the exception is fired, then there is no non-editable columns
              return true;
          }
      }
  
      /** {@inheritDoc} */
      @Override
      public Class<?> getColumnClass(int columnIndex) {
          org.nuiton.jaxx.application.swing.table.ColumnIdentifier<R> colId = getIdentifier(columnIndex);
          if (colId instanceof ColumnIdentifier) {
              return ((ColumnIdentifier) colId).getPropertyType();
         }
         return super.getColumnClass(columnIndex);
     }
 
     /**
      * <p>getIdentifiers.</p>
      *
      * @return a {@link List} object.
      */
     public List<org.nuiton.jaxx.application.swing.table.ColumnIdentifier<R>> getIdentifiers() {
         return identifiers;
     }
 
     /**
      * <p>getMandatoryIdentifiers.</p>
      *
      * @return a {@link List} object.
      */
     public List<ColumnIdentifier<R>> getMandatoryIdentifiers() {
         List<ColumnIdentifier<R>> mandatoryIdentifiers = Lists.newArrayList();
         if (CollectionUtils.isNotEmpty(getIdentifiers())) {
             for (org.nuiton.jaxx.application.swing.table.ColumnIdentifier<R> identifier : getIdentifiers()) {
                 if ((identifier instanceof ColumnIdentifier) && ((ColumnIdentifier<R>) identifier).isMandatory()) {
                     mandatoryIdentifiers.add((ColumnIdentifier<R>) identifier);
                 }
             }
         }
         return mandatoryIdentifiers;
     }
 
     /**
      * Get the table UI model
      *
      * @return table UI model
      */
     public AbstractTableUIModel getTableUIModel() {
         return tableUIModel;
     }
 
     /**
      * Set the table UI model
      *
      * @param tableUIModel table UI model
      */
     public void setTableUIModel(AbstractTableUIModel tableUIModel) {
         this.tableUIModel = tableUIModel;
     }
 
     /** {@inheritDoc} */
     @Override
     protected void onRowAdded(int rowIndex, R row) {
         super.onRowAdded(rowIndex, row);
 
         // tell the table UI model that a new row has been added
         if (getTableUIModel() != null) {
             getTableUIModel().firePropertyChanged(AbstractTableUIModel.PROPERTY_ROWS_ADDED, null, Collections.singletonList(row));
         }
 
     }
 
     /**
      * <p>addNonEditableColumn.</p>
      *
      * @param identifier a {@link ColumnIdentifier} object.
      */
     public void addNonEditableColumn(ColumnIdentifier identifier) {
         if (noneEditableCols == null) {
             setNoneEditableCols(identifier);
         } else {
             noneEditableCols.add(identifier);
         }
     }
 
     /**
      * get the state context for this table model
      *
      * @return a String representing the state context
      */
     public String getStateContext() {
         return DEFAULT_STATE_CONTEXT;
     }
 }