package fr.ifremer.quadrige3.ui.swing.model;
   
   /*-
    * #%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 org.jdesktop.beans.AbstractBean;
  import org.jdesktop.beans.AbstractSerializableBean;
  import org.nuiton.jaxx.application.listener.PropagatePropertyChangeListener;
  import org.nuiton.util.CollectionUtil;
  import org.nuiton.util.beans.Binder;
  
  import java.beans.PropertyChangeListener;
  import java.util.Collection;
  import java.util.List;
  
  /**
   * Abstract UI model to edit a bean.
   *
   * @param <B> type of Bean
   * @param <M> type of model
   * @author Ludovic Pecquot <ludovic.pecquot@e-is.pro>
   * @since 0.1
   * <p/>
   * classes extending this must implement the E interface and delegate methods to delegateObject
   */
  public abstract class AbstractBeanUIModel<B, M extends AbstractBeanUIModel<B, M>> extends AbstractSerializableBean implements BeanPropertyChangeListener {
  
      /**
       * Constant <code>PROPERTY_MODIFY="modify"</code>
       */
      public static final String PROPERTY_MODIFY = "modify";
      /**
       * Constant <code>PROPERTY_VALID="valid"</code>
       */
      public static final String PROPERTY_VALID = "valid";
      /**
       * Constant <code>PROPERTY_LOADING="loading"</code>
       */
      public static final String PROPERTY_LOADING = "loading";
      private static final long serialVersionUID = 1L;
      private final Binder<B, M> fromBeanBinder;
      private final Binder<M, B> toBeanBinder;
      protected boolean modify;
      protected boolean valid;
      protected boolean loading;
      protected B delegateObject = newBean();
  
      /**
       * <p>Constructor for AbstractBeanUIModel.</p>
       *
       * @param fromBeanBinder a {@link org.nuiton.util.beans.Binder} object.
       * @param toBeanBinder   a {@link org.nuiton.util.beans.Binder} object.
       */
      protected AbstractBeanUIModel(Binder<B, M> fromBeanBinder, Binder<M, B> toBeanBinder) {
          this.fromBeanBinder = fromBeanBinder;
          this.toBeanBinder = toBeanBinder;
  
          // add property change listener and propagate all event to this model
          addPropagatePropertyChangeListener();
      }
  
      /**
       * <p>fromBean.</p>
       *
       * @param bean a B object.
       */
      @SuppressWarnings("unchecked")
      public void fromBean(B bean) {
          fromBeanBinder.copy(bean, (M) this);
      }
  
      /**
       * <p>toBean.</p>
       *
       * @return a B object.
       */
      @SuppressWarnings("unchecked")
      public B toBean() {
          B result = newBean();
         toBeanBinder.copy((M) this, result);
         return result;
     }
 
     /**
      * <p>setBean.</p>
      *
      * @param bean a B object.
      */
     public void setBean(B bean) {
 
         // remove previous listeners
         removePropagatePropertyChangeListener();
 
         // Set new bean
         delegateObject = bean;
 
         // add new listener
         addPropagatePropertyChangeListener();
     }
 
     private void addPropagatePropertyChangeListener() {
         if (delegateObject instanceof AbstractBean) {
             PropagatePropertyChangeListener.listenAndPropagateAll((AbstractBean) delegateObject, this);
         }
     }
 
     private void removePropagatePropertyChangeListener() {
         if (delegateObject instanceof AbstractBean) {
             for (PropertyChangeListener listener : ((AbstractBean) delegateObject).getPropertyChangeListeners()) {
                 ((AbstractBean) delegateObject).removePropertyChangeListener(listener);
             }
         }
     }
 
     /**
      * <p>newBean.</p>
      *
      * @return a B object.
      */
     protected abstract B newBean();
 
     /**
      * <p>isModify.</p>
      *
      * @return a boolean.
      */
     public boolean isModify() {
         return modify;
     }
 
     /**
      * <p>Setter for the field <code>modify</code>.</p>
      *
      * @param modify a boolean.
      */
     public void setModify(boolean modify) {
         boolean oldValue = isModify();
         this.modify = modify;
         firePropertyChange(PROPERTY_MODIFY, oldValue, modify);
     }
 
     /**
      * <p>isValid.</p>
      *
      * @return a boolean.
      */
     public boolean isValid() {
         return valid;
     }
 
     /**
      * <p>Setter for the field <code>valid</code>.</p>
      *
      * @param valid a boolean.
      */
     public void setValid(boolean valid) {
         boolean oldValue = isValid();
         this.valid = valid;
         firePropertyChange(PROPERTY_VALID, oldValue, valid);
     }
 
     /**
      * <p>isLoading.</p>
      *
      * @return a boolean.
      */
     public boolean isLoading() {
         return loading;
     }
 
     /**
      * <p>Setter for the field <code>loading</code>.</p>
      *
      * @param loading a boolean.
      */
     public void setLoading(boolean loading) {
         boolean oldValue = isLoading();
         this.loading = loading;
         firePropertyChange(PROPERTY_LOADING, oldValue, loading);
     }
 
     //------------------------------------------------------------------------//
     //-- PropagatePropertyChangeListener methods                            --//
     //------------------------------------------------------------------------//
 
     /**
      * {@inheritDoc}
      */
     @Override
     public void firePropertyChanged(String propertyName, Object oldValue, Object newValue) {
         firePropertyChange(propertyName, oldValue, newValue);
         setModelModify(propertyName, oldValue, newValue);
     }
 
     @Override
     public void fireIndexedPropertyChanged(String propertyName, int index, Object oldValue, Object newValue) {
         fireIndexedPropertyChange(propertyName, index, oldValue, newValue);
         setModelModify(propertyName, oldValue, newValue);
     }
 
     private void setModelModify(String propertyName, Object oldValue, Object newValue) {
         // set model is modify only if oldValue != newValue
         // some property change event has both oldValue and newValue as null and we don't want to handle it
         if (!PROPERTY_MODIFY.equals(propertyName)
                 && !PROPERTY_LOADING.equals(propertyName)
                 && oldValue != newValue) {
             setModify(true);
         }
     }
 
     /**
      * <p>getChild.</p>
      *
      * @param child a {@link java.util.Collection} object.
      * @param index a int.
      * @return a B object.
      */
     protected B getChild(Collection<B> child, int index) {
         return CollectionUtil.getOrNull(child, index);
     }
 
     /**
      * <p>getChild.</p>
      *
      * @param child a {@link java.util.List} object.
      * @param index a int.
      * @return a B object.
      */
     protected B getChild(List<B> child, int index) {
         return CollectionUtil.getOrNull(child, index);
     }
 
 }