/*
 * Copyright (c) 2009-2015 The Regents of the University of California.
 * All rights reserved.
 *
 * '$Author: crawl $'
 * '$Date: 2015-06-22 21:05:00 +0000 (Mon, 22 Jun 2015) $' 
 * '$Revision: 33499 $'
 * 
 * Permission is hereby granted, without written agreement and without
 * license or royalty fees, to use, copy, modify, and distribute this
 * software and its documentation for any purpose, provided that the above
 * copyright notice and the following two paragraphs appear in all copies
 * of this software.
 *
 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 * ENHANCEMENTS, OR MODIFICATIONS.
 *
 */
package org.kepler.profiling.gui;

import java.util.Map;

import org.kepler.moml.NamedObjId;
import org.kepler.objectmanager.lsid.KeplerLSID;
import org.kepler.provenance.ProvenanceRecorder;
import org.kepler.provenance.QueryException;
import org.kepler.provenance.Queryable;
import org.kepler.provenance.RecordingException;

import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.util.NamedObj;
import ptolemy.vergil.tree.ClassAndEntityTreeModel;

/** A TreeModel for a workflow outline showing actor firing information.
 *  If includeFires is true, each atomic actor in the tree has a child
 *  for each execution of that actor.
 * 
 *  @author Daniel Crawl
 *  @version $Id: WorkflowOutlineTreeActorFireModel.java 33499 2015-06-22 21:05:00Z crawl $
 */
public class WorkflowOutlineTreeActorFireModel extends ClassAndEntityTreeModel {
        
        public WorkflowOutlineTreeActorFireModel(CompositeEntity root) {
                super(root);
        }

    /** Get the child of the given parent at the given index.
     *  If the child does not exist, then return null.
     *  In this base class, a child is a contained entity.
     *  @param parent A node in the tree.
     *  @param index The index of the desired child.
     *  @return A node, or null if there is no such child.
     */
    @Override
    public Object getChild(Object parent, int index) {
        
        if(!includeFires || (parent instanceof CompositeEntity)) {
            return super.getChild(parent, index);
        }
        
        if (index > getChildCount(parent)) {
            return null;
        }

        String name = ((NamedObj)parent).getFullName();
        try  {
            Map<String,Long> map = _query.getExecutionTimesForActor(_lsid, null, name);
            int i = 0;
            for(Map.Entry<String, Long> entry : map.entrySet()) {
                if(i == index) {
                    return entry;
                }
                i++;
            }
        } catch (QueryException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return null;
    }

    /** Return the number of children of the given parent, which in
     *  this base class is the number of contained entities.
     *  @param parent A parent node.
     *  @return The number of contained entities.
     */
    @Override
    public int getChildCount(Object parent) {
        
        if(!includeFires || (parent instanceof CompositeEntity)) {
            return super.getChildCount(parent);
        }
    
        String name = ((NamedObj)parent).getFullName();
        try {
            Map<String,Long> map = _query.getExecutionTimesForActor(_lsid, null, name);
            return map.size();
        } catch (QueryException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
   
        return 0;
    }

    /** Return the index of the given child within the given parent.
     *  If the parent is not contained in the child or is not an instance
     *  of CompositeEntity return -1.
     *  @param parent The parent, which is usually a CompositeEntity.
     *  @param child The child.
     *  @return The index of the specified child.
     */
    @Override
    public int getIndexOfChild(Object parent, Object child) {
        
        if(!includeFires || (parent instanceof CompositeEntity)) {
            return super.getIndexOfChild(parent, child);
        }
        
        String name = ((NamedObj)parent).getFullName();
        try {
            Map<String,Long> map = _query.getExecutionTimesForActor(_lsid, null, name);
            int index = 0;
            for(String fireId : map.keySet()) {
                if(fireId.equals(child)) {
                    return index;
                }
                index++;
            }
        } catch (QueryException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }

        return -1;
    }

    /** Return true if the object is a leaf node.  In this base class,
     *  an object is a leaf node if it is not an instance of CompositeEntity.
     *  @param object The object in question.
     *  @return True if the node has no children.
     */
    @Override
    public boolean isLeaf(Object object) {
        
        if(!includeFires || (object instanceof CompositeEntity)) {
            return super.isLeaf(object);
        } else if(!(object instanceof NamedObj)) {
            return true;
        }
        
        String name = ((NamedObj)object).getFullName();
        try {
            Map<String,Long> map = _query.getExecutionTimesForActor(_lsid, null, name);
            if(map.size() > 0) {
                return false;
            }
        } catch (QueryException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        
        return true;
    }
 
    /** Set the object that this tree model looks at.
     *  @param root The root NamedObj
     *  @see #getRoot()
     */
    @Override
    public void setRoot(NamedObj root) {

        if(root != null && root != _root)
        {
            try {
                _query = ProvenanceRecorder.getDefaultQueryable(root);
                _lsid = NamedObjId.getIdFor(root);
            } catch (QueryException|RecordingException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
        }
        
        super.setRoot(root);
    }
    
    public boolean includeFires = false;    

    private Queryable _query;
    private KeplerLSID _lsid;
}