uk.ac.ebi.arrayexpress2.magetab.handler

Class AbstractHandler

java.lang.Object

uk.ac.ebi.arrayexpress2.magetab.handler.AbstractHandler

All Implemented Interfaces:

Handler

Direct Known Subclasses:

ADFConversionHandler, ADFGraphReadHandler, ADFHeaderReadHandler, ADFNodeConversionHandler, ADFValidateHandler, IDFConversionHandler, IDFReadHandler, IDFValidateHandler, MAGETABValidateHandler, SDRFConversionHandler, SDRFNodeConversionHandler, SDRFReadHandler, SDRFValidateHandler

public abstract class AbstractHandler
extends Object
implements Handler

A basic handler implementation that provides some simple functionality common to all handlers. There is no implementation of the handle() method so more specific implementations can override this.

Author:

Tony Burdett

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<HandlerListener>	listeners

Constructor Summary

Constructors

Constructor and Description
AbstractHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(HandlerVisitor visitor) Accept a visit from a HandlerVisitor
void	addListener(HandlerListener listener) Register a HandlerListener that can listen for handling events.
protected void	fireHandlingFailedEvent(HandlerEvent evt) Notifies all registered listeners that this handler failed
protected void	fireHandlingStartedEvent(HandlerEvent evt) Notifies all registered listeners that this handler started
protected void	fireHandlingSucceededEvent(HandlerEvent evt) Notifies all registered listeners that this handler completed successfully
Collection<HandlerListener>	getListeners() Gets the collection of listeners registered to this handler
protected org.slf4j.Logger	getLog() Gets a logger configured for the current handler class
void	removeListener(HandlerListener listener) Deregister a HandlerListener that can listen for handling events.

Methods inherited from class java.lang.Object

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

Field Detail

listeners

protected final Set<HandlerListener> listeners

Constructor Detail

AbstractHandler

public AbstractHandler()

Method Detail

getLog

protected org.slf4j.Logger getLog()

Gets a logger configured for the current handler class

Returns:

the logger

accept

public void accept(HandlerVisitor visitor)

Description copied from interface: Handler

Accept a visit from a HandlerVisitor

Specified by:

accept in interface Handler

Parameters:

visitor - the visitor to accept a visit from

addListener

public void addListener(HandlerListener listener)

Description copied from interface: Handler

Register a HandlerListener that can listen for handling events.

Specified by:

addListener in interface Handler

Parameters:

listener - the listener to register

removeListener

public void removeListener(HandlerListener listener)

Description copied from interface: Handler

Deregister a HandlerListener that can listen for handling events.

Specified by:

removeListener in interface Handler

Parameters:

listener - the listener to deregister

getListeners

public Collection<HandlerListener> getListeners()

Description copied from interface: Handler

Gets the collection of listeners registered to this handler

Specified by:

getListeners in interface Handler

Returns:

the collection of registered listeners

fireHandlingStartedEvent

protected void fireHandlingStartedEvent(HandlerEvent evt)

Notifies all registered listeners that this handler started

Parameters:

evt - the event that should be fired

fireHandlingSucceededEvent

protected void fireHandlingSucceededEvent(HandlerEvent evt)

Notifies all registered listeners that this handler completed successfully

Parameters:

evt - the event that should be fired

fireHandlingFailedEvent

protected void fireHandlingFailedEvent(HandlerEvent evt)

Notifies all registered listeners that this handler failed

Parameters:

evt - the event that should be fired