ajax.api
Interface AjaxAPI

All Known Implementing Classes:

AjaxImpl

public interface AjaxAPI

Method Summary

void	clean() Execute the scheduler
void	customize(TransformationExecutionObserver observer, int nbTuples, boolean blocking) Parameterize Ajax Note: this method must be invoked before the clean method.
void	deleteTuple(java.lang.String transformation, int tupleId) Deletes one output tuple of a transformation
ExecutionSummary	execute(java.lang.String transformationName) Execute one transformation
java.util.List	getExecutionTree() Gets the graph of transformations and data flows that compose the cleaning program
GraphParameter	getGraphParameter() Prepares and returns the parameter object that should be used as by the applet for displaying the graph.
java.lang.String	getTransformationCode(java.lang.String transformation) Gets the transformation code
java.util.List	getTransformations() Returns a list of ajax.gui.graph.TransformationInfo objects which represent the list of the transformations applied.
java.util.Enumeration	listTablesNames()
java.util.List	listTransformationsNames()
void	load(java.lang.String location) Loads the cleaning specification program, parses and optimizes it
void	modifyTransformationCode(java.lang.String transformation, java.lang.String newCode) Modifies the transformation code
void	resume() Resumes the cleaning process after handling the Exceptions of one transformation
void	undo(java.lang.String transformation) Undo the transformation actions
void	updateTuple(java.lang.String transformation, int tupleId) Update one output tuple of a transformation

Method Detail

load

public void load(java.lang.String location)
          throws AjaxException

Loads the cleaning specification program, parses and optimizes it

customize

public void customize(TransformationExecutionObserver observer,
                      int nbTuples,
                      boolean blocking)
               throws AjaxException

Parameterize Ajax Note: this method must be invoked before the clean method. Otherwise, it does not do anything.

clean

public void clean()
           throws AjaxException

Execute the scheduler

execute

public ExecutionSummary execute(java.lang.String transformationName)
                         throws AjaxException

Execute one transformation

listTransformationsNames

public java.util.List listTransformationsNames()
                                        throws AjaxException

listTablesNames

public java.util.Enumeration listTablesNames()
                                      throws AjaxException

getExecutionTree

public java.util.List getExecutionTree()
                                throws AjaxException

Gets the graph of transformations and data flows that compose the cleaning program

modifyTransformationCode

public void modifyTransformationCode(java.lang.String transformation,
                                     java.lang.String newCode)
                              throws AjaxException

Modifies the transformation code

getTransformationCode

public java.lang.String getTransformationCode(java.lang.String transformation)
                                       throws AjaxException

Gets the transformation code

resume

public void resume()
            throws AjaxException

Resumes the cleaning process after handling the Exceptions of one transformation

undo

public void undo(java.lang.String transformation)
          throws AjaxException

Undo the transformation actions

updateTuple

public void updateTuple(java.lang.String transformation,
                        int tupleId)
                 throws AjaxException

Update one output tuple of a transformation

deleteTuple

public void deleteTuple(java.lang.String transformation,
                        int tupleId)
                 throws AjaxException

Deletes one output tuple of a transformation

getGraphParameter

public GraphParameter getGraphParameter()
                                 throws AjaxException

Prepares and returns the parameter object that should be used as by the applet for displaying the graph. The parameter object will be obtained by the applet through a URL Connection.

Returns:

GraphParameter the graph parameter object

getTransformations

public java.util.List getTransformations()
                                  throws AjaxException

Returns a list of ajax.gui.graph.TransformationInfo objects which represent the list of the transformations applied. For each transformation there is information concerning the type, the name, the input data flows names and the output data flows names

Returns:

the transformation List