/*
    * Created on Oct 11, 2004
    *
    */
   package org.extremecomponents.tree.model;
   
   import java.util.ArrayList;
   import java.util.Iterator;
   import java.util.List;
  import java.util.Map;
  
  import javax.servlet.jsp.PageContext;
  
  import org.apache.commons.beanutils.BeanUtils;
  import org.apache.commons.beanutils.PropertyUtils;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  import org.extremecomponents.table.bean.TableSection;
  
  import org.extremecomponents.table.model.FilterHandler;
  import org.extremecomponents.table.model.ParameterRegistry;
  import org.extremecomponents.table.model.TableModel;
  
  import org.extremecomponents.tree.bean.TreeNode;
  
  import org.extremecomponents.util.ExtremeUtils;
  
  
  /***
   * org.extremecomponents.tree.model.TreeModel.java -
   *
   * @author Paul Horn
   */
  public class TreeModel extends TableModel
  {
  	private static Log logger = LogFactory.getLog(TreeModel.class);
  	private String parentAttribute;
  	private String identifier;
  	private String extendedValue;
  	private TableSection tableSection;
  	private Object tableCollection;
  	private Map openNodes;
  	private TreeProperties properties = new TreeProperties();
  	private FilterHandler filterHandler = new FilterHandler(this);
  	private SortHandler sortHandler = new SortHandler(this);
  	private ViewHandler viewHandler = new ViewHandler(this);
  
  	public TreeModel(PageContext pageContext)
  	{
  		super(pageContext);
  	}
  
  	/***
  	 * Do all the filtering and sorting and return the rows of the table
  	 * that need to be displayed.
  	 */
  	public List init() throws Exception
  	{
  		openNodes = getRegistry().getParameters(ParameterRegistry.OPEN);
  
  		setTableCollection(ExtremeUtils.retrieveFromScope(getPageContext(), getTable().getCollection(), getTable().getScope()));
  
  		List filteredSortedRows = null;
  
  		if (getFilterHandler().doFilter() && !filterHandler.doClear())
  		{
  			filteredSortedRows = getFilterHandler().filterRows(this, getTableCollection()); //filter the original list
  			filteredSortedRows = TreeModelUtils.findParents(this, filteredSortedRows);
  			filteredSortedRows = TreeModelUtils.loadTreeStructure(this, filteredSortedRows);
  			TreeModelUtils.addClosedChildren(this, filteredSortedRows);
  		}
  		else
  		{
  			filteredSortedRows = TreeModelUtils.loadTreeStructure(this, getTableCollection());
  		}
  
  		getSortHandler().sort(filteredSortedRows); //sort the list
  
  		getViewHandler().setView();
  
  		return filteredSortedRows;
  	}
  
  	/***
  	 * @return tableCollection
  	 */
  	public List getTableCollection()
  	{
  		return (List) tableCollection;
  	}
  
  	/***
  	 * @param tableCollection
  	 */
  	public void setTableCollection(Object tableCollection) throws Exception
  	{
  		if (tableCollection instanceof List)
 		{
 			this.tableCollection = tableCollection;
 		}
 		else
 		{
 			throw new Exception("The eXtremeTable could not find the List of Beans (or Map) identified by the collection and scope attributes.");
 		}
 	}
 
 	/***
 	 * @return Returns the filterHandler.
 	 */
 	public org.extremecomponents.table.model.FilterHandler getFilterHandler()
 	{
 		return filterHandler;
 	}
 
 	/***
 	 * @param filterHandler The filterHandler to set.
 	 */
 	public void setFilterHandler(FilterHandler filterHandler)
 	{
 		this.filterHandler = filterHandler;
 	}
 
 	/***
 	 * @return Returns the sortHandler.
 	 */
 	public org.extremecomponents.table.model.SortHandler getSortHandler()
 	{
 		return sortHandler;
 	}
 
 	/***
 	 * @param sortHandler The sortHandler to set.
 	 */
 	public void setSortHandler(SortHandler sortHandler)
 	{
 		this.sortHandler = sortHandler;
 	}
 
 	/***
 	 * @return Returns the tableSection.
 	 */
 	public TableSection getTableSection()
 	{
 		return tableSection;
 	}
 
 	/***
 	 * @param tableSection The tableSection to set.
 	 */
 	public void setTableSection(TableSection tableSection)
 	{
 		this.tableSection = tableSection;
 	}
 
 	/***
 	 * @return Returns the viewHandler.
 	 */
 	public org.extremecomponents.table.model.ViewHandler getViewHandler()
 	{
 		return viewHandler;
 	}
 
 	/***
 	 * @param viewHandler The viewHandler to set.
 	 */
 	public void setViewHandler(ViewHandler viewHandler)
 	{
 		this.viewHandler = viewHandler;
 	}
 
 	/***
 	 * @return
 	 */
 	public TreeProperties getTreeProperties()
 	{
 		return properties;
 	}
 
 	/***
 	 * @return Returns the parentAttribute.
 	 */
 	public String getParentAttribute()
 	{
 		return parentAttribute;
 	}
 
 	/***
 	 * @param parentAttribute The parentAttribute to set.
 	 */
 	public void setParentAttribute(String parentAttribute)
 	{
 		this.parentAttribute = parentAttribute;
 	}
 
 	/***
 	 * @param properties The properties to set.
 	 */
 	public void setProperties(TreeProperties properties)
 	{
 		this.properties = properties;
 	}
 
 	/***
 	 * @return Returns the openNodes.
 	 */
 	public Map getOpenNodes()
 	{
 		return openNodes;
 	}
 
 	/***
 	 * @param openNodes The openNodes to set.
 	 */
 	public void setOpenNodes(Map openNodes)
 	{
 		this.openNodes = openNodes;
 	}
 
 	/***
 	 * @return Returns the identifier.
 	 */
 	public String getIdentifier()
 	{
 		return identifier;
 	}
 
 	/***
 	 * @param identifier The identifier to set.
 	 */
 	public void setIdentifier(String identifier)
 	{
 		this.identifier = identifier;
 	}
 
 	/***
 	 * @return
 	 */
 	public String getExtendedValue()
 	{
 		return extendedValue;
 	}
 
 	/***
 	 * @param string
 	 */
 	public void setExtendedValue(String string)
 	{
 		extendedValue = string;
 	}
 }