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, ValidationService, EMFFormsContextListener

public class ValidationServiceImpl
extends Object
implements ValidationService, EMFFormsContextListener

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	childContextAdded(VElement parentElement, EMFFormsViewContext childContext) Called when a child context is added.
void	childContextDisposed(EMFFormsViewContext childContext) Called when a child context is disposed.
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	contextDispose() Called by the context when the dispose is running.
void	contextInitialised() Called by the context when the initialization has finished.
void	deregisterValidationListener(ViewValidationListener listener) Deregisters the given listener.
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	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationServiceImpl

public ValidationServiceImpl()

Method Detail

instantiate

public void instantiate(ViewModelContext context)

Instantiate the view service.

Specified by:

instantiate in interface ViewModelService

Parameters:

context - the ViewModelContext

See Also:

ViewModelService.instantiate(org.eclipse.emf.ecp.view.spi.context.ViewModelContext)

dispose

public void dispose()

Dispose.

Specified by:

dispose in interface ViewModelService

See Also:

ViewModelService.dispose()

getPriority

public int getPriority()

Returns the priority for this view service.

Specified by:

getPriority in interface ViewModelService

Returns:

the priority

See Also:

ViewModelService.getPriority()

validate

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

Validates all given eObjects.

Specified by:

validate in interface ValidationService

Parameters:

eObjects - the eObjects to validate

See Also:

ValidationService.validate(java.util.Collection)

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)

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

See Also:

ValidationService.addValidationProvider(org.eclipse.emf.ecp.view.spi.validation.ValidationProvider)

addValidationProvider

public void addValidationProvider(ValidationProvider validationProvider,
                                  boolean revalidate)

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

See Also:

ValidationService.addValidationProvider(org.eclipse.emf.ecp.view.spi.validation.ValidationProvider, boolean)

removeValidationProvider

public void removeValidationProvider(ValidationProvider validationProvider)

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

Specified by:

removeValidationProvider in interface ValidationService

Parameters:

validationProvider - the ValidationProvider to remove

See Also:

ValidationService.removeValidationProvider(org.eclipse.emf.ecp.view.spi.validation.ValidationProvider)

removeValidationProvider

public void removeValidationProvider(ValidationProvider validationProvider,
                                     boolean revalidate)

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

See Also:

ValidationService.removeValidationProvider(org.eclipse.emf.ecp.view.spi.validation.ValidationProvider, boolean)

registerValidationListener

public void registerValidationListener(ViewValidationListener listener)

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

See Also:

ValidationService.registerValidationListener(org.eclipse.emf.ecp.view.spi.validation.ViewValidationListener)

deregisterValidationListener

public void deregisterValidationListener(ViewValidationListener listener)

Deregisters the given listener.

Specified by:

deregisterValidationListener in interface ValidationService

Parameters:

listener - the listener to deregister

See Also:

ValidationService.deregisterValidationListener(org.eclipse.emf.ecp.view.spi.validation.ViewValidationListener)

childViewModelContextAdded

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

Specified by:

childViewModelContextAdded in interface GlobalViewModelService

Parameters:

childContext - The ViewModelContext that was added.

See Also:

GlobalViewModelService.childViewModelContextAdded(org.eclipse.emf.ecp.view.spi.context.ViewModelContext)

childContextAdded

public void childContextAdded(VElement parentElement,
                              EMFFormsViewContext childContext)

Called when a child context is added.

Specified by:

childContextAdded in interface EMFFormsContextListener

Parameters:

parentElement - The VElement that is associated with the child context

childContext - The EMFFormsViewContext that was added

See Also:

EMFFormsContextListener.childContextAdded(org.eclipse.emf.ecp.view.spi.model.VElement, org.eclipse.emfforms.spi.core.services.view.EMFFormsViewContext)

childContextDisposed

public void childContextDisposed(EMFFormsViewContext childContext)

Called when a child context is disposed.

Specified by:

childContextDisposed in interface EMFFormsContextListener

Parameters:

childContext - The EMFFormsViewContext that was disposed

See Also:

EMFFormsContextListener.childContextDisposed(org.eclipse.emfforms.spi.core.services.view.EMFFormsViewContext)

contextInitialised

public void contextInitialised()

Called by the context when the initialization has finished.

Specified by:

contextInitialised in interface EMFFormsContextListener

See Also:

EMFFormsContextListener.contextInitialised()

contextDispose

public void contextDispose()

Called by the context when the dispose is running.

Specified by:

contextDispose in interface EMFFormsContextListener

See Also:

EMFFormsContextListener.contextDispose()

getSubstitutionLabelProviderFactory

protected ViewSubstitutionLabelProviderFactory getSubstitutionLabelProviderFactory()

Returns a ViewSubstitutionLabelProviderFactory, if any is registered.

Returns:

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