/*
    * The ReWinder Project
    * 
    * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
   */
  package ch.twiddlefinger.inet.rewinder.model.replay;
  
  import java.util.HashSet;
  import java.util.Iterator;
  import java.util.Set;
  
  import ch.twiddlefinger.inet.rewinder.model.chat.ChatLog;
  import ch.twiddlefinger.inet.rewinder.model.entities.GameType;
  import ch.twiddlefinger.inet.rewinder.model.entities.Player;
  import ch.twiddlefinger.inet.rewinder.model.entities.Team;
  import ch.twiddlefinger.inet.rewinder.model.entities.WarcraftVersion;
  
  /***
   * A Warcraft Replay
   */
  public class WarcraftReplay {
  	private GameType gameType;
  	private String gameName;
  	private long lengthMsec;
  	private long fileSize;
  	private long version;
  	private HashSet players = new HashSet();
  	private HashSet teams = new HashSet();
  	private WarcraftVersion warcraftVersion = null;
  
  	/***
  	 * Default Constructor
  	 */
  	public WarcraftReplay() {
  		players = new HashSet();
  	}
  
  	/***
  	 * Returns the {@link WarcraftVersion} of this replay. o Reign of Chaos o
  	 * Frozen Throne
  	 *
  	 * @return version
  	 */
  	public WarcraftVersion getWarcraftVersion() {
  		return warcraftVersion;
  	}
  
  	/***
  	 * Sets the {@link WarcraftVersion} of this Replay Is mostly used by
  	 * parsers
  	 *
  	 * @param version the Warcraft Version
  	 */
  	public void setWarcraftVersion(String version) {
  		if (version.equals("W3XP")) {
  			warcraftVersion = WarcraftVersion.TFT;
  		} else {
  			warcraftVersion = WarcraftVersion.ROC;
  		}
  	}
  
  	/***
  	 * Returns the build version of this replay e.g. 1.13, 1.06, 1.07, 1.12
  	 *
  	 * @return the version tag
  	 */
  	public String getVersion() {
  		return "1." + version;
  	}
  
  	/***
  	 * Sets the replays version tag (e.g. 1.13)
  	 *
  	 * @param version
  	 */
  	public void setVersion(long version) {
  		this.version = version;
  	}
  
  	/***
  	 * The compressed size of the replay file
  	 *
  	 * @return the replay's file size
  	 */
  	public long getFileSize() {
  		return this.fileSize;
  	}
 
 	/***
 	 * Sets the replay's file size
 	 *
 	 * @param size
 	 */
 	public void setFileSize(long size) {
 		this.fileSize = size;
 	}
 
 	/***
 	 * Returns the length of the replay in milliseconds
 	 *
 	 * @return milliseconds
 	 */
 	public long getLengthMsec() {
 		return this.lengthMsec;
 	}
 
 	/***
 	 * Sets the game length in milliseconds
 	 *
 	 * @param msec
 	 */
 	public void setLengthMsec(long msec) {
 		this.lengthMsec = msec;
 	}
 
 	//TODO Chatlog implementieren
 
 	/***
 	 * Returns the ChatLog
 	 *
 	 * @return
 	 */
 	public ChatLog getChatLog() {
 		// TODO Auto-generated method stub
 		return null;
 	}
 
 	/***
 	 * Adds a player which was playing in this replay See {@link Player}
 	 *
 	 * @param p
 	 */
 	public void addPlayer(Player p) {
 		this.players.add(p);
 	}
 
 	/***
 	 * Removes a player from this replay See {@link player}
 	 *
 	 * @param p a player
 	 */
 	public void removePlayer(Player p) {
 		this.players.remove(p);
 	}
 
 	/***
 	 * Searches for player by it's ID
 	 *
 	 * @param id the player's id
 	 *
 	 * @return the coresponding player object
 	 */
 	public Player getPlayerByID(int id) {
 		Iterator i = this.players.iterator();
 
 		while (i.hasNext()) {
 			Player p = (Player) i.next();
 
 			if (p.getPlayerID() == id) {
 				return p;
 			}
 		}
 
 		return null;
 	}
 
 	/***
 	 * Searches for a player by its name
 	 * @param name the player name to be searched for
 	 * @return the player object
 	 */
 
 	public Player getPlayerByName(String name) {
 		Iterator i = this.players.iterator();
 
 		while (i.hasNext()) {
 			Player p = (Player) i.next();
 
 			if (p.getName().equals(name)) {
 				return p;
 			}
 		}
 		return null;
 	}
 
 	/***
 	 * Returns a list of the known players in this replay
 	 *
 	 * @return a player list
 	 */
 	public Set getPlayers() {
 		return this.players;
 	}
 
 	/***
 	 * Sets the game name (e.g. BNet, FooBar's local game ...)
 	 *
 	 * @param name a game name
 	 */
 	public void setGameName(String name) {
 		this.gameName = name;
 	}
 
 	/***
 	 * returns the game's name (e.g. BNet, FooBar's local game ...)
 	 *
 	 * @return the game name
 	 */
 	public String getGameName() {
 		return this.gameName;
 	}
 
 	/***
 	 * returns the number of players in this game
 	 *
 	 * @return
 	 */
 	public int getPlayerCount() {
 		return this.players.size();
 	}
 
 	/***
 	 * Sets the game type (e.g. FFA, 1on1, AT, RT etc.)
 	 *
 	 * @param type
 	 */
 	public void setGameType(GameType type) {
 		this.gameType = type;
 	}
 
 	/***
 	 * Returns the game type
 	 *
 	 * @return the game's type (1on1, RT, AT, FFA)
 	 */
 	public GameType getGameType() {
 		return this.gameType;
 	}
 
 	/***
 	 * returns a team by its id, if the team doesnt exist, it will be created
 	 * @param b
 	 * @return a team with a distinctive id
 	 */
 	public Team getTeamByID(byte id) {
 		Team t = null;
 		Iterator i = this.teams.iterator();
 		while (i.hasNext()) {
 			Team temp = (Team) i.next();
 			if (temp.getID() == id) {
 				t = temp;
 				break;
 			}
 		}
 
 		if (t == null) {
 			t = new Team(id);
 			this.teams.add(t);
 		}
 
 		return t;
 	}
 
 	/***
 	 * @return
 	 */
 	public int getTeamCount() {
 		return this.teams.size();
 	}
 
 	/***
 	 * @return
 	 */
 	public Iterator getTeamIterator() {
 		return this.teams.iterator();
 	}
 
 	/***
 	 * @return
 	 */
 	public Iterator getPlayerIterator() {
 		return this.players.iterator();
 	}
 }