/*
 * Créé le 17 juil. 2004
 *
 */
package traitement;

/**
 * évčnement émis par une InterfaceTraitement pour signaler diverses modifications.
 * Il peut s'agir de l'insertion/remplacement/suppression d'un des constituant de l'InterfaceTraitement.
 * Il peut aussi s'agir d'un changement de sa complétude, d'un renommage.
 * Cela peut aussi ętre la suppression pure et simple de l'InterfaceTraitement.
 * 
 * @author	Vincent Labatut
 * @version	1
 * @see		traitement.InterfaceTraitement
 * @see		traitement.TraitementListener
  */
public class TraitementEvent
{	/**
	* InterfaceTraitement qui émet la TraitementEvent.
	 */
	private InterfaceTraitement source;
	/**
	* Autre InterfaceTraitement impliquée dans ce TraitementEvent.
	 */
	private InterfaceTraitement cible;
	/**
	* Type de modification, dans le cas d'un TraitementEvent de modification de constituant.
	 */
	private int type;
	/**
	* Index du constituant modifié, dans le cas d'un TraitementEvent de modification de constituant.
	 */
	private int index;

//	----------------------------------------	
//	Constantes de classe
//	----------------------------------------
	/**
	* Si la TraitementEvent n'est pas une modification de constituant.
	 */
	public final static int NONE = 0; //rien
	/**
	* Si la TraitementEvent est une modification de constituant : insertion d'un nouveau composant. 
	 */
	public final static int ELT_INSER = 1; //insertion d'un nouveau composant
	/**
	* Si la TraitementEvent est une modification de constituant : suppression d'un composant. 
	 */
	public final static int ELT_SUPPR = 2; //suppression d'un composant
	/**
	* Si la TraitementEvent est une modification de constituant : remplacement d'un composant. 
	 */
	public final static int ELT_REMPL = 3; //remplacement d'un composant
	/**
	* Si la TraitementEvent est un raffraichissement dű ŕ un renommage. 
	 */
	public final static int RENOMMAGE = 4;
	/**
	* Si la TraitementEvent est un raffraichissement dű ŕ une modification survenue dans une liste définie dans l'objet concerné.
	* Pour l'instant, c'est utilisé dans le cadre des NoeudsStructurels, lorsque les listes des références possibles pour (leurs slots)
	* sont modifiées.  
	 */
	public final static int LISTE = 5;
	/**
	* Si la TraitementEvent est un raffraichissement dű ŕ un évčnement survenu en aval, ie dans un objet situé plus bas dans la hiérarchie.
	 */
	public final static int TRANSMISSION = 6;
	
//	----------------------------------------	
//	Constructeurs
//	----------------------------------------
	/**
	 * Constructeur pour créer un TraitementEvent ŕ partir d'une source.
	 * Les type et index sont initialisés ŕ des valeurs neutres.
	 * Plutot dédié ŕ des TraitementEvents de raffraichissement, cache, completude, 
	 * renommage, suppression.
	 * 
	 * @param 	i	source de la TraitementEvent.
	  */
	public TraitementEvent(InterfaceTraitement i)
	{	source = i;
		cible = null;
		type = NONE;
		index = -1;
	}
	/**
	 * Constructeur pour créer un TraitementEvent ŕ partir d'une source et d'un type.
	 * L'index est initialisé ŕ -1.
	 * 
	 * @param 	i	source de la TraitementEvent.
	 * @param 	t	type de la TraitementEvent.
	  */
	public TraitementEvent(InterfaceTraitement i, int t)
	{	source = i;
		cible = null;
		type = t;
		index = -1;
	}
	/**
	 * Constructeur pour créer un TraitementEvent ŕ partir d'une source,
	 * d'un type et d'un index.
	 * Plutot dédié ŕ des TraitementEvents de modification de constituant.
	 * 
	 * @param 	i	source de la TraitementEvent.
	 * @param 	t	type de la TraitementEvent.
	 * @param 	id	index de la TraitementEvent.
	  */
	public TraitementEvent(InterfaceTraitement i, int t, int id)
	{	source = i;
		cible = null;
		type = t;
		index = id;
	}	
	/**
	 * Constructeur pour créer un TraitementEvent ŕ partir d'une source,
	 * et d'une cible.
	 * Dédié ŕ des TraitementEvents de remplacement.
	 * 
	 * @param 	s	source de la TraitementEvent.
	 * @param 	c	type de la TraitementEvent.
	  */
	public TraitementEvent(InterfaceTraitement s, InterfaceTraitement c)
	{	source = s;
		cible = c;
		type = NONE;
		index = -1;
	}	
	
//	----------------------------------------	
//	Attributs
//	----------------------------------------
	/**
	 * renvoie la source de la TraitementEvent.
	 * C'est ŕ dire l'InterfaceTraitement qui l'a émis.
	 * 
	 * @return	source de la TraitementEvent.
	  */
	public InterfaceTraitement getSource()
	{	return source;
	}
	/**
	 * renvoie la cible de la TraitementEvent.
	 * 
	 * @return	source de la TraitementEvent.
	  */
	public InterfaceTraitement getCible()
	{	return cible;
	}
	/**
	 * renvoie le type de la TraitementEvent.
	 * C.f. les constantes de classe.
	 * 
	 * @return	type de la TraitementEvent.
	  */
	public int getType()
	{	return type;
	}
	/**
	 * renvoie l'index de la TraitementEvent.
	 * Dans le cas d'un TraitementEvent de modification de constituant.
	 * 
	 * @return	index de la TraitementEvent.
	  */
	public int getIndex()
	{	return index;
	}
}