uk.ac.ebi.arrayexpress2.magetab.converter

Class AbstractConverter<S,T>

java.lang.Object

uk.ac.ebi.arrayexpress2.magetab.converter.AbstractConverter<S,T>

All Implemented Interfaces:

Converter<S,T>

Direct Known Subclasses:

IDFConverter, MAGETABConverter, SDRFConverter

public abstract class AbstractConverter<S,T>
extends Object
implements Converter<S,T>

Javadocs go here!

Author:

Tony Burdett

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConverter()

Method Summary

Methods

Modifier and Type	Method and Description
void	addErrorItemListener(ErrorItemListener listener) Register an ErrorItemListener with this parser.
void	addProgressListener(ProgressListener listener) Register a ProgressListener with this converter.
protected void	fireConversionCompletedEvent(ProgressEvent event)
protected void	fireConversionEvent(ProgressEvent event)
protected void	fireConversionFailedEvent(ProgressEvent event)
protected void	fireConversionStartedEvent(ProgressEvent event)
protected void	fireErrorItemEvent(org.mged.magetab.error.ErrorItem errorItem) Fires an error item notification on any ErrorItemListeners currently configured to listen to this converter.
Set<ErrorItemListener>	getErrorItemListeners() Get the collection of ErrorItemListeners registered to this parser
Collection<ProgressListener>	getProgressListeners() Get the collection of ProgressListeners that are currently registered to this converter.
void	removeErrorItemListener(ErrorItemListener listener) Deregister an ErrorItemListener with this parser.
void	removeProgressListener(ProgressListener listener) Deregister a ProgressListener from this converter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ebi.arrayexpress2.magetab.converter.Converter

convert, convert

Constructor Detail

AbstractConverter

protected AbstractConverter()

Method Detail

addErrorItemListener

public void addErrorItemListener(ErrorItemListener listener)

Description copied from interface: Converter

Register an ErrorItemListener with this parser. Whenever an error is encountered when parsing from the a parserSource, this listener should be notified.

Specified by:

addErrorItemListener in interface Converter<S,T>

Parameters:

listener - the listener to register

removeErrorItemListener

public void removeErrorItemListener(ErrorItemListener listener)

Description copied from interface: Converter

Deregister an ErrorItemListener with this parser. This listener will no longer be notified when error items are generated.

Specified by:

removeErrorItemListener in interface Converter<S,T>

Parameters:

listener - the listener to register

getErrorItemListeners

public Set<ErrorItemListener> getErrorItemListeners()

Description copied from interface: Converter

Get the collection of ErrorItemListeners registered to this parser

Specified by:

getErrorItemListeners in interface Converter<S,T>

Returns:

the current set of listeners registered

addProgressListener

public void addProgressListener(ProgressListener listener)

Description copied from interface: Converter

Register a ProgressListener with this converter. Whenever the converter has more progress to report, this listener will be notified.

Specified by:

addProgressListener in interface Converter<S,T>

Parameters:

listener - the listener to register

removeProgressListener

public void removeProgressListener(ProgressListener listener)

Description copied from interface: Converter

Deregister a ProgressListener from this converter. Progress events will no longer be reported through this converter

Specified by:

removeProgressListener in interface Converter<S,T>

Parameters:

listener - a listener to monitor progress of the parsing operation

getProgressListeners

public Collection<ProgressListener> getProgressListeners()

Description copied from interface: Converter

Get the collection of ProgressListeners that are currently registered to this converter.

Specified by:

getProgressListeners in interface Converter<S,T>

Returns:

all currently registered progress listeners

fireErrorItemEvent

protected void fireErrorItemEvent(org.mged.magetab.error.ErrorItem errorItem)

Fires an error item notification on any ErrorItemListeners currently configured to listen to this converter.

Parameters:

errorItem - the error item that encapsulates the error

fireConversionStartedEvent

protected void fireConversionStartedEvent(ProgressEvent event)

fireConversionCompletedEvent

protected void fireConversionCompletedEvent(ProgressEvent event)

fireConversionFailedEvent

protected void fireConversionFailedEvent(ProgressEvent event)

fireConversionEvent

protected void fireConversionEvent(ProgressEvent event)