/*******************************************************************************
    * jhunters: Pool League
    * Copyright 2015 Tony Washer
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   ********************************************************************************/
  package net.sourceforge.jhunters.pool.data;
  
  import java.io.File;
  import java.time.LocalDate;
  import java.util.Iterator;
  
  import javafx.beans.property.ObjectProperty;
  import javafx.beans.property.SimpleObjectProperty;
  import net.sourceforge.jhunters.pool.PoolStatus;
  
  /**
   * Data Set.
   */
  public class DataSet {
      /**
       * Object name.
       */
      protected static final String OBJECT_NAME = "HuntersPool";
  
      /**
       * Hash multiplier.
       */
      protected static final int HASH_PRIME = 47;
  
      /**
       * Field Updated.
       */
      private static final String FIELD_UPDATED = "Updated";
  
      /**
       * Field LastChange.
       */
      private static final String FIELD_CHANGED = "LastChange";
  
      /**
       * Field FileName.
       */
      private static final String FIELD_FILENAME = "FileName";
  
      /**
       * DataSet updated.
       */
      private final ObjectProperty<Boolean> theUpdated;
  
      /**
       * DataSet last Change.
       */
      private final ObjectProperty<LocalDate> theLastChange;
  
      /**
       * DataSet fileName.
       */
      private final ObjectProperty<File> theFileName;
  
      /**
       * List of players.
       */
      private final PlayerList thePlayers;
  
      /**
       * List of competitions.
       */
      private final CompetitionList theCompetitions;
  
      /**
       * The status of the list.
       */
      private PoolStatus theStatus;
  
      /**
       * Constructor.
       */
      public DataSet() {
          theUpdated = new SimpleObjectProperty<Boolean>(this, FIELD_UPDATED, Boolean.FALSE);
          theLastChange = new SimpleObjectProperty<LocalDate>(this, FIELD_CHANGED);
          theFileName = new SimpleObjectProperty<File>(this, FIELD_FILENAME);
          thePlayers = new PlayerList();
          theCompetitions = new CompetitionList();
      }
  
      /**
       * Obtain the updated property.
       * @return the updated property.
      */
     public ObjectProperty<Boolean> updatedProperty() {
         return theUpdated;
     }
 
     /**
      * Obtain the last change property.
      * @return the last change property.
      */
     public ObjectProperty<LocalDate> lastChangeProperty() {
         return theLastChange;
     }
 
     /**
      * Obtain the fileName property.
      * @return the fileName property.
      */
     public ObjectProperty<File> fileNameProperty() {
         return theFileName;
     }
 
     /**
      * Is the dataSet updated?
      * @return true/false.
      */
     public Boolean isUpdated() {
         return theUpdated.getValue();
     }
 
     /**
      * Obtain last change date?
      * @return the change date.
      */
     public LocalDate getLastChange() {
         return theLastChange.getValue();
     }
 
     /**
      * Obtain fileName.
      * @return the fileName.
      */
     public File getFileName() {
         return theFileName.getValue();
     }
 
     /**
      * Set the dataSet as updated.
      * @param pUpdated true/false.
      */
     public void setUpdated(final Boolean pUpdated) {
         theUpdated.setValue(pUpdated);
     }
 
     /**
      * Set the last change for the dataSet.
      * @param pDate the date.
      */
     public void setLastChange(final LocalDate pDate) {
         theLastChange.setValue(pDate);
     }
 
     /**
      * Set the fileName for the dataSet.
      * @param pFile the file.
      */
     public void setFileName(final File pFile) {
         theFileName.setValue(pFile);
     }
 
     /**
      * Obtain player list.
      * @return the players
      */
     public PlayerList getPlayers() {
         return thePlayers;
     }
 
     /**
      * Obtain competition list.
      * @return the competitions
      */
     public CompetitionList getCompetitions() {
         return theCompetitions;
     }
 
     /**
      * Obtain the status.
      * @return the status.
      */
     public PoolStatus getStatus() {
         return theStatus;
     }
 
     /**
      * Obtain player iterator.
      * @return the iterator
      */
     public Iterator<Player> playerIterator() {
         return thePlayers.playerIterator();
     }
 
     /**
      * Obtain competition iterator.
      * @return the iterator
      */
     public Iterator<Competition> competitionIterator() {
         return theCompetitions.competitionIterator();
     }
 
     /**
      * Set players.
      * @param pSource the source players
      */
     protected void setPlayers(final PlayerList pSource) {
         /* Set the players */
         thePlayers.setPlayers(pSource.playerIterator());
     }
 
     /**
      * Set competitions.
      * @param pSource the source competitions
      */
     protected void setCompetitions(final CompetitionList pSource) {
         /* Set the competitions */
         theCompetitions.setCompetitions(pSource.competitionIterator());
     }
 
     /**
      * adjust the players.
      */
     public void adjustPlayers() {
         /* adjust players in the competitions */
         theCompetitions.adjustPlayers();
     }
 
     @Override
     public boolean equals(final Object pThat) {
         /* Handle trivial cases */
         if (this == pThat) {
             return true;
         }
         if (pThat == null) {
             return false;
         }
 
         /* Handle wrong class */
         if (!(pThat instanceof DataSet)) {
             return false;
         }
 
         /* Access as dataSet */
         DataSet myThat = (DataSet) pThat;
 
         /* Test on players */
         if (!thePlayers.equals(myThat.getPlayers())) {
             return false;
         }
 
         /* Test competition list */
         return theCompetitions.equals(myThat.getCompetitions());
     }
 
     @Override
     public int hashCode() {
         return (thePlayers.hashCode() * HASH_PRIME)
                 + theCompetitions.hashCode();
     }
 
     /**
      * validate the data.
      * @return the status
      */
     protected PoolStatus validate() {
         /* Validate the players */
         theStatus = thePlayers.validate();
 
         /* If we are valid */
         if (theStatus.isValid()) {
             /* Clear active status on players */
             thePlayers.setActive(Boolean.FALSE);
 
             /* validate the competition list */
             theStatus = theCompetitions.validate();
         }
 
         /* return the status */
         return theStatus;
     }
 
     /**
      * Check for equality allowing for null.
      * @param <T> the object type
      * @param pFirst the first object
      * @param pSecond the second object
      * @return true/false
      */
     protected static <T> boolean isEqual(final T pFirst,
                                          final T pSecond) {
         if (pFirst == null) {
             return pSecond == null;
         }
         return (pSecond == null)
                                 ? false
                                 : pFirst.equals(pSecond);
     }
 }