/* ------------------------------------
    * � Kaamelot - 2006
    * ------------------------------------
    * Projet  : projectName
    * Fichier : AGroupData.java
    * $Id$ 
    * $Date$ 
    * $Log$
    * 
   */
  package fr.kaamelot.reporter;
  
  import java.util.Map;
  import java.util.StringTokenizer;
  
  import org.apache.commons.collections.map.LinkedMap;
  
  import fr.kaamelot.reporter.exception.DataEvaluationException;
  
  /**
   * @author Kaamelot - 2006
   * <b>Description :</b>
   * @version $Id$
   * @history <ul>
   * <li/>Date    		- UserId   - Observations
   * <li/>22 jun. 2006 - Kaamelot - Initialisation de la classe.
   * </ul>
   * 
   */
  public abstract class AGroupData {
  	
  	/** Root Parent Group */
  	private AGroupData rootParent = null;
  	
  	/** Parent Group */
  	private AGroupData parent = null;
  
  	//	/** Full Group Name */
  	//	private String groupName = null;
  
  	/** Elementary Group Name */
  	private String name = null;
  
  	/** Elementary Group Path */
  	private String path = null;
  
  	/** Other Included Group Data */
  	private LinkedMap groupDatas = new LinkedMap();
  
  	/** Detailed Datas */
  	private Map datas = new LinkedMap();
  
  	private IPathProvider pathProvider;
  
  	private INameTranslator nameTranslator;
  	
  	private int level = 0;
  
  	private int depth = 0;
  	
  	private boolean firstEvaluation = false;
  
  	/**	 */
  	protected AGroupData() {
  	}
  
  	/**
  	 */
  	public AGroupData(final String _path, final AGroupData _parent) {
  		setPath(_path);
  		if (_parent != null) {
  			setPathProvider(_parent.getPathProvider());
  		}
  		if (_path!=null) {
  			setName(_path.substring(_path.lastIndexOf(getPathProvider().getPathDelimiter())+1));
  		}
  		setParent(_parent);
  		if (_parent != null) {
  			level = _parent.getLevel() + 1;
  			_parent.setDepth(level);
  		}
  	}
  
  	public abstract AGroupData getNewGroupData(final String _path ,final AGroupData _parent);
  
  	public AGroupData getGroupData(final IMappable _data) throws Exception {
  		AGroupData grpData = null;
  
  		String path = getPathProvider().getPath(_data);
  		StringBuffer searchPath = new StringBuffer();
  
  		StringTokenizer st = new StringTokenizer(path, getPathProvider().getPathDelimiter());
  		if (st.hasMoreTokens()) {
  			searchPath.append(st.nextToken());
  			grpData = searchGroupData(searchPath,st);
  		} else {
  			throw new Exception("");
  		}
  		return grpData;
 	}
 
 	/**
 	 * @param _searchPath
 	 * @param _sT 
 	 * @return
 	 */
 	protected AGroupData searchGroupData(StringBuffer _searchPath, final StringTokenizer _sT) {
 		AGroupData grpData = getGroupData(_searchPath.toString());
 		if (grpData == null) {
 			grpData = addGroupData(getNewGroupData(_searchPath.toString(), this));
 			grpData.setPathProvider(getPathProvider());
 			grpData.setNameTranslator(getNameTranslator());
 			grpData.setRootParent(this);
 		}
 		if (_sT.hasMoreTokens()) {
 			_searchPath.append(getPathProvider().getPathDelimiter());
 			_searchPath.append(_sT.nextToken());			
 			grpData = grpData.searchGroupData(_searchPath,_sT);
 		}
 		return grpData;
 	}
 
 	/**
 	 * @param _name
 	 * @return 
 	 */
 	public AGroupData getGroupData(final String _name) {
 		return (AGroupData) groupDatas.get(_name);
 	}
 
 	private boolean hasData() {
 		return (datas != null && datas.size() > 0);
 	}
 
 	/**
 	 * @param _data
 	 */
 	public void addData(final IMappable _data) throws Exception {
 		AGroupData targetGroup = getGroupData(_data);
 
 		if (targetGroup != null) {
 			targetGroup.evaluateData(_data);
 			targetGroup.getDatas().put(_data.getKey(), _data);
 		}
 	}
 
 	/**
 	 * @param _data
 	 */
 	protected abstract void evaluateData(final IMappable _data) throws DataEvaluationException; 
 
 	/**
 	 * @param _GroupData
 	 * @return
 	 */
 	public AGroupData addGroupData(final AGroupData _groupData) {
 		groupDatas.put(_groupData.getPath(), _groupData);
 		return _groupData;
 	}
 
 	/**
 	 * @return
 	 */
 	public AGroupData getParent() {
 		return parent;
 	}
 
 	/**
 	 * @return
 	 */
 	public boolean hasParent() {
 		return getParent()!=null;
 	}
 
 	/**
 	 * @return
 	 */
 	public LinkedMap getGroupDatas() {
 		return groupDatas;
 	}
 
 	/**
 	 * @param data
 	 */
 	public void setParent(AGroupData data) {
 		parent = data;
 	}
 
 	/**
 	 * @param map
 	 */
 	public void setGroupDatas(LinkedMap _linkedMap) {
 		groupDatas = _linkedMap;
 	}
 
 	/**
 	 * @return a Path based on Index of Data in Parent Group 
 	 */
 	public String getIndexPath(AGroupData _Data) {
 	   return getIndexPath() + "_" + String.valueOf(getGroupDatas().indexOf(_Data.getPath()));
 	}
 
 	/**
 	 * @return a Path based on Index of Data in Parent Group 
 	 */
 	public String getIndexPath() {
 	   String indexPath="";
 	   if (parent!=null) {
 	      indexPath = parent.getIndexPath(this);
       }
 	   return indexPath;
 	}
 
 	/**
 	 * @return
 	 */
 	public String getPath() {
 		return path;
 	}
 
 	/**
 	 * @param string
 	 */
 	public void setPath(String string) {
 		path = string;
 	}
 
 	/**
 	 * @return
 	 */
 	private Map getDatas() {
 		return datas;
 	}
 
 	/**
 	 * @return
 	 */
 	public int getLevel() {
 		return level;
 	}
 
 	/**
 	 * @return
 	 */
 	public IPathProvider getPathProvider() {
 		return pathProvider;
 	}
 
 	/**
 	 * @param provider
 	 */
 	public void setPathProvider(final IPathProvider _provider) {
 		pathProvider = _provider;
 	}
 
 	/**
 	 * @return
 	 */
 	public String getName() {
 		return name;
 	}
 
 	/**
 	 * @return
 	 */
 	public String getTranslatedName() {
 		if (getNameTranslator()==null) {
 			return name;
 		}
 		return getNameTranslator().translate(name,this);
 	}
 
 	/**
 	 * @param string
 	 */
 	protected void setName(String string) {
 		name = string;
 	}
 
 	/** */
 	public void enableGraphicalRenderer() {
 		getNameTranslator().enableGraphicalRenderer();
 	}
 
 	/** */
 	public void disableGraphicalRenderer() {
 		getNameTranslator().disableGraphicalRenderer();
 	}
 
 	/**
 	 * @return
 	 */
 	public INameTranslator getNameTranslator() {
 		return nameTranslator;
 	}
 
 	protected void setRootParent(AGroupData _rootParent) {
 		rootParent = _rootParent;
 	}
 
 	public AGroupData getRootParent() {
 		return rootParent;
 	}
 
 	/**
 	 * @param translator
 	 */
 	public void setNameTranslator(INameTranslator translator) {
 		nameTranslator = translator;
 	}
 
 	/**
 	 * @return
 	 */
 	public int getDepth() {
 		return depth;
 	}
 
 	/**
 	 * @param i
 	 */
 	protected void setDepth(int i) {
 		depth = Math.max(i,depth);
 		if (parent!=null) {
 			parent.setDepth(depth);
 		}
 	}
 
 	public boolean isFirstEvaluation() {
 		return firstEvaluation;
 	}
 
 	public void setFirstEvaluation(boolean firstEvaluation) {
 		this.firstEvaluation = firstEvaluation;
 	}
 
 }