uk.ac.ebi.arrayexpress2.magetab.validator

Interface Validator<T>

All Known Implementing Classes:

AbstractValidator, IDFValidator, MAGETABValidator, SDRFValidator

public interface Validator<T>

A semantic validator process, distinct from syntactic validation which is handled by a Parser. Implementations of this class should be typed by the types of object they validate.

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 validator.
Set<ErrorItemListener>	getErrorItemListeners() Get the current set of ErrorItemListeners registered to this validator
Collection<ProgressListener>	getProgressListeners() Get the collection of ProgressListeners that are currently registered to this validator.
void	removeErrorItemListener(ErrorItemListener listener) Deregister an ErrorItemListener with this parser.
void	removeProgressListener(ProgressListener listener) Deregister a ProgressListener from this validator.
void	validate(T validatorSource) Perform validation of the supplied validator source.
void	validate(T validatorSource, ExecutorService service) Perform validation of the supplied validator source, delegating all work to the supplied Executor Service to enable validation in parallel.

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

Set<ErrorItemListener> getErrorItemListeners()

Get the current set of ErrorItemListeners registered to this validator

Returns:

the current set of listeners registered

addProgressListener

void addProgressListener(ProgressListener listener)

Register a ProgressListener with this validator. Whenever the validator 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 validator. Progress events will no longer be reported through this validator

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 validator.

Returns:

all currently registered progress listeners

validate

void validate(T validatorSource)
              throws ValidateException

Perform validation of the supplied validator source.

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:

validatorSource - the generically typed datamodel object to validate

Throws:

ValidateException - if the supplied source could not be validated

validate

void validate(T validatorSource,
            ExecutorService service)
              throws ValidateException,
                     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:

validatorSource - the datamodel objects to validate

service - the service to use to execute validation tasks

Throws:

ValidateException - if the supplied source could not be validated

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