org.eclipse.emf.ecp.view.internal.validation

Class ValidationServiceImpl

java.lang.Object

org.eclipse.emf.ecp.view.internal.validation.ValidationServiceImpl

All Implemented Interfaces:

GlobalViewModelService, ViewModelService, IncrementalValidationService, ValidationService

public class ValidationServiceImpl
extends Object
implements ValidationService, IncrementalValidationService

Validation service that, once instantiated, synchronizes the validation result of a model element with its Renderable.

Author:

Eugen Neufeld

Constructor Summary

Constructors

Constructor and Description
ValidationServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addValidationProvider(ValidationProvider validationProvider) Adds a validation provider to the list of known validation providers.
void	addValidationProvider(ValidationProvider validationProvider, boolean revalidate) Adds a validation provider to the list of known validation providers.
void	childViewModelContextAdded(ViewModelContext childContext) This method is called whenever a new ViewModelContext is added as a child context to the root ViewModelContext this GlobalViewModelService belongs to.
void	deregisterValidationListener(ViewValidationListener listener) Deregisters the given listener.
void	deregisterValidationUpdateListener(ValidationUpdateListener listener) De-register a listener for incremental validation updates.
void	dispose() Dispose.
int	getPriority() Returns the priority for this view service.
protected ViewSubstitutionLabelProviderFactory	getSubstitutionLabelProviderFactory() Returns a ViewSubstitutionLabelProviderFactory, if any is registered.
void	instantiate(ViewModelContext context) Instantiate the view service.
void	notifyListeners() Notifies all listeners.
void	registerValidationListener(ViewValidationListener listener) Registers a listener that will receive Diagnostics with severity higher than Diagnostic#OK.
void	registerValidationUpdateListener(ValidationUpdateListener listener) Register a listener for incremental validation updates.
void	removeValidationProvider(ValidationProvider validationProvider) Removes a validation provider from the list of known validation providers.
void	removeValidationProvider(ValidationProvider validationProvider, boolean revalidate) Removes a validation provider from the list of known validation providers.
void	validate(Collection<org.eclipse.emf.ecore.EObject> eObjects) Validates all given eObjects.
void	validate(org.eclipse.emf.ecore.EObject eObject) Validate the given eObject.
void	validate(Iterable<? extends org.eclipse.emf.ecore.EObject> objects) Validate the objects provided by an iterable.
protected void	warn(String messageKey, Object... arguments) Issue a warning composed of the indicated localized string with positional arguments.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.emf.ecp.view.spi.validation.ValidationService

getSubstitutionLabelProvider

Constructor Detail

ValidationServiceImpl

public ValidationServiceImpl()

Method Detail

instantiate

public void instantiate(ViewModelContext context)

Description copied from interface: ViewModelService

Instantiate the view service.

Specified by:

instantiate in interface ViewModelService

Parameters:

context - the ViewModelContext

dispose

public void dispose()

Description copied from interface: ViewModelService

Dispose.

Specified by:

dispose in interface ViewModelService

getPriority

public int getPriority()

Description copied from interface: ViewModelService

Returns the priority for this view service.

Specified by:

getPriority in interface ViewModelService

Returns:

the priority

validate

public void validate(Iterable<? extends org.eclipse.emf.ecore.EObject> objects)

Description copied from interface: ValidationService

Validate the objects provided by an iterable.

Specified by:

validate in interface ValidationService

Parameters:

objects - the iterable from which to obtain objects to validate

validate

public void validate(Collection<org.eclipse.emf.ecore.EObject> eObjects)

Description copied from interface: ValidationService

Validates all given eObjects.

Specified by:

validate in interface ValidationService

Parameters:

eObjects - the eObjects to validate

See Also:

#validate(Iterable)} for an alternative that is more convenient when validating content trees covered by EMF {@code TreeIterator}s

validate

public void validate(org.eclipse.emf.ecore.EObject eObject)

Validate the given eObject.

Parameters:

eObject - the eObject to validate

notifyListeners

public void notifyListeners()

Notifies all listeners.

addValidationProvider

public void addValidationProvider(ValidationProvider validationProvider)

Description copied from interface: ValidationService

Adds a validation provider to the list of known validation providers. The domain model will be revalidated after the provider has been added.

Specified by:

addValidationProvider in interface ValidationService

Parameters:

validationProvider - the ValidationProvider to add

addValidationProvider

public void addValidationProvider(ValidationProvider validationProvider,
                                  boolean revalidate)

Description copied from interface: ValidationService

Adds a validation provider to the list of known validation providers.

Specified by:

addValidationProvider in interface ValidationService

Parameters:

validationProvider - the ValidationProvider to add

revalidate - whether to revalidate the domain model after the provider has been added

removeValidationProvider

public void removeValidationProvider(ValidationProvider validationProvider)

Description copied from interface: ValidationService

Removes a validation provider from the list of known validation providers.

Specified by:

removeValidationProvider in interface ValidationService

Parameters:

validationProvider - the ValidationProvider to remove

removeValidationProvider

public void removeValidationProvider(ValidationProvider validationProvider,
                                     boolean revalidate)

Description copied from interface: ValidationService

Removes a validation provider from the list of known validation providers. The domain model will be revalidated after the provider has been removed

Specified by:

removeValidationProvider in interface ValidationService

Parameters:

validationProvider - the ValidationProvider to remove

revalidate - whether to revalidate the domain model after the provider has been removed

registerValidationListener

public void registerValidationListener(ViewValidationListener listener)

Description copied from interface: ValidationService

Registers a listener that will receive Diagnostics with severity higher than Diagnostic#OK. After registration the listener's ViewValidationListener.onNewValidation(java.util.Set) will be called with current results.

Specified by:

registerValidationListener in interface ValidationService

Parameters:

listener - the listener to register

deregisterValidationListener

public void deregisterValidationListener(ViewValidationListener listener)

Description copied from interface: ValidationService

Deregisters the given listener.

Specified by:

deregisterValidationListener in interface ValidationService

Parameters:

listener - the listener to deregister

childViewModelContextAdded

public void childViewModelContextAdded(ViewModelContext childContext)

Description copied from interface: GlobalViewModelService

This method is called whenever a new ViewModelContext is added as a child context to the root ViewModelContext this GlobalViewModelService belongs to.

Specified by:

childViewModelContextAdded in interface GlobalViewModelService

Parameters:

childContext - The ViewModelContext that was added.

getSubstitutionLabelProviderFactory

protected ViewSubstitutionLabelProviderFactory getSubstitutionLabelProviderFactory()

Returns a ViewSubstitutionLabelProviderFactory, if any is registered.

Returns:

an instance of a ViewSubstitutionLabelProviderFactory, if any is available, null otherwise

warn

protected void warn(String messageKey,
                    Object... arguments)

Issue a warning composed of the indicated localized string with positional arguments.

Parameters:

messageKey - key to look up in the host bundle's localizations

arguments - zero-indexed arguments to substitute, if any, in the string

registerValidationUpdateListener

public void registerValidationUpdateListener(ValidationUpdateListener listener)

Description copied from interface: IncrementalValidationService

Register a listener for incremental validation updates.

Specified by:

registerValidationUpdateListener in interface IncrementalValidationService

Parameters:

listener - the incremental validation listener

Since:

1.22

deregisterValidationUpdateListener

public void deregisterValidationUpdateListener(ValidationUpdateListener listener)

Description copied from interface: IncrementalValidationService

De-register a listener for incremental validation updates.

Specified by:

deregisterValidationUpdateListener in interface IncrementalValidationService

Parameters:

listener - the incremental validation listener

Since:

1.22