uk.ac.ebi.arrayexpress2.magetab.handler.idf

Class IDFConversionHandler<O>

java.lang.Object

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

uk.ac.ebi.arrayexpress2.magetab.handler.idf.IDFConversionHandler<O>

All Implemented Interfaces:

ConversionHandler<IDF,O>, Handler

public abstract class IDFConversionHandler<O>
extends AbstractHandler
implements ConversionHandler<IDF,O>

An abstract implementation of a ConversionHandler for writing data from an IDF to some external output resource.

Author:

Tony Burdett

Field Summary

Fields inherited from class uk.ac.ebi.arrayexpress2.magetab.handler.AbstractHandler

listeners

Constructor Summary

Constructors

Constructor and Description
IDFConversionHandler()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canConvert(Object data, Object outputResource) Determine whether this handler can convert the supplied data.
protected abstract boolean	canConvertData(IDF data) Performs specific checks on the IDF to determine if this handler can convert it.
void	convert(IDF data, O out) Invoke this convert handler.
protected abstract void	convertData(IDF data, O out) Performs the unit of work to convert the data into the given output resource.

Methods inherited from class uk.ac.ebi.arrayexpress2.magetab.handler.AbstractHandler

accept, addListener, fireHandlingFailedEvent, fireHandlingStartedEvent, fireHandlingSucceededEvent, getListeners, getLog, removeListener

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.handler.Handler

accept, addListener, getListeners, removeListener

Constructor Detail

IDFConversionHandler

public IDFConversionHandler()

Method Detail

canConvert

public boolean canConvert(Object data,
                 Object outputResource)

Description copied from interface: ConversionHandler

Determine whether this handler can convert the supplied data. Typically, the data will be a MAGETABInvestigation, MAGETABArrayDesign, IDF, SDRF, ADF or nodes from the SDRF or ADF graphs.

This data should be passed to the handler prior to writing to determine whether this handler can handle it

Specified by:

canConvert in interface ConversionHandler<IDF,O>

Parameters:

data - the data that needs to be written

outputResource - the output resource the will be written to

Returns:

true if this handler can handle the supplied data, false otherwise

convert

public void convert(IDF data,
           O out)
             throws ConversionException

Invoke this convert handler. This will convert the supplied data assigned to this handler into the given output resource.

This abstract implementation delegates the responsibility for setting the correct fields to concrete implementations via convertData(uk.ac.ebi.arrayexpress2.magetab.datamodel.IDF, Object). This method itself governs the update of progress tracking and status information.

Specified by:

convert in interface ConversionHandler<IDF,O>

Parameters:

data - the data model object that information should be written from

out - the resource that data can be converted to

Throws:

ConversionException - if the handler failed to convert data from it's source

canConvertData

protected abstract boolean canConvertData(IDF data)

Performs specific checks on the IDF to determine if this handler can convert it. This is different from canConvert(Object, Object) in that it is typed to the IDF and not any object - canConvert(Object, Object) handles type checking at the abstract level.

Parameters:

data - the IDF to check

Returns:

true if this handler can convert the supplied data

convertData

protected abstract void convertData(IDF data,
               O out)
                             throws ConversionException

Performs the unit of work to convert the data into the given output resource. Override this method in implementations, so that you don't need to implement status updating and checking code.

This method is passed the IDF to convert from, and the output resource to convert to.

Parameters:

data - the data to convert

out - the output resource to convert data to

Throws:

ConversionException - if there was an error writing the data