org.datamanager.kernel
Class Simpleton

java.lang.Object
  |
  +--org.datamanager.kernel.Simpleton
Direct Known Subclasses:
BrowserLauncherSimpleton, EmailBundleSimpleton, EmailGuiCollectorSimpleton, EmailMetadataSearchSimpleton, EmailParametersRequestHandlerSimpleton, EmailRetrieverSimpleton, EntityViewerSimpleton, EventLoggerSimpleton, GuiSimpleton, InterfaceWorker, InterpreterSimpleton, KernelGUISimpleton, KernelShutdownSimpleton, NewsGroupDownloadSimpleton, SanitySimpleton, SearchCollectorSimpleton, SearchHandlerSimpleton, SearchResultsViewerSimpleton, ShutdownSimpleton, SMTPSendSimpleton, ThreadMonitorSimpleton, WebAndNewsSearchSimpleton, WebCollectorSimpleton, WebPageDownloadSimpleton, WebParsingSimpleton, WebSearchSimpleton

public abstract class Simpleton
extends Object

A generic process to implement arbitrary entity and event manipulation.

Author:
Matthew Farrellee

Nested Class Summary
static class Simpleton.Information
          Encapsulates information that describes a Simpleton.
static class Simpleton.Priority
          Encapsulates a Priority that can be used to control thread priority.
 
Constructor Summary
Simpleton()
          Creates a new Simpleton with Information set to Simpleton.Information.NONE.
 
Method Summary
protected  Object clone()
          Clones this Simpleton.
 Simpleton.Information getInformation()
          Reports Simpleton.Information about this Simpleton.
 Simpleton.Priority getPriority()
          Gets the priority of this Simpleton.
abstract  void process()
          Performs the work of this Simpleton.
protected  void setInformation(Simpleton.Information information)
          Sets the Information object for this Simpleton.
 void setPriority(Simpleton.Priority priority)
          Sets the priority of this Simpleton.
 void start()
          Starts the Simpleton (with a possibly redundant setSimpleton invocation on this Simpleton's DatamanagerWorker thread).
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Simpleton

public Simpleton()
Creates a new Simpleton with Information set to Simpleton.Information.NONE.

Method Detail

setPriority

public void setPriority(Simpleton.Priority priority)
                 throws DataManagerException
Sets the priority of this Simpleton.

DataManagerException

getPriority

public Simpleton.Priority getPriority()
                               throws DataManagerException
Gets the priority of this Simpleton.

DataManagerException

start

public void start()
Starts the Simpleton (with a possibly redundant setSimpleton invocation on this Simpleton's DatamanagerWorker thread).


setInformation

protected void setInformation(Simpleton.Information information)
Sets the Information object for this Simpleton.


getInformation

public Simpleton.Information getInformation()
Reports Simpleton.Information about this Simpleton.


process

public abstract void process()
Performs the work of this Simpleton. Simpleton implementation must override this class.


clone

protected Object clone()
                throws CloneNotSupportedException
Clones this Simpleton. Subclasses of Simpleton should override this method, calling super.clone() first. The subclass clone() method should make sure that any reference variables in the clone are handled appropriately. You may want to make copies of the referred-to object rather than point the clone at the same object as the original.

Overrides:
clone in class Object
CloneNotSupportedException
See Also:
Object.clone()


See the Helium Website