//  Open Hold em is a java-based, server and client environment for hosting 
   //  your own texas hold poker tournaments, and regular tables. It is full 
   //  customizable and deployable in a number of different java-based hosting 
   //  environments.
   //  Copyright (C) 2005 Chris A. Mattmann <chris@baron.pagemewhen.com>
   //
   //  This program is free software; you can redistribute it and/or modify
   //  it under the terms of the GNU General Public License as published by
   //  the Free Software Foundation; either version 2 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 General Public License
  //  along with this program; if not, write to the Free Software
  //  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  //
  //  $Id: RuleSet.java,v 1.2 2005/08/07 02:48:35 mattmann Exp $
  
  package com.openholdem.structs;
  
  import java.util.SortedSet;
  import java.util.TreeSet;
  
  /***
   * @author mattmann
   * @version $Revision: 1.2 $
   * 
   * <p>A set of rules that define a poker game instance.</p>
   * 
   */
  public class RuleSet {
  
      /* the name of the poker game we're playing */
      private String fGameName = null;
      
      /* the number of cards a player holds in her hand */
      private int fNumPlayerCards = -1;
      
      private int fMinHandCardsUsed = -1;
      
      private int fMaxHandCardsUsed = -1;
      
      private int fNumCommunityCards = -1;
      
      private SortedSet fHandRanks = null;
      
      
      /***
       * <p>Construct a new Rule Set with default parameters</p>
       */
      public RuleSet() {
          fHandRanks = new TreeSet();
      }
      
      public RuleSet(int npCards, int minCards, int maxCards, int nComm, SortedSet ranks){
          fNumPlayerCards = npCards;
          fMinHandCardsUsed = minCards;
          fMaxHandCardsUsed = maxCards;
          fNumCommunityCards = nComm;
          fHandRanks = ranks;
      }
      
      
      
      public class HandRank implements Comparable{
          private int fRank = -1;
          private String fHandName = null;
          
          public HandRank(){
              
          }
          
          public int hashCode(){
              return fRank;
          }
          
          public boolean equals(Object o){
              return (this.compareTo(o) == 0);
          }
          
          public HandRank(int rank,String name){
              fRank = rank;
              fHandName = name;
          }
          
          public String toString(){
              StringBuffer rStr = new StringBuffer();
              rStr.append("["+fHandName+","+fRank+"]");
              
              return rStr.toString();
          }
  
          public int compareTo(Object o){
              int compareVal = -1;
              
             HandRank otherRank = (HandRank)o;
             
             //lower the rank, higher the card
             if(otherRank.getFRank() > this.fRank){
                 compareVal = -1;
             }
             else if(otherRank.getFRank() < this.fRank){
                 compareVal = 1;
             }
             else if(otherRank.getFRank() == this.fRank){
                 compareVal = 0;
             }
             
             return compareVal;
         }
         
         /***
          * @return Returns the fHandName.
          */
         public String getFHandName() {
             return fHandName;
         }
 
         /***
          * @param handName The fHandName to set.
          */
         public void setFHandName(String handName) {
             fHandName = handName;
         }
 
         /***
          * @return Returns the fRank.
          */
         public int getFRank() {
             return fRank;
         }
 
         /***
          * @param rank The fRank to set.
          */
         public void setFRank(int rank) {
             fRank = rank;
         }
         
         
     }
 
     /***
      * @return Returns the fGameName.
      */
     public String getFGameName() {
         return fGameName;
     }
 
     /***
      * @param gameName The fGameName to set.
      */
     public void setFGameName(String gameName) {
         fGameName = gameName;
     }
 
     /***
      * @return Returns the fMaxHandCardsUsed.
      */
     public int getFMaxHandCardsUsed() {
         return fMaxHandCardsUsed;
     }
 
     /***
      * @param maxHandCardsUsed The fMaxHandCardsUsed to set.
      */
     public void setFMaxHandCardsUsed(int maxHandCardsUsed) {
         fMaxHandCardsUsed = maxHandCardsUsed;
     }
 
     /***
      * @return Returns the fMinHandCardsUsed.
      */
     public int getFMinHandCardsUsed() {
         return fMinHandCardsUsed;
     }
 
     /***
      * @param minHandCardsUsed The fMinHandCardsUsed to set.
      */
     public void setFMinHandCardsUsed(int minHandCardsUsed) {
         fMinHandCardsUsed = minHandCardsUsed;
     }
 
     /***
      * @return Returns the fNumCommunityCards.
      */
     public int getFNumCommunityCards() {
         return fNumCommunityCards;
     }
 
     /***
      * @param numCommunityCards The fNumCommunityCards to set.
      */
     public void setFNumCommunityCards(int numCommunityCards) {
         fNumCommunityCards = numCommunityCards;
     }
 
     /***
      * @return Returns the fNumPlayerCards.
      */
     public int getFNumPlayerCards() {
         return fNumPlayerCards;
     }
 
     /***
      * @param numPlayerCards The fNumPlayerCards to set.
      */
     public void setFNumPlayerCards(int numPlayerCards) {
         fNumPlayerCards = numPlayerCards;
     }
 
     /***
      * @return Returns the fHandRanks.
      */
     public SortedSet getFHandRanks() {
         return fHandRanks;
     }
 
     /***
      * @param handRanks The fHandRanks to set.
      */
     public void setFHandRanks(SortedSet handRanks) {
         fHandRanks = handRanks;
     }
 
 }