org.eclipse.emfforms.common.internal.validation

Class ValidationServiceImpl

java.lang.Object

org.eclipse.emfforms.common.internal.validation.ValidationServiceImpl

All Implemented Interfaces:

ValidationService

public class ValidationServiceImpl
extends Object
implements ValidationService

The implementation of ValidationService.

Author:

Mat Hansen

Constructor Summary

Constructors

Constructor and Description
ValidationServiceImpl() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addDiagnosticFilter(DiagnosticFilter diagnosticFilter) Adds a DiagnosticFilter to remove specific Diagnostic from the result of a validation.
void	addObjectFilter(ObjectFilter objectFilter) Adds an ObjectFilter to skip specific EObjects during the validation.
void	addSubTreeFilter(SubTreeFilter subTreeFilter) Adds a SubTreeFilter to skip specific sub trees during the validation.
void	addValidator(Validator validator) Adds a validation provider to the list of known validators.
void	cancel() Allows to cancel the current validation run (if any).
protected org.eclipse.emf.common.util.Diagnostic	getDiagnosticForEObject(org.eclipse.emf.ecore.EObject object) Computes the Diagnostic for the given eObject.
protected org.eclipse.emf.ecore.EValidator	getEValidatorForEObject(org.eclipse.emf.ecore.EObject eObject) Returns a EValidator for the given EObject.
protected Map<Object,Object>	getValidationContext(org.eclipse.emf.ecore.EValidator eValidator) Obtains the shared validation context for a validation of multiple objects or a one-off context for validation of a single object.
boolean	isBusy() Returns true as long as a validation is in process.
void	registerValidationFilter(ValidationFilter filter) Registers a validation filter.
void	registerValidationResultListener(ValidationResultListener listener) Registers a ValidationResultListener.
void	removeDiagnosticFilter(DiagnosticFilter diagnosticFilter) Removes a DiagnosticFilter.
void	removeObjectFilter(ObjectFilter objectFilter) Removes an ObjectFilter.
void	removeSubTreeFilter(SubTreeFilter subTreeFilter) Removes a SubTreeFilter.
void	removeValidator(Validator validator) Removes a validation provider from the list of known validators.
void	setSubstitutionLabelProvider(org.eclipse.emf.ecore.EValidator.SubstitutionLabelProvider substitutionLabelProvider) Set a EValidator.SubstitutionLabelProvider to be used for substituting labels in Diagnostics.
void	unregisterValidationFilter(ValidationFilter filter) Unregisters a validation filter.
void	unregisterValidationResultListener(ValidationResultListener listener) Unregisters a ValidationResultListener.
org.eclipse.emf.common.util.Diagnostic	validate(org.eclipse.emf.ecore.EObject eObject) Validates the given eObject.
Set<org.eclipse.emf.common.util.Diagnostic>	validate(Iterator<org.eclipse.emf.ecore.EObject> eObjectsIterator) Uses the given iterator to validate all eObjects in a collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValidationServiceImpl

public ValidationServiceImpl()

Default constructor.

Method Detail

validate

public org.eclipse.emf.common.util.Diagnostic validate(org.eclipse.emf.ecore.EObject eObject)

Description copied from interface: ValidationService

Validates the given eObject.

Specified by:

validate in interface ValidationService

Parameters:

eObject - the eObject to validate

Returns:

the resulting Diagnostic, or null if the eObject is filtered by a ValidationFilter

validate

public Set<org.eclipse.emf.common.util.Diagnostic> validate(Iterator<org.eclipse.emf.ecore.EObject> eObjectsIterator)
                                                     throws ValidationCanceledException

Description copied from interface: ValidationService

Uses the given iterator to validate all eObjects in a collection.

Specified by:

validate in interface ValidationService

Parameters:

eObjectsIterator - the list to validate

Returns:

the resulting set of Diagnostics

Throws:

ValidationCanceledException - in case ValidationService.cancel() has been called

getEValidatorForEObject

protected org.eclipse.emf.ecore.EValidator getEValidatorForEObject(org.eclipse.emf.ecore.EObject eObject)

Returns a EValidator for the given EObject.

Parameters:

eObject - the EObject to retrieve a EValidator for

Returns:

the EValidator

getDiagnosticForEObject

protected org.eclipse.emf.common.util.Diagnostic getDiagnosticForEObject(org.eclipse.emf.ecore.EObject object)

Computes the Diagnostic for the given eObject.

Parameters:

object - the EObject to validate

Returns:

the Diagnostic

getValidationContext

protected Map<Object,Object> getValidationContext(org.eclipse.emf.ecore.EValidator eValidator)

Obtains the shared validation context for a validation of multiple objects or a one-off context for validation of a single object. If I have a substitution label provider, thn it will also be put into the context. Subclasses may extend this to populate the context with anything else of interest.

Parameters:

eValidator - the validator to put into the context

Returns:

the context

addValidator

public void addValidator(Validator validator)

Description copied from interface: ValidationService

Adds a validation provider to the list of known validators.

Specified by:

addValidator in interface ValidationService

Parameters:

validator - the Validator to add

removeValidator

public void removeValidator(Validator validator)

Description copied from interface: ValidationService

Removes a validation provider from the list of known validators.

Specified by:

removeValidator in interface ValidationService

Parameters:

validator - the Validator to remove

registerValidationFilter

public void registerValidationFilter(ValidationFilter filter)

Description copied from interface: ValidationService

Registers a validation filter.

Specified by:

registerValidationFilter in interface ValidationService

Parameters:

filter - the ValidationFilter to register

unregisterValidationFilter

public void unregisterValidationFilter(ValidationFilter filter)

Description copied from interface: ValidationService

Unregisters a validation filter.

Specified by:

unregisterValidationFilter in interface ValidationService

Parameters:

filter - the ValidationFilter to unregister

registerValidationResultListener

public void registerValidationResultListener(ValidationResultListener listener)

Description copied from interface: ValidationService

Registers a ValidationResultListener.

Specified by:

registerValidationResultListener in interface ValidationService

Parameters:

listener - the ValidationResultListener to register

unregisterValidationResultListener

public void unregisterValidationResultListener(ValidationResultListener listener)

Description copied from interface: ValidationService

Unregisters a ValidationResultListener.

Specified by:

unregisterValidationResultListener in interface ValidationService

Parameters:

listener - the ValidationResultListener to unregister

setSubstitutionLabelProvider

public void setSubstitutionLabelProvider(org.eclipse.emf.ecore.EValidator.SubstitutionLabelProvider substitutionLabelProvider)

Description copied from interface: ValidationService

Set a EValidator.SubstitutionLabelProvider to be used for substituting labels in Diagnostics.

Specified by:

setSubstitutionLabelProvider in interface ValidationService

Parameters:

substitutionLabelProvider - the EValidator.SubstitutionLabelProvider to be set for this service

See Also:

EValidator.SubstitutionLabelProvider

isBusy

public boolean isBusy()

Description copied from interface: ValidationService

Returns true as long as a validation is in process. Not applicable for single validation runs with ValidationService.validate(EObject). See ValidationService.cancel() to interrupt a running validation process.

Specified by:

isBusy in interface ValidationService

Returns:

true as long as a validation is running, false otherwise.

cancel

public void cancel()

Description copied from interface: ValidationService

Allows to cancel the current validation run (if any). Not applicable for single validation runs with ValidationService.validate(EObject).

Specified by:

cancel in interface ValidationService

addSubTreeFilter

public void addSubTreeFilter(SubTreeFilter subTreeFilter)

Description copied from interface: ValidationService

Adds a SubTreeFilter to skip specific sub trees during the validation. null is ignored.

Specified by:

addSubTreeFilter in interface ValidationService

Parameters:

subTreeFilter - SubTreeFilter

addObjectFilter

public void addObjectFilter(ObjectFilter objectFilter)

Description copied from interface: ValidationService

Adds an ObjectFilter to skip specific EObjects during the validation. null is ignored.

Specified by:

addObjectFilter in interface ValidationService

Parameters:

objectFilter - ObjectFilter

addDiagnosticFilter

public void addDiagnosticFilter(DiagnosticFilter diagnosticFilter)

Description copied from interface: ValidationService

Adds a DiagnosticFilter to remove specific Diagnostic from the result of a validation. null is ignored.

Specified by:

addDiagnosticFilter in interface ValidationService

Parameters:

diagnosticFilter - DiagnosticFilter

removeSubTreeFilter

public void removeSubTreeFilter(SubTreeFilter subTreeFilter)

Description copied from interface: ValidationService

Removes a SubTreeFilter.

Specified by:

removeSubTreeFilter in interface ValidationService

Parameters:

subTreeFilter - SubTreeFilter

removeObjectFilter

public void removeObjectFilter(ObjectFilter objectFilter)

Description copied from interface: ValidationService

Removes an ObjectFilter.

Specified by:

removeObjectFilter in interface ValidationService

Parameters:

objectFilter - ObjectFilter

removeDiagnosticFilter

public void removeDiagnosticFilter(DiagnosticFilter diagnosticFilter)

Description copied from interface: ValidationService

Removes a DiagnosticFilter.

Specified by:

removeDiagnosticFilter in interface ValidationService

Parameters:

diagnosticFilter - DiagnosticFilter