uk.ac.ebi.arrayexpress2.magetab.converter

Interface Converter<S,T>

All Known Implementing Classes:

AbstractConverter, IDFConverter, MAGETABConverter, SDRFConverter

public interface Converter<S,T>

A converter takes objects from the source object model and converts them into something else. The source type is the type of object this converter will convert. The target type is a generic type parameter and will usually be some sort of container for model objects or else a stream or file for writing data out directly.

Author:

Tony Burdett

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.
void	convert(S source, T target) Converts source objects into target objects.
void	convert(S source, T target, ExecutorService service) Perform validation of the supplied validator source, delegating all work to the supplied Executor Service to enable validation in parallel.
Collection<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.

Method Detail

addErrorItemListener

void addErrorItemListener(ErrorItemListener listener)

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

Parameters:

listener - the listener to register

removeErrorItemListener

void removeErrorItemListener(ErrorItemListener listener)

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

Parameters:

listener - the listener to register

getErrorItemListeners

Collection<ErrorItemListener> getErrorItemListeners()

Get the collection of ErrorItemListeners registered to this parser

Returns:

the current set of listeners registered

addProgressListener

void addProgressListener(ProgressListener listener)

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

Parameters:

listener - the listener to register

removeProgressListener

void removeProgressListener(ProgressListener listener)

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

Parameters:

listener - a listener to monitor progress of the parsing operation

getProgressListeners

Collection<ProgressListener> getProgressListeners()

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

Returns:

all currently registered progress listeners

convert

void convert(S source,
           T target)
             throws ConversionException

Converts source objects into target objects.

A ConversionException will be thrown if data could not be read from the supplied stream. You should not rely on an exception being thrown to determine whether the supplied MAGE-TAB is valid or complete, as parser implementations may ignore invalid or unreadable sections. Instead you should register an ErrorItem listener and check that there are no critical error events fired during the parse operation.

Parameters:

source - the source objects to convert

target - the resulting target objects

Throws:

ConversionException - if the source

convert

void convert(S source,
           T target,
           ExecutorService service)
             throws ConversionException,
                    InterruptedException

Perform validation of the supplied validator source, delegating all work to the supplied Executor Service to enable validation in parallel.

A ValidateException will be thrown if the supplied data could not be validated at all. You should not rely on an exception being thrown to determine whether the supplied MAGE-TAB is valid, as validator implementations may ignore invalid or unreadable sections. Instead you should register an ErrorItem listener and check that there are no critical error events fired during the validate operation.

Parameters:

source - the datamodel objects to convert from

target - the type of object data is being converted into

service - the service to use to execute conversion tasks

Throws:

ConversionException - if the supplied source could not be converted

InterruptedException - if execution of a task sent to the Executor Service was interrrupted