org.eclipse.emfforms.common.spi.validation

Interface ValidationService

All Known Implementing Classes:

ValidationServiceImpl

public interface ValidationService

Generic EMF validation service which allows validation of a collection of EObjects honoring defined EValidators. Additionally custom Validators can be registered i.e. if the feature set of the EValidators is insufficient.

Author:

Mat Hansen

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).
boolean	isBusy() Returns true as long as a validation is in process.
<Filter extends ValidationFilter> void	registerValidationFilter(Filter filter) Deprecated. Use addSubTreeFilter, addObjectFilter and addDiagnosticFilter instead
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.
<Filter extends ValidationFilter> void	unregisterValidationFilter(Filter filter) Deprecated. Use removeSubTreeFilter, removeObjectFilter and removeDiagnosticFilter instead
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> eObjects) Uses the given iterator to validate all eObjects in a collection.

Method Detail

addValidator

void addValidator(Validator validator)

Adds a validation provider to the list of known validators.

Parameters:

validator - the Validator to add

removeValidator

void removeValidator(Validator validator)

Removes a validation provider from the list of known validators.

Parameters:

validator - the Validator to remove

registerValidationFilter

@Deprecated
<Filter extends ValidationFilter> void registerValidationFilter(Filter filter)

Deprecated. Use addSubTreeFilter, addObjectFilter and addDiagnosticFilter instead

Registers a validation filter.

Type Parameters:

Filter - an ValidationFilter implementation

Parameters:

filter - the ValidationFilter to register

unregisterValidationFilter

@Deprecated
<Filter extends ValidationFilter> void unregisterValidationFilter(Filter filter)

Deprecated. Use removeSubTreeFilter, removeObjectFilter and removeDiagnosticFilter instead

Unregisters a validation filter.

Type Parameters:

Filter - an ValidationFilter implementation

Parameters:

filter - the ValidationFilter to unregister

registerValidationResultListener

void registerValidationResultListener(ValidationResultListener listener)

Registers a ValidationResultListener.

Parameters:

listener - the ValidationResultListener to register

unregisterValidationResultListener

void unregisterValidationResultListener(ValidationResultListener listener)

Unregisters a ValidationResultListener.

Parameters:

listener - the ValidationResultListener to unregister

setSubstitutionLabelProvider

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

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

Parameters:

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

See Also:

EValidator.SubstitutionLabelProvider

validate

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

Validates the given eObject.

Parameters:

eObject - the eObject to validate

Returns:

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

validate

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

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

Parameters:

eObjects - the list to validate

Returns:

the resulting set of Diagnostics

Throws:

ValidationCanceledException - in case cancel() has been called

isBusy

boolean isBusy()

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

Returns:

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

cancel

void cancel()

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

addSubTreeFilter

void addSubTreeFilter(SubTreeFilter subTreeFilter)

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

Parameters:

subTreeFilter - SubTreeFilter

addObjectFilter

void addObjectFilter(ObjectFilter objectFilter)

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

Parameters:

objectFilter - ObjectFilter

addDiagnosticFilter

void addDiagnosticFilter(DiagnosticFilter diagnosticFilter)

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

Parameters:

diagnosticFilter - DiagnosticFilter

removeSubTreeFilter

void removeSubTreeFilter(SubTreeFilter subTreeFilter)

Removes a SubTreeFilter.

Parameters:

subTreeFilter - SubTreeFilter

removeObjectFilter

void removeObjectFilter(ObjectFilter objectFilter)

Removes an ObjectFilter.

Parameters:

objectFilter - ObjectFilter

removeDiagnosticFilter

void removeDiagnosticFilter(DiagnosticFilter diagnosticFilter)

Removes a DiagnosticFilter.

Parameters:

diagnosticFilter - DiagnosticFilter