org.oddjob.framework.extend

Class BasePrimary

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

All Implemented Interfaces:

ArooaContextAware, ArooaSessionAware, PropertyChangeNotifier, Iconic, LogEnabled, Stateful

Direct Known Subclasses:

ArchiveJob, EventSourceBase, 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

Constructor Summary

Constructors

Constructor and Description
BasePrimary()

Method Summary

Modifier and Type	Method and Description
protected void	configure() Called by sub classes to configure this component.
java.lang.String	getName() Get the job name.
protected org.slf4j.Logger	logger() Allow sub classes access to the logger.
protected void	logger(java.lang.String logger) Rename the logger.
java.lang.String	loggerName() Provide the logger name.
protected void	save() Implementations override this to save their state on state change.
void	setName(java.lang.String name) Set the job name.
java.lang.String	toString() Override toString.

Methods inherited from class org.oddjob.framework.extend.BaseComponent

addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, fireDestroyedState, firePropertyChange, getArooaSession, iconForId, iconHelper, 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.slf4j.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(java.lang.String name)

Set the job name. Used by subclasses to set the job name.

Parameters:

name - The name of the job.

getName

public java.lang.String getName()

Get the job name.

Returns:

The job name.

loggerName

public java.lang.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(java.lang.String logger)

Rename the logger. Used after de-serialisation.

Parameters:

logger - The logger to set.

toString

public java.lang.String toString()

Override toString.

Overrides:

toString in class java.lang.Object