/*
    * This file is part of NetPisteur.
    * 
    * Copyright 2001-2002 : Olivier CORNEC, David BOUANCHEAU, Loic LOPEZ,
    *                       Gaetan BOUDARD, Mael LE LANNOU, Julien ROBINEAU
    * 
    * Copyright 2002-2003 : Olivier BRIENS, Simon DEZE, Florence FRIGOULT,
    *                       Olivier JOURNEAULT, Francois MARTINIER, Damien RAUDE-MORVAN
    * 
   * Copyright 2004-2007 : Damien RAUDE-MORVAN
   * 
   * NetPisteur 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.
   *
   * NetPisteur 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 NetPisteur; if not, write to the Free Software
   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
   *
   */
  package com.drazzib.netpisteur.monitor;
  
  import java.io.BufferedWriter;
  import java.io.FileWriter;
  import java.io.IOException;
  import java.io.PrintWriter;
  import java.io.WriteAbortedException;
  import java.util.ArrayList;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  /**
   * Represents the class ListeClick.java which is used in order to collect every
   * click done by the netsurfer to know where, when on the page this character
   * has clicked.
   * 
   * @author NetPisteur Team
   */
  public class ListClick {
  	
  	private static Log log = LogFactory.getLog(ListClick.class);
  
  	// attributes
  
  	/**
  	 * Represents the clicks'number during a passage on one page and a type's
  	 * array Vector in order to collect all the clicks.
  	 * 
  	 */
  	// click's page number
  	private int nbClickPage;
  
  	// list of click's Vector
  	private ArrayList _listClicks;
  
  	/**
  	 * empty constructor which initializes the click's page at zero & create a
  	 * null Vector
  	 * 
  	 * 
  	 */
  	public ListClick() {
  		this.nbClickPage = 0;
  		this._listClicks = new ArrayList();
  	} // ListeClick's end
  
  	/**
  	 * normal constructor which initializes the click's page & the Vector those
  	 * passed in parameter in the constructor
  	 * 
  	 * @param _nbClickPage
  	 *            click's page number
  	 * @param uneListeClicks
  	 *            a click's list Vector
  	 * 
  	 */
  	public ListClick(int _nbClickPage, ArrayList uneListeClicks) {
  		this.nbClickPage = _nbClickPage;
  		this._listClicks = uneListeClicks;
  	} // ListeClick's end
  
  	// access methods for attributes
  
  	/**
  	 * get the number of Clicks in return of an object of Click's type
  	 * 
  	 * @return Click's type object
  	 * @param index :
  	 *            the index where search the click in the list
  	 */
  	public Click getClick(int index) {
  		Click click = null;
 		if (this._listClicks.size() == 0) {
 			throw new RuntimeException("Aucun click d'enregistr !");
 		}
 		if (index > this._listClicks.size()) {
 			throw new RuntimeException();
 		}
 		if (index <= this._listClicks.size()) {
 			click = (Click) this._listClicks.get(index);
 		}
 		return (click);
 	} // getClick's end
 
 	/**
 	 * add the object Clic to the end of the array Vector named ListeClics
 	 * 
 	 * @param click :
 	 *            type's Click object
 	 * 
 	 */
 	public void ajouter(Click click) {
 		this._listClicks.add(click);
 		this.nbClickPage++;
 
 	} // ajouter's end
 
 	/**
 	 * write a ListClick's array
 	 * 
 	 * @return true or false according to the write's result
 	 * @param file :
 	 *            the file where record measures
 	 * @param sep :
 	 *            the separator of the measure
 	 */
 	public boolean writeListeClickToDisk(String file, String sep) {
 		int abs, ord;
 		Click click;
 		PrintWriter out;
 		boolean retour = false;
 
 		try {
 			out = new PrintWriter(new BufferedWriter(new FileWriter(file)));
 
 			out.println("# Liste des positions lors des clics : ");
 			for (int i = 0; i < this._listClicks.size(); i++) {
 				click = (Click) this._listClicks.get(i);
 				abs = click.getAbs();
 				ord = click.getOrd();
 				if (i == 0) {
 					out.println(abs + "x" + ord + sep + click.getHours() + ":"
 							+ click.getMinutes() + ":" + click.getSeconds());
 				} else {
 					out.println(abs + "x" + ord + sep + click.getHours() + ":"
 							+ click.getMinutes() + ":" + click.getSeconds()
 							+ sep + getIntervalClick(i));
 				}
 			} // -for's end
 
 			out.println("# Nombre de clics : " + this.nbClickPage
 					+ "  -->  intervalle moyen : " + getIntervalMoyen());
 			out.close();
 			retour = true;
 
 		} catch (WriteAbortedException e) {
 			log.error("Erreur d'écriture du fichier", e);
 		}
 
 		catch (IOException e) {
 			log.error("Erreur physique de lecture du fichier", e);
 		}
 		return (retour);
 
 	} // writeListToDisk's end
 
 	/*
 	 * give the middle time's interval between the first & the last click
 	 * 
 	 * @return the middle interval
 	 * 
 	 */
 
 	public long getIntervalMoyen() {
 		long interval = 0;
 
 		if (this._listClicks.size() > 0) {
 			// first click
 			Click premClic = (Click) this._listClicks.get(0);
 
 			// last click
 			Click derClic = (Click) this._listClicks.get(this.nbClickPage - 1);
 
 			long time1 = premClic.getMilliSec();
 			long time2 = derClic.getMilliSec();
 
 			interval = (time2 - time1) / this.nbClickPage - 1;
 		}
 		return interval;
 	} // getIntervalMoyen's end
 
 	/*
 	 * give the time's interval between every click around the click put in
 	 * parameter
 	 * 
 	 * @return the interval before and after the click
 	 * 
 	 */
 
 	public String getIntervalClick(int index) {
 		String inter = "";
 
 		if (this._listClicks.size() > 0) {
 
 			if ((index > 0) && (index < this.nbClickPage - 1)) {
 				Click clic = (Click) this._listClicks.get(index);
 				Click aclic = (Click) this._listClicks.get(index - 1);
 				Click pclic = (Click) this._listClicks.get(index + 1);
 
 				long time = clic.getMilliSec();
 				long atime = aclic.getMilliSec();
 				long ptime = pclic.getMilliSec();
 
 				long avantInter = (time - atime);
 				long apresInter = (ptime - time);
 
 				inter = "intervalle pour " + (index + 1)
 						+ "ime clic : avant (" + (avantInter) + ") / aprs ("
 						+ (apresInter) + ")";
 
 			} // if's end
 
 			else {
 				if (index == this.nbClickPage - 1) {
 					Click clic = (Click) this._listClicks.get(index);
 					Click aclic = (Click) this._listClicks.get(index - 1);
 
 					long time = clic.getMilliSec();
 					long atime = aclic.getMilliSec();
 
 					long avantInter = time - atime;
 
 					inter = "intervalle pour " + (index + 1)
 							+ "ime clic : avant (" + (avantInter)
 							+ ") / aprs (--)";
 				}
 			} // else's end
 		} // else liste vide
 
 		return (inter);
 
 	} // getIntervalClick's end
 
 } // ListeClick class'end