edu.udo.cs.yale
Class Experiment

java.lang.Object
  edu.udo.cs.yale.Experiment

public class Experiment
extends java.lang.Object

This class was introduced to avoid confusing handling of operator maps and other stuff when a new experiment is created.

Version:

$Id: Experiment.java,v 2.57 2006/10/01 23:06:17 ingomierswa Exp $

Author:

Ingo Mierswa, Simon Fischer

Field Summary

private java.util.List<BreakpointListener>	breakpointListeners
private Operator	currentOperator
private java.util.Map<java.lang.String,DataTable>	dataTableMap Maps names of ExperimentLogOperators to Objects, that these Operators use for collecting statistics (objects of type DataTable).
private java.io.File	experimentFile
private MacroHandler	macroHandler
private java.util.Map<java.lang.String,Operator>	operatorNameMap
private ExperimentOperator	rootOperator
private boolean	stopExperiment

Constructor Summary

Experiment()
Constructs an experiment consisting only of a SimpleOperatorChain.

Experiment(java.io.File file)

Experiment(java.io.InputStream in)
Reads an experiment configuration from the given file.

Experiment(java.lang.String xmlString)
Reads an experiment configuration from an XML String.

Experiment(java.net.URL url)

Method Summary

void	addBreakpointListener(BreakpointListener listener)
DataTable	addDataTable(DataTable table) Returns the data table associated with the given name.
boolean	checkExperiment(IOContainer inputContainer) Checks for correct number of inner operators, properties, and io.
private int	checkIO(IOContainer inputContainer)
private int	checkNumberOfInnerOperators()
private int	checkProperties()
void	clearDataTables() Removes all data tables before running a new experiment.
void	clearMacros()
java.io.File	createFile(java.lang.String name)
boolean	dataTableExists(java.lang.String name) Returns true if a data table object with the given name exists.
void	fireBreakpointEvent(Operator operator, IOContainer ioContainer, int location)
void	fireResumeEvent()
java.util.Collection<java.lang.String>	getAllOperatorNames() Returns a Set view of all operator names (i.e.
java.util.Collection<Operator>	getAllOperators() Returns a Collection view of all operators.
Operator	getCurrentOperator() Returns the operator that is currently being executed.
DataTable	getDataTable(java.lang.String name) Returns the data table associated with the given name.
java.util.Collection	getDataTables()
java.io.File	getExperimentFile()
java.lang.String	getFirstFreeName(java.lang.String name) Returns a "name (i)" if name is already in use.
MacroHandler	getMacroHandler()
Operator	getOperator(java.lang.String name) Returns the operator with the given name.
ExperimentOperator	getRootOperator()
private int	performAdditionalChecks()
private void	prepareRun(IOContainer inputContainer)
void	readExperiment(java.io.InputStream in)
void	registerOperator(java.lang.String name, Operator operator) Registers the operator as part of the experiment.
void	removeBreakpointListener(BreakpointListener listener)
java.io.File	resolveFileName(java.lang.String name) Resolves the given filename against the directory containing the experiment file.
IOContainer	run() Starts the experiment with no input.
IOContainer	run(IOContainer input) Starts the experiment with the given input.
void	save() Saves the experiment to the experiment file.
void	save(java.io.File file) Saves the experiment to the experiment file.
void	setCurrentOperator(Operator operator) Returns the operator that is currently being executed.
void	setExperimentFile(java.io.File file)
void	setupFromXML(java.lang.String xmlString)
boolean	shouldStop() Returns true iff the experiment should be stopped.
void	stop() Stops the experiment as soon as possible.
private void	tearDown()
void	unRegisterOperator(java.lang.String name) Unregisters the operator as part of the experiment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rootOperator

private ExperimentOperator rootOperator

currentOperator

private Operator currentOperator

operatorNameMap

private java.util.Map<java.lang.String,Operator> operatorNameMap

experimentFile

private java.io.File experimentFile

breakpointListeners

private java.util.List<BreakpointListener> breakpointListeners

stopExperiment

private boolean stopExperiment

macroHandler

private MacroHandler macroHandler

dataTableMap

private java.util.Map<java.lang.String,DataTable> dataTableMap

Maps names of ExperimentLogOperators to Objects, that these Operators use for collecting statistics (objects of type DataTable).

Constructor Detail

Experiment

public Experiment()

Constructs an experiment consisting only of a SimpleOperatorChain.

Experiment

public Experiment(java.net.URL url)
           throws java.io.IOException,
                  XMLException

Throws:

java.io.IOException

XMLException

Experiment

public Experiment(java.io.File file)
           throws java.io.IOException,
                  XMLException

Throws:

java.io.IOException

XMLException

Experiment

public Experiment(java.lang.String xmlString)
           throws java.io.IOException,
                  XMLException

Reads an experiment configuration from an XML String.

Throws:

java.io.IOException

XMLException

Experiment

public Experiment(java.io.InputStream in)
           throws java.io.IOException,
                  XMLException

Reads an experiment configuration from the given file.

Throws:

java.io.IOException

XMLException

Method Detail

getMacroHandler

public MacroHandler getMacroHandler()

clearMacros

public void clearMacros()

dataTableExists

public boolean dataTableExists(java.lang.String name)

Returns true if a data table object with the given name exists.

addDataTable

public DataTable addDataTable(DataTable table)

Returns the data table associated with the given name. If the name was not used yet, an empty DataTable object is created with the given columnNames.

getDataTable

public DataTable getDataTable(java.lang.String name)

Returns the data table associated with the given name. If the name was not used yet, an empty DataTable object is created with the given columnNames.

getDataTables

public java.util.Collection getDataTables()

clearDataTables

public void clearDataTables()

Removes all data tables before running a new experiment.

getRootOperator

public ExperimentOperator getRootOperator()

setupFromXML

public void setupFromXML(java.lang.String xmlString)
                  throws java.io.IOException,
                         XMLException

Throws:

java.io.IOException

XMLException

getExperimentFile

public java.io.File getExperimentFile()

getFirstFreeName

public java.lang.String getFirstFreeName(java.lang.String name)

Returns a "name (i)" if name is already in use.

registerOperator

public void registerOperator(java.lang.String name,
                             Operator operator)

Registers the operator as part of the experiment.

unRegisterOperator

public void unRegisterOperator(java.lang.String name)

Unregisters the operator as part of the experiment.

getOperator

public Operator getOperator(java.lang.String name)

Returns the operator with the given name.

getCurrentOperator

public Operator getCurrentOperator()

Returns the operator that is currently being executed.

getAllOperators

public java.util.Collection<Operator> getAllOperators()

Returns a Collection view of all operators.

getAllOperatorNames

public java.util.Collection<java.lang.String> getAllOperatorNames()

Returns a Set view of all operator names (i.e. Strings).

setCurrentOperator

public void setCurrentOperator(Operator operator)

Returns the operator that is currently being executed.

addBreakpointListener

public void addBreakpointListener(BreakpointListener listener)

removeBreakpointListener

public void removeBreakpointListener(BreakpointListener listener)

fireBreakpointEvent

public void fireBreakpointEvent(Operator operator,
                                IOContainer ioContainer,
                                int location)

fireResumeEvent

public void fireResumeEvent()

checkIO

private int checkIO(IOContainer inputContainer)

checkNumberOfInnerOperators

private int checkNumberOfInnerOperators()

checkProperties

private int checkProperties()

performAdditionalChecks

private int performAdditionalChecks()

checkExperiment

public boolean checkExperiment(IOContainer inputContainer)

Checks for correct number of inner operators, properties, and io.

prepareRun

private void prepareRun(IOContainer inputContainer)
                 throws OperatorException

Throws:

OperatorException

run

public IOContainer run()
                throws OperatorException

Starts the experiment with no input.

Throws:

OperatorException

run

public IOContainer run(IOContainer input)
                throws OperatorException

Starts the experiment with the given input.

Throws:

OperatorException

stop

public void stop()

Stops the experiment as soon as possible.

shouldStop

public boolean shouldStop()

Returns true iff the experiment should be stopped.

tearDown

private void tearDown()

save

public void save()
          throws java.io.IOException

Saves the experiment to the experiment file.

Throws:

java.io.IOException

save

public void save(java.io.File file)
          throws java.io.IOException

Saves the experiment to the experiment file.

Throws:

java.io.IOException

setExperimentFile

public void setExperimentFile(java.io.File file)

resolveFileName

public java.io.File resolveFileName(java.lang.String name)

Resolves the given filename against the directory containing the experiment file.

createFile

public java.io.File createFile(java.lang.String name)

readExperiment

public void readExperiment(java.io.InputStream in)
                    throws XMLException,
                           java.io.IOException

Throws:

XMLException

java.io.IOException