org.oddjob.framework
Class BasePrimary

java.lang.Object
  extended by org.oddjob.framework.BaseComponent
      extended by org.oddjob.framework.BasePrimary
All Implemented Interfaces:
ArooaContextAware, ArooaSessionAware, PropertyChangeNotifier, Iconic, LogEnabled, Stateful
Direct Known Subclasses:
ArchiveJob, GrabJob, MirrorState, ScheduleBase, SimpleJob, StructuralJob

public abstract class BasePrimary
extends BaseComponent
implements LogEnabled

An abstract implementation of a component which provides common functionality to concrete sub classes.

Author:
Rob Gordon

Field Summary
 
Fields inherited from class org.oddjob.framework.BaseComponent
iconHelper
 
Constructor Summary
BasePrimary()
           
 
Method Summary
protected  void configure()
          Called by sub classes to configure this component.
 String getName()
          Get the job name.
protected  org.apache.log4j.Logger logger()
          Allow sub classes access to the logger.
protected  void logger(String logger)
          Rename the logger.
 String loggerName()
          Provide the logger name.
protected  void save()
          Implementations override this to save their state on state change.
 void setName(String name)
          Set the job name.
 String toString()
          Override toString.
 
Methods inherited from class org.oddjob.framework.BaseComponent
addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, fireDestroyedState, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onDestroy, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, setArooaContext, setArooaSession, stateHandler
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BasePrimary

public BasePrimary()
Method Detail

logger

protected org.apache.log4j.Logger logger()
Allow sub classes access to the logger.

Specified by:
logger in class BaseComponent
Returns:
The logger.

configure

protected void configure()
                  throws ArooaConfigurationException
Called by sub classes to configure this component.

Throws:
ArooaConfigurationException

save

protected void save()
             throws ComponentPersistException
Description copied from class: BaseComponent
Implementations override this to save their state on state change.

Overrides:
save in class BaseComponent
Throws:
ComponentPersistException

setName

public void setName(String name)
Set the job name. Used by subclasses to set the job name.

Parameters:
name - The name of the job.

getName

public String getName()
Get the job name.

Returns:
The job name.

loggerName

public String loggerName()
Description copied from interface: LogEnabled
Provide the logger name. The name should be unique for each component that is LogEnabled.

Specified by:
loggerName in interface LogEnabled
Returns:
Returns the logger.

logger

protected void logger(String logger)
Rename the logger. Used after de-serialisation.

Parameters:
logger - The logger to set.

toString

public String toString()
Override toString.

Overrides:
toString in class Object