uk.ac.ebi.arrayexpress2.magetab.validator

Class AbstractValidator<T>

java.lang.Object

uk.ac.ebi.arrayexpress2.magetab.validator.AbstractValidator<T>

All Implemented Interfaces:

Validator<T>

Direct Known Subclasses:

IDFValidator, MAGETABValidator, SDRFValidator

public abstract class AbstractValidator<T>
extends Object
implements Validator<T>

An abstract implementation of the Validator interface. This class supplies a default implementations for listener registration, so that concrete implementations need only call fireErrorItemEvent(org.mged.magetab.error.ErrorItem) to report an event whenever an error item is generated.

Author:

Tony Burdett

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractValidator()

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.
protected void	fireErrorItemEvent(org.mged.magetab.error.ErrorItem errorItem) Fires an error item notification on any ErrorItemListeners currently configured to listen to this validator.
protected void	fireValidationCompletedEvent(ProgressEvent event)
protected void	fireValidationEvent(ProgressEvent event)
protected void	fireValidationFailedEvent(ProgressEvent event)
protected void	fireValidationStartedEvent(ProgressEvent event)
Set<ErrorItemListener>	getErrorItemListeners() Get the current set of ErrorItemListeners registered to this validator
org.slf4j.Logger	getLog()
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, ExecutorService service) This default implementation ignored the supplied service and executes tasks in a linear manner, This is retained to preserve backwards compatibility with the 1.0 release.

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

validate

Constructor Detail

AbstractValidator

protected AbstractValidator()

Method Detail

getLog

public org.slf4j.Logger getLog()

addErrorItemListener

public void addErrorItemListener(ErrorItemListener listener)

Description copied from interface: Validator

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 Validator<T>

Parameters:

listener - the listener to register

removeErrorItemListener

public void removeErrorItemListener(ErrorItemListener listener)

Description copied from interface: Validator

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

Specified by:

removeErrorItemListener in interface Validator<T>

Parameters:

listener - the listener to register

getErrorItemListeners

public Set<ErrorItemListener> getErrorItemListeners()

Description copied from interface: Validator

Get the current set of ErrorItemListeners registered to this validator

Specified by:

getErrorItemListeners in interface Validator<T>

Returns:

the current set of listeners registered

addProgressListener

public void addProgressListener(ProgressListener listener)

Description copied from interface: Validator

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

Specified by:

addProgressListener in interface Validator<T>

Parameters:

listener - the listener to register

removeProgressListener

public void removeProgressListener(ProgressListener listener)

Description copied from interface: Validator

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

Specified by:

removeProgressListener in interface Validator<T>

Parameters:

listener - a listener to monitor progress of the parsing operation

getProgressListeners

public Collection<ProgressListener> getProgressListeners()

Description copied from interface: Validator

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

Specified by:

getProgressListeners in interface Validator<T>

Returns:

all currently registered progress listeners

validate

public void validate(T validatorSource,
            ExecutorService service)
              throws ValidateException,
                     InterruptedException

This default implementation ignored the supplied service and executes tasks in a linear manner, This is retained to preserve backwards compatibility with the 1.0 release.

Specified by:

validate in interface Validator<T>

Parameters:

validatorSource - the datamodel objects to validate

service - the service to use to execute validation tasks

Throws:

ValidateException

InterruptedException

fireErrorItemEvent

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

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

Parameters:

errorItem - the error item that encapsulates the error

fireValidationStartedEvent

protected void fireValidationStartedEvent(ProgressEvent event)

fireValidationCompletedEvent

protected void fireValidationCompletedEvent(ProgressEvent event)

fireValidationFailedEvent

protected void fireValidationFailedEvent(ProgressEvent event)

fireValidationEvent

protected void fireValidationEvent(ProgressEvent event)