/* RecIDCM3 actor wraps the RecIDCM3 CORBA service provided by the CIPRes software package.
 *
 * Copyright (c) 2004 The Regents of the University of California.
 * All rights reserved.
 *
 * 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.
 *
 *                                       PT_COPYRIGHT_VERSION_2
 *                                       COPYRIGHTENDKEY
 */ 

package org.cipres.kepler;

// Ptolemy package
import ptolemy.actor.TypedAtomicActor;
import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.util.*;
import ptolemy.actor.TypedIOPort;
import ptolemy.data.BooleanToken;
import ptolemy.data.ObjectToken;
import ptolemy.data.expr.Parameter;
import ptolemy.data.type.BaseType;

import javax.swing.JOptionPane;

// Cipres package
import org.cipres.CipresIDL.api1.Rid3TreeImprove;
import org.cipres.CipresIDL.api1.Tree;
import org.cipres.CipresIDL.api1.DataMatrix;
import org.cipres.helpers.RegistryEntryWrapper;
import org.cipres.helpers.CipresServiceDialog;
import org.cipres.kepler.registry.Globals;

//////////////////////////////////////////////////////////////////////////
//// RecIDCM3
/**
 * This RecIDCM3 actor wraps the RecIDCM3 CORBA service provided by the 
 *  CIPRes software package. The RecIDCM3 service implements the Recursive,
 *  Iterative, DCM3 (Disk Coverage Method) algorithm, which could be find in 
 *  detail at http://www.cs.njit.edu/~usman/RecIDCM3.html
 * 
 * @author Zhijie Guan  
 * @version $Id: RecIDCM3.java,v 1.2 2006/04/26 00:43:04 guan Exp $
*/

public class RecIDCM3 extends TypedAtomicActor {

	// TODO: assign a proper hash value to this
	static final long serialVersionUID = 1L;

	/** Construct a RecIDCM3 actor with the given container and name.
	 *  @param container The container.
     *  @param name The name of this actor.
     *  @exception IllegalActionException If the entity cannot be contained
     *   by the proposed container.
     *  @exception NameDuplicationException If the container already has an
     *   actor with this name.
     */
	
    public RecIDCM3(CompositeEntity container, String name)
            throws NameDuplicationException, IllegalActionException  {
        super(container, name);
        
        // construct the input port inputDataMatrix
		inputDataMatrix = new TypedIOPort(this, "inputDataMatrix", true, false);
		//inputDataMatrix.setDisplayName("Data Matrix");
		inputTree = new TypedIOPort(this, "inputTree", true, false);
		//inputTree.setDisplayName("Tree");
		inputDataMatrix.setRequired(true);
		inputTree.setRequired(true);

		// construct the output port outputTree
        outputTree = new TypedIOPort(this, "outputTree", false, true);
        //outputTree.setDisplayName("Tree after RecIDCM3");
        // Set the type constraint.
        outputTree.setTypeEquals(BaseType.GENERAL);
        //outputTree.setUseful(true);

        // set inputDataMatrix, inputTree and outputTree names display
        new Parameter(inputDataMatrix, "_showName", BooleanToken.TRUE);
        new Parameter(inputTree, "_showName", BooleanToken.TRUE);
        new Parameter(outputTree, "_showName", BooleanToken.TRUE);

        _attachText("_iconDescription", "<svg>\n" +
                "<rect x=\"0\" y=\"0\" "
                + "width=\"60\" height=\"20\" "
                + "style=\"fill:white\"/>\n" +
                "</svg>\n");
		
    }

    ///////////////////////////////////////////////////////////////////
    ////                     ports and parameters                  ////
	/** 
     * A matrix containing the characters information of the analyzed 
     *  taxa is passed to the RecIDCM3 actor through this input port.
     * This port is an input port of type GENERAL.
     */
    public TypedIOPort inputDataMatrix = null; 

    /** 
     * A tree in CIPRes tree data structure is passed to the RecIDCM3
     *  actor through this input port. This tree is treated as an initial
     *  tree for the RecIDCM3 algorithm.
     * This port is an input port of type GENERAL.
     */
	public TypedIOPort inputTree = null;

	/** 
     * The inferred tree is sent through this output port. 
     * This port is an output port of type GENERAL.
     */
	public TypedIOPort outputTree = null;    
	
	///////////////////////////////////////////////////////////////////
	////                    functional variables                   ////
	// a tree data structure in CIPRes IDL format
	private org.cipres.CipresIDL.api1.Tree _finalTree = null;

    ///////////////////////////////////////////////////////////////////
    ////                         public methods                    ////

    /** Improve the tree using RecIDCM3 CORBA service, and send the 
     *   result tree to the output port.
     *  @exception IllegalActionException If it is thrown by the
     *   send() method sending out the token.
     */
    public void fire() throws IllegalActionException {
        super.fire();
		
		if ( (inputTree.hasToken(0)) && (inputDataMatrix.hasToken(0)) ) {		
			
			RegistryEntryWrapper rid3Wrapper = null;
			try {
				// get RecIDCM3 algorithm wrapper
				rid3Wrapper = Globals.getInstance().getRegistry().getCipresService(Rid3TreeImprove.class);
				// use GuiGen to get users' settings
				CipresServiceDialog dialog = rid3Wrapper.getServiceDialog(null);
				int status = dialog.showAndInitialize();
				if (status == CipresServiceDialog.OK)
				{
					// get the RecIDCM3 algorithm wrapper
					Rid3TreeImprove service = (Rid3TreeImprove)rid3Wrapper.getService();
					// set the tree and matrix into the CORBA service
					service.setTree( (Tree)((ObjectToken)inputTree.get(0)).getValue() );
					service.setMatrix( (DataMatrix)((ObjectToken)inputDataMatrix.get(0)).getValue() );
					// infer the result tree
					_finalTree = service.improveTree(null);
				} else if (status == CipresServiceDialog.ERROR)
				{
					JOptionPane.showMessageDialog(null, "error initializing service");
				}
				
			}
			catch (Exception e) {
				e.printStackTrace();
			}
			finally {
				if (rid3Wrapper != null) {
					// release the RecIDCM3 service
					rid3Wrapper.releaseService();
				}
			}
			
			// send out the inferred tree to the output port
			outputTree.send(0, new ObjectToken( _finalTree ));
		}
    }


	/** Post fire the actor. Return false to indicated that the
	 *  process has finished. If it returns true, the process will
	 *  continue indefinitely.
	 */
/*	
	public boolean postfire() {
		return false;
	}	
*/
}