/*******************************************************************************
    * 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.util.Comparator;
  
  import javafx.beans.property.IntegerProperty;
  import javafx.beans.property.ObjectProperty;
  import javafx.beans.property.SimpleIntegerProperty;
  import javafx.beans.property.SimpleObjectProperty;
  import net.sourceforge.jhunters.pool.PoolStatus;
  
  /**
   * Player Definition.
   */
  public class Player implements Comparable<Player> {
      /**
       * Player Object Name.
       */
      protected static final String OBJECT_NAME = DataResource.PLAYER_NAME.getValue();
  
      /**
       * Bye indication.
       */
      public static final String PLAYER_BYE = DataResource.PLAYER_BYE.getValue();
  
      /**
       * Player Id.
       */
      private final IntegerProperty theId;
  
      /**
       * Player Name.
       */
      private final ObjectProperty<String> theName;
  
      /**
       * Player Contact.
       */
      private final ObjectProperty<String> theContact;
  
      /**
       * Player Active.
       */
      private final ObjectProperty<Boolean> theActive;
  
      /**
       * Player Selected.
       */
      private final ObjectProperty<Boolean> theSelected;
  
      /**
       * Player Status.
       */
      private final ObjectProperty<PoolStatus> theStatus;
  
      /**
       * Constructor.
       */
      public Player() {
          /* Allocate properties */
          theId = new SimpleIntegerProperty(this, PlayerField.ID.toString());
          theName = new SimpleObjectProperty<String>(this, PlayerField.NAME.toString());
          theContact = new SimpleObjectProperty<String>(this, PlayerField.CONTACT.toString());
          theActive = new SimpleObjectProperty<Boolean>(this, PlayerField.ACTIVE.toString(), Boolean.FALSE);
          theSelected = new SimpleObjectProperty<Boolean>(this, PlayerField.SELECTED.toString(), Boolean.TRUE);
          theStatus = new SimpleObjectProperty<PoolStatus>(this, PlayerField.STATUS.toString());
      }
  
      @Override
      public String toString() {
          return getName();
      }
  
      /**
       * Set named property.
       * @param pName the name of the property.
       * @param pValue the value of the property.
       */
      protected void setNamedProperty(final String pName,
                                      final String pValue) {
          if (pName.equals(PlayerField.ID.toString())) {
              setId(DataParser.parseInteger(pValue));
          } else if (pName.equals(PlayerField.NAME.toString())) {
              setName(pValue);
         } else if (pName.equals(PlayerField.CONTACT.toString())) {
             setContact(pValue);
         }
     }
 
     /**
      * Obtain the id property.
      * @return the player id property.
      */
     public IntegerProperty idProperty() {
         return theId;
     }
 
     /**
      * Obtain the name property.
      * @return the player name property.
      */
     public ObjectProperty<String> nameProperty() {
         return theName;
     }
 
     /**
      * Obtain the contact property.
      * @return the contact property.
      */
     public ObjectProperty<String> contactProperty() {
         return theContact;
     }
 
     /**
      * Obtain the selected property.
      * @return the selected property.
      */
     public ObjectProperty<Boolean> selectedProperty() {
         return theSelected;
     }
 
     /**
      * Obtain the active property.
      * @return the active property.
      */
     public ObjectProperty<Boolean> activeProperty() {
         return theActive;
     }
 
     /**
      * Obtain the status property.
      * @return the status.
      */
     public ObjectProperty<PoolStatus> statusProperty() {
         return theStatus;
     }
 
     /**
      * Obtain the id.
      * @return the player name.
      */
     protected Integer getId() {
         return theId.getValue();
     }
 
     /**
      * Obtain the name.
      * @return the player name.
      */
     public String getName() {
         return theName.getValue();
     }
 
     /**
      * Obtain the contact.
      * @return the contact.
      */
     public String getContact() {
         return theContact.getValue();
     }
 
     /**
      * Is the player selected?
      * @return true/false.
      */
     public Boolean isSelected() {
         return theSelected.getValue();
     }
 
     /**
      * Is the player active?
      * @return true/false.
      */
     public Boolean isActive() {
         return theActive.getValue();
     }
 
     /**
      * Obtain the status.
      * @return the status.
      */
     public PoolStatus getStatus() {
         return theStatus.getValue();
     }
 
     /**
      * Set the id.
      * @param pId the id.
      */
     protected void setId(final Integer pId) {
         theId.setValue(pId);
     }
 
     /**
      * Set the name.
      * @param pName the name.
      */
     public void setName(final String pName) {
         theName.setValue(pName == null
                                       ? null
                                       : pName.trim());
     }
 
     /**
      * Set the contact.
      * @param pContact the contact.
      */
     private void setContact(final String pContact) {
         theContact.setValue(pContact == null
                                             ? null
                                             : pContact.trim());
     }
 
     /**
      * Set the active flag.
      * @param pValue the new value.
      */
     protected void setActive(final Boolean pValue) {
         theActive.setValue(pValue);
     }
 
     /**
      * Set the status.
      * @param pStatus the status.
      */
     protected void setStatus(final PoolStatus pStatus) {
         theStatus.setValue(pStatus);
     }
 
     @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 Player)) {
             return false;
         }
 
         /* Access as player */
         Player myThat = (Player) pThat;
 
         /* Check names */
         if (!DataSet.isEqual(getId(), myThat.getId())) {
             return false;
         }
 
         /* Check names */
         if (!DataSet.isEqual(getName(), myThat.getName())) {
             return false;
         }
 
         /* Test on contact */
         return DataSet.isEqual(getContact(), myThat.getContact());
     }
 
     @Override
     public int hashCode() {
         return (theId.hashCode() * DataSet.HASH_PRIME)
                 + theName.hashCode();
     }
 
     @Override
     public int compareTo(final Player pThat) {
         /* Check for equality and null player */
         if (equals(pThat)) {
             return 0;
         }
         if (pThat == null) {
             return -1;
         }
 
         /* Access names */
         String myName = getName();
         String myOther = pThat.getName();
 
         /* Check for null names */
         if (myName == null) {
             return 1;
         }
         if (myOther == null) {
             return -1;
         }
 
         /* Compare names */
         return myName.compareToIgnoreCase(myOther);
     }
 
     /**
      * Validate player.
      * @return the status
      */
     protected PoolStatus validate() {
         /* Check Name */
         String myName = getName();
         PoolStatus myStatus = ((myName == null)
                 || (myName.length() == 0)
                 || myName.equals(PLAYER_BYE))
                                              ? PoolStatus.INVALID
                                              : PoolStatus.VALID;
 
         /* Check Id */
         if (myStatus.isValid()) {
             Integer myId = getId();
             myStatus = myId <= 0
                                 ? PoolStatus.INVALID
                                 : PoolStatus.VALID;
 
         }
 
         /* Set and return the status */
         setStatus(myStatus);
         return myStatus;
     }
 
     /**
      * Comparator class.
      */
     public static final class PlayerComparator implements Comparator<Player> {
         @Override
         public int compare(final Player pFirst,
                            final Player pSecond) {
             return pFirst.compareTo(pSecond);
         }
     }
 
     /**
      * Player fields.
      */
     public enum PlayerField {
         /**
          * ID.
          */
         ID,
 
         /**
          * Name.
          */
         NAME,
 
         /**
          * Contact.
          */
         CONTACT,
 
         /**
          * Selected.
          */
         SELECTED,
 
         /**
          * Active.
          */
         ACTIVE,
 
         /**
          * Status.
          */
         STATUS;
 
         /**
          * The String name.
          */
         private String theName;
 
         @Override
         public String toString() {
             /* If we have not yet loaded the name */
             if (theName == null) {
                 /* Load the name */
                 theName = DataResource.getKeyForPlayerField(this).getValue();
             }
 
             /* return the name */
             return theName;
         }
     }
 }