uk.ac.ebi.arrayexpress2.magetab.handler.sdrf

Class SDRFValidateHandler

java.lang.Object

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

uk.ac.ebi.arrayexpress2.magetab.handler.sdrf.SDRFValidateHandler

All Implemented Interfaces:

Handler, ValidateHandler<SDRF>

public abstract class SDRFValidateHandler
extends AbstractHandler
implements ValidateHandler<SDRF>

An abstract implementation of a ValidateHandler 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
SDRFValidateHandler()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canValidate(Object data) Determine whether this handler can validate the supplied data.
protected abstract boolean	canValidateData(SDRF sdrf) Performs specific checks on the SDRF to determine if this handler can validate it.
void	validate(SDRF data) Invoke this validate handler.
protected abstract void	validateData(SDRF data) Performs the unit of work to validate the data.

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

SDRFValidateHandler

public SDRFValidateHandler()

Method Detail

canValidate

public boolean canValidate(Object data)

Description copied from interface: ValidateHandler

Determine whether this handler can validate 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:

canValidate in interface ValidateHandler<SDRF>

Parameters:

data - the data that will be validated

Returns:

true if this handler can handle this tag, false otherwise

validate

public void validate(SDRF data)
              throws ValidateException

Invoke this validate handler. This will validate the supplied data assigned to this handler.

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

Specified by:

validate in interface ValidateHandler<SDRF>

Parameters:

data - the data object to be validated

Throws:

ValidateException - if the handler failed to validate data from it's source

canValidateData

protected abstract boolean canValidateData(SDRF sdrf)

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

Parameters:

sdrf - the SDRF to check

validateData

protected abstract void validateData(SDRF data)
                              throws ValidateException

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

This method is passed the SDRF to validate from.

Throws:

ValidateException - if there was an error validating the data