Commit 0b51e09c authored by Fabien Triolet's avatar Fabien Triolet
Browse files

Javadoc and removed useless methods in Merge and Dispatch

parent 2dae503b
/**
* $Id: Call.java,v 1.2 2002-11-25 16:09:11 triolet Exp $
/*
* $Id: Call.java,v 1.3 2003-01-20 16:05:33 triolet Exp $
*
* Transmorpher
*
......@@ -22,44 +22,134 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
/**
* Transmorpher graph call node interface
*
* @author Jerome.Euzenat@inrialpes.fr
* @since jdk 1.3 / SAX 2.0
*/
package fr.fluxmedia.transmorpher.graph ;
package fr.fluxmedia.transmorpher.graph;
import fr.fluxmedia.transmorpher.utils.Writer;
import fr.fluxmedia.transmorpher.engine.TProcessComposite;
import fr.fluxmedia.transmorpher.utils.Parameters;
import fr.fluxmedia.transmorpher.utils.StringParameters;
import fr.fluxmedia.transmorpher.engine.TProcessComposite;
import fr.fluxmedia.transmorpher.utils.Writer;
import java.io.Serializable;
import java.io.IOException;
import java.io.Serializable;
/**
* An object that implements the Call interface is a basic component
* of a tranmorpher graph. It can not contain other compononents.
* Methods are provided to generate an XML or a Java code representation
* of the Call.
*
*@author Jerome.Euzenat@inrialpes.fr
*@since jdk 1.3 / SAX 2.0
*/
public interface Call extends Serializable {
/**
* Prints the XML expression of the call
*/
public void generateXML();
/**
* Prints the Java code for the execution of the call
*
*@param file the file to write in
*@exception IOException sends if an IO error occurs.
*/
public void generateJavaCode(Writer file) throws IOException;
/**
* Gets the id attribute of the Call object
*
*@return The id value
*/
public String getId();
/**
* Sets the id attribute of the Call object
*
*@param name The new id value
*/
public void setId(String name);
/**
* Gets the type attribute of the Call object
*
*@return The type value
*/
public String getType();
/**
* Sets the type attribute of the Call object
*
*@param type The new type value
*/
public void setType(String type);
/**
* Sets the parameters attribute of the Call object
*
*@param param The new parameters value
*/
public void setParameters(Parameters param);
/**
* Gets the attributes attribute of the Call object
*
*@return The attributes value
*/
public StringParameters getAttributes();
/**
* Gets the parameters attribute of the Call object
*
*@return The parameters value
*/
public Parameters getParameters();
/**
* Gets the process attribute of the Call object
*
*@return The process value
*/
public Process getProcess();
/**
* Returns the PortList which contains the in ports of this Call
*
*@return the in portlist
*/
public PortList inPorts();
/**
* Returns the PortList which contains the out ports of this Call
*
*@return the out portlist.
*/
public PortList outPorts();
/**
* Description of the Method
*/
public void setUp();
/**
* Description of the Method
*/
public void clearVisited();
/**
* Description of the Method
*/
public void clearNull();
/**
* Creates an execution component corresponding to this Call object and adds it to the composite
* process in the execution structure.
*
*@param composite The composite process.
*/
public void createProcess(TProcessComposite composite);
public interface Call extends Serializable{
/** Prints the XML expression of the call */
public void generateXML();
/** Prints the Java code for the execution of the call */
public void generateJavaCode(Writer file) throws IOException;
public String getId();
public void setId(String name);
public String getType();
public void setType(String type);
public void setParameters(Parameters param);
public StringParameters getAttributes();
public Parameters getParameters();
public Process getProcess();
public PortList inPorts();
public PortList outPorts();
public void setUp();
public void clearVisited();
public void clearNull();
public void createProcess(TProcessComposite composite);
}
/**
* $Id: Dispatch.java,v 1.3 2002-11-25 16:09:11 triolet Exp $
* $Id: Dispatch.java,v 1.4 2003-01-20 16:05:33 triolet Exp $
*
* Transmorpher
*
......@@ -55,11 +55,7 @@ public class Dispatch extends CallImpl {
super(n, t, p, 1/*Nb In*/, out);
}
public PortList outPorts(){
return outPorts;
}
/** Propagates the nullity of all its output to its sole input */
public void retroNull( PortList out, PortList in) {
......
/**
* $Id: Merge.java,v 1.3 2002-11-25 16:09:11 triolet Exp $
* $Id: Merge.java,v 1.4 2003-01-20 16:05:33 triolet Exp $
*
* Transmorpher
*
......@@ -54,10 +54,6 @@ public class Merge extends CallImpl {
public Merge (String n, String t, Process p, int in){
super(n, t, p, in, 1);
}
public PortList inPorts(){
return inPorts;
}
/** Propagate the nullify of its sole output to all the input */
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment