/*
    * @(#)$Id: NodeInfoImpl.java 790 2010-03-28 11:03:45Z bpuype $
    *
    * Author   : Ueli Kurmann, igesture@uelikurmann.ch
    *                                   
    *                                   
    * Purpose  : 
    *
    * -----------------------------------------------------------------------
   *
   * Revision Information:
   *
   * Date       Who     Reason
   *
   * 23.03.2008 ukurmann  Initial Release
   *
   * -----------------------------------------------------------------------
   *
   * Copyright 1999-2009 ETH Zurich. All Rights Reserved.
   *
   * This software is the proprietary information of ETH Zurich.
   * Use is subject to license terms.
   * 
   */
  
  package org.ximtec.igesture.tool.explorer;
  
  import java.lang.reflect.Constructor;
  import java.lang.reflect.Field;
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.List;
  import java.util.Map;
  import java.util.logging.Level;
  import java.util.logging.Logger;
  
  import javax.swing.Icon;
  import javax.swing.JPopupMenu;
  import javax.swing.tree.TreePath;
  
  import org.apache.commons.beanutils.BeanUtils;
  import org.sigtec.graphix.widget.BasicAction;
  import org.ximtec.igesture.tool.core.Controller;
  import org.ximtec.igesture.tool.explorer.core.ExplorerTreeView;
  import org.ximtec.igesture.tool.explorer.core.NodeInfo;
  import org.ximtec.igesture.tool.service.GuiBundleService;
  
  /**
   * Implementation of the NodeInfo interface. Reflection and dynamic class
   * loading is used to get children, views, etc.
   * 
   * @author UeliKurmann
   * @version 1.0
   * @since igesture
   */
  public class NodeInfoImpl implements NodeInfo {
  
    public static final String CHILD_DELIMITER = ";";
  
    private static final Logger LOG = Logger.getLogger(NodeInfoImpl.class.getName());
  
    private String propertyName;
    private String childList;
    private Class<? extends ExplorerTreeView> viewClass;
    private Class<? extends Object> nodeClass;
    private Controller controller;
  
    private List<Class<? extends BasicAction>> popupActions;
  
    private String key;
  
    private GuiBundleService guiBundle;
  
  
    /**
     * Constructor
     * 
     * @param type
     *          the type (class) of the node
     * @param propertyName
     *          the name of the property containing the name of the node.
     * @param childList
     *          a list of properties (as ";" separated strings) which should be
     *          used as children.
     * @param view
     *          the view belonging the node. The view MUST HAVE a constructor with
     *          the node instance as the only parameter.
     * @param popupActions
     *          a list of actions.
     * @param icon
     *          the icon of the node
     */
    public NodeInfoImpl(Controller controller, Class<? extends Object> type, String propertyName, String childList,
        Class<? extends ExplorerTreeView> view, List<Class<? extends BasicAction>> popupActions, String key) {
  
      this.controller = controller;
      this.nodeClass = type;
      this.propertyName = propertyName;
      this.childList = childList;
     this.viewClass = view;
     this.popupActions = popupActions;
     this.key = key;
     this.guiBundle = controller.getLocator().getService(GuiBundleService.IDENTIFIER, GuiBundleService.class);
   }  
 
   /*
    * (non-Javadoc)
    * 
    * @see
    * org.ximtec.igesture.tool.explorer.core.NodeInfo#getChildren(java.lang.Object
    * )
    */
   @Override
   public List<Object> getChildren(Object node) {
     List<Object> result = new ArrayList<Object>();
     if (childList != null) {
       for (String name : childList.split(CHILD_DELIMITER)) {
 
         try {
           Field field = nodeClass.getDeclaredField(name);
           field.setAccessible(true);
           Object o = field.get(node);
           if (o instanceof Collection) {
             result.addAll((Collection<?>) o);
           } else if (o instanceof Map) {
             result.addAll(((Map<?, ?>) o).values());
           } else {
             result.add(o);
           }
         } catch (Exception e) {
           LOG.log(Level.SEVERE, "Can't access children.", e);
         }
       }
     }
 
     return result;
   }
 
   /*
    * (non-Javadoc)
    * 
    * @see org.ximtec.igesture.tool.explorer.core.NodeInfo#getIcon()
    */
   @Override
   public Icon getIcon() {
     return guiBundle.getSmallIcon(key);
   }
   
   @Override
   public Icon getExpandedIcon() {
     return guiBundle.getSmallIconExpanded(key);
   }
   
 
   /*
    * (non-Javadoc)
    * 
    * @see
    * org.ximtec.igesture.tool.explorer.core.NodeInfo#getName(java.lang.Object)
    */
   @Override
   public String getName(Object node) {
     if (propertyName != null) {
       try {
         return BeanUtils.getProperty(node, propertyName);
       } catch (Exception e) {
         LOG.log(Level.SEVERE, "Can't get the node name. (" + node.getClass() + ")");
       }
     }
     return null;
   }
 
   /*
    * (non-Javadoc)
    * 
    * @see org.ximtec.igesture.tool.explorer.core.NodeInfo#getTooltip()
    */
   @Override
   public String getTooltip() {
     return guiBundle.getShortDescription(key);
   }
 
   /*
    * (non-Javadoc)
    * 
    * @see org.ximtec.igesture.tool.explorer.core.NodeInfo#getType()
    */
   @Override
   public Class<?> getType() {
     return nodeClass;
   }
 
   /*
    * (non-Javadoc)
    * 
    * @see
    * org.ximtec.igesture.tool.explorer.core.NodeInfo#isLeaf(java.lang.Object)
    */
   @Override
   public boolean isLeaf(Object object) {
     return getChildren(object).size() == 0;
   }
 
   /*
    * (non-Javadoc)
    * 
    * @see
    * org.ximtec.igesture.tool.explorer.core.NodeInfo#getView(java.lang.Object)
    */
   @Override
   public ExplorerTreeView getView(Controller controller, Object node) {
 
     try {
       Constructor<? extends ExplorerTreeView> ctor = null;
       Class<? extends Object> type = nodeClass;
       
       while (ctor == null && type != null) {
         try {
           ctor = viewClass.getConstructor(Controller.class, type);
         } finally {
           type = type.getSuperclass();
         }
       }
 
       if (ctor != null) {
         return ctor.newInstance(controller, node);
       }
     } catch (Exception e) {
       LOG.log(Level.SEVERE, "Can't create the view.", e);
     }
 
     return null;
   }
 
   /*
    * (non-Javadoc)
    * 
    * @see
    * org.ximtec.igesture.tool.explorer.core.NodeInfo#getPopupMenu(javax.swing
    * .tree.TreePath)
    */
   @Override
   public JPopupMenu getPopupMenu(TreePath treePath) {
 
     JPopupMenu popupMenu = new JPopupMenu();
     if (popupActions != null) {
       for (Class<? extends BasicAction> actionClass : popupActions) {
         try {
           if (actionClass == SeparatorAction.class) {
             popupMenu.addSeparator();
           } else {
             BasicAction action = actionClass.getConstructor(Controller.class, TreePath.class).newInstance(controller,
                 treePath);
             popupMenu.add(action);
           }
 
         } catch (Exception e) {
           LOG.log(Level.SEVERE, "Can't create Popup Menu.", e);
         } 
       }
     }
     return popupMenu;
   }
 }