package jas2.jds.module;
import jas2.util.*;
/**
 * When a local job reads in data, it must use a local data
 * interface module to generate an EventSource.
 * 

 * 
A class that implements this interface
 * should override the toString() method.  For example, the
 * implementation jas2.jds.module.flatfileserver.LocalFlatFileDIM
 * has the following method:

 * 
 *		public String toString()

 *		{

 *			return "Flat file";

 *		}

 * 
 * Whatever toString() returns is displayed in the Local DIM
 * registry, and appeard on the JComboBox
 * where the user selects the LocalDIM to use.
 * 
The LocalDIM interface extends java.io.Serializable, so you must define a serializable
 * class.  This means that all objects refered to by member variables of your class will
 * be serialized unless marked transient.  Be aware that transient
 * variables are null when the object is read from disk, so be sure to
 * initialize
 * them in a readObject() method.
 * 
To use a local DIM, you must
 * add your class to the
 * Local DIM registry.
 * 
Give a definition for the following method:

 * public EventSource openDataSet(String name) throws ModuleException

 * This method, inherited from the AbstractDIM interface, will be called after
 * createJob() is called in the LocalJobBuilder.  It must return an EventSource,
 * which the application will use to access the events in your data set.  See the documentation on
 * defining an
 * EventSource.
 * 
 */
public interface LocalDIM extends AbstractDIM, java.io.Serializable
{
	/**
	 * Return a setup page for the new job wizard to use when
	 * creating a job.  See the
	 * documentation
	 * on defining pages.
	 */
	public JASWizardPage getSetupPage();

	/**
	 * Copy over the given object to a member field for use later.  When
	 * the user selects a DIM, the wizard invokes this method, thereby
	 * providing the DIM with access to the application's local job
	 * builder.  That local job builder already knows which DIM to use
	 * and knows the job name, and can be used to create a new job when
	 * all setup (on the setup wizard page returned by
	 * getSetupPage()) is complete.
	 */
	public void setLocalJobBuilder(LocalJobBuilder ljb);
}