/*
 * Créé le 13 sept. 2004
 *
 */
package resultat;

/**
 * évènement émis par une InterfaceResultat pour signaler diverses modifications.
 * Il peut s'agir de l'insertion/remplacement/suppression d'un des constituant de l'InterfaceResultat.
 * Il peut aussi s'agir de sa suppression ou d'un raffraichissement.
 * 
 * @author	Vincent Labatut
 * @version	1
 * @see		resultat.InterfaceResultat
 * @see		resultat.ResultatListener
  */
public class ResultatEvent
{	/**
	* InterfaceResultat qui émet le ResultatEvent.
	 */
	private InterfaceResultat source;
	/**
	* InterfaceResultat impliqué le ResultatEvent.
	 */
	private InterfaceResultat cible;
	/**
	* Type de modification, dans le cas d'un ResultatEvent de modification de constituant.
	 */
	private int type;
	/**
	* Index du constituant modifié, dans le cas d'un ResultatEvent de modification de constituant.
	 */
	private int index;

//	----------------------------------------	
//	Constantes de classe
//	----------------------------------------
	/**
	* Si la ResultatEvent n'est pas une modification de constituant.
	 */
	public final static int NONE = 0; //rien
	/**
	* Si le ResultatEvent est une modification de constituant : insertion d'un nouveau composant. 
	 */
	public final static int ELT_INSER = 1; //insertion d'un nouveau composant
	/**
	* Si le ResultatEvent est une modification de constituant : suppression d'un composant. 
	 */
	public final static int ELT_SUPPR = 2; //suppression d'un composant
	/**
	* Si le ResultatEvent est une modification de constituant : remplacement d'un composant. 
	 */
	public final static int ELT_REMPL = 3; //remplacement d'un composant
	
	
//	----------------------------------------	
//	Constructeurs
//	----------------------------------------
	/**
	 * Constructeur pour créer un ResultatEvent à partir d'une source.
	 * Les type et index sont initialisés à des valeurs neutres.
	 * Plutot dédié à des ResultatEvents de raffraichissement, cache, completude, 
	 * renommage, suppression.
	 * 
	 * @param 	i	source de la ResultatEvent.
	  */
	public ResultatEvent(InterfaceResultat i)
	{	source = i;
	}
	/**
	 * Constructeur pour créer un ResultatEvent à partir d'une source,
	 * d'un type et d'un index.
	 * Plutot dédié à des ResultatEvents de modification de constituant.
	 * 
	 * @param 	i	source de la ResultatEvent.
	 * @param 	t	type de la ResultatEvent.
	 * @param 	id	index de la ResultatEvent.
	  */
	public ResultatEvent(InterfaceResultat i, int t, int id)
	{	source = i;
		cible = null;
		type = t;
		index = id;
	}	
	
//	----------------------------------------	
//	Attributs
//	----------------------------------------
	/**
	 * renvoie la source du ResultatEvent.
	 * C'est à dire l'InterfaceResultat qui l'a émis.
	 * 
	 * @return	source de la ResultatEvent.
	  */
	public InterfaceResultat getSource()
	{	return source;
	}
	/**
	 * renvoie la cible du ResultatEvent.
	 * 
	 * @return	source de la ResultatEvent.
	  */
	public InterfaceResultat getCible()
	{	return cible;
	}
	/**
	 * renvoie le type du ResultatEvent.
	 * C.f. les constantes de classe.
	 * 
	 * @return	type de la ResultatEvent.
	  */
	public int getType()
	{	return type;
	}
	/**
	 * renvoie l'index du ResultatEvent.
	 * Dans le cas d'un ResultatEvent de modification de constituant.
	 * 
	 * @return	index de la ResultatEvent.
	  */
	public int getIndex()
	{	return index;
	}
}