org.eclipse.ocl.examples.pivot.validation
Class PivotEObjectValidator

java.lang.Object
  org.eclipse.ocl.examples.pivot.validation.PivotEObjectValidator

All Implemented Interfaces:

org.eclipse.emf.ecore.EValidator

Direct Known Subclasses:

BasicCompleteOCLEObjectValidator, CompleteOCLEObjectValidator

public class PivotEObjectValidator
extends java.lang.Object
implements org.eclipse.emf.ecore.EValidator

A PivotEObjectValidator augments EValidator.Registry.INSTANCE validation by validation of additional Pivot-defined invariants. Since there is no per-ResourceSet EValidator.Registry it is necessary for the additional functionality for a particular EPackage to be provided by displacing the global entry into PivotEObjectValidator.eValidators and installing PivotEObjectValidator.INSTANCE in its stead. When validation occurs, the static INSTANCE first invokes the displaced functionality and then looks for a ValidationAdapter in the ResourceSet for the object to be validated. This ValidationAdapter is only available if the ResourceSet is for an application for which Pivot invariants were defined. Other applications see only a small overhead in their processing time.

Nested Class Summary

static class

PivotEObjectValidator.ValidationAdapter A ValidationAdapter is installed in the ResourceSet of applications that register for additional PIvot-defined constraints.

Nested classes/interfaces inherited from interface org.eclipse.emf.ecore.EValidator

org.eclipse.emf.ecore.EValidator.Descriptor, org.eclipse.emf.ecore.EValidator.PatternMatcher, org.eclipse.emf.ecore.EValidator.Registry, org.eclipse.emf.ecore.EValidator.SubstitutionLabelProvider, org.eclipse.emf.ecore.EValidator.ValidationDelegate

Field Summary

Fields inherited from interface org.eclipse.emf.ecore.EValidator

MARKER, RELATED_URIS_ATTRIBUTE, URI_ATTRIBUTE

Constructor Summary

PivotEObjectValidator()

Method Summary

static org.eclipse.emf.ecore.resource.ResourceSet	getResourceSet(org.eclipse.emf.ecore.EClassifier eClassifier, java.lang.Object object, org.eclipse.emf.common.util.DiagnosticChain diagnostics) Return the user's ResourceSet, preferably as a data element of the diagnostics, corresponding to the original validation context, else from the object else from the eClassifier.
static void	install(org.eclipse.emf.ecore.EPackage ePackage) Install Pivot-defined validation support for ePackage.
static PivotEObjectValidator.ValidationAdapter	install(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, MetaModelManager metaModelManager) Install Complete OCL validation support in resourceSet for metaModelManager.
boolean	validate(org.eclipse.emf.ecore.EClass eClass, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) Overriden to intercept the validation of an EObject to add the additional Pivot-defined validation.
boolean	validate(org.eclipse.emf.ecore.EDataType eDataType, java.lang.Object value, org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) Overriden to intercept the validation of an EDataType value to add the additional Pivot-defined validation.
boolean	validate(org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
protected boolean	validatePivot(org.eclipse.emf.ecore.EClassifier eClassifier, java.lang.Object object, org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) Perform the additional Pivot-defined validation.

Methods inherited from class java.lang.Object

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

Constructor Detail

PivotEObjectValidator

public PivotEObjectValidator()

Method Detail

install

@NonNull
public static PivotEObjectValidator.ValidationAdapter install(@NonNull
                                                                      org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                                                                      @NonNull
                                                                      MetaModelManager metaModelManager)

Install Complete OCL validation support in resourceSet for metaModelManager.

install

public static void install(@NonNull
                           org.eclipse.emf.ecore.EPackage ePackage)

Install Pivot-defined validation support for ePackage.

getResourceSet

public static org.eclipse.emf.ecore.resource.ResourceSet getResourceSet(@NonNull
                                                                        org.eclipse.emf.ecore.EClassifier eClassifier,
                                                                        @Nullable
                                                                        java.lang.Object object,
                                                                        @Nullable
                                                                        org.eclipse.emf.common.util.DiagnosticChain diagnostics)

Return the user's ResourceSet, preferably as a data element of the diagnostics, corresponding to the original validation context, else from the object else from the eClassifier.

validate

public boolean validate(org.eclipse.emf.ecore.EObject eObject,
                        org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                        java.util.Map<java.lang.Object,java.lang.Object> context)

Specified by:

validate in interface org.eclipse.emf.ecore.EValidator

validate

public boolean validate(org.eclipse.emf.ecore.EClass eClass,
                        org.eclipse.emf.ecore.EObject eObject,
                        org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                        java.util.Map<java.lang.Object,java.lang.Object> context)

Overriden to intercept the validation of an EObject to add the additional Pivot-defined validation.

Specified by:

validate in interface org.eclipse.emf.ecore.EValidator

validate

public boolean validate(org.eclipse.emf.ecore.EDataType eDataType,
                        java.lang.Object value,
                        org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                        java.util.Map<java.lang.Object,java.lang.Object> context)

Overriden to intercept the validation of an EDataType value to add the additional Pivot-defined validation.

Specified by:

validate in interface org.eclipse.emf.ecore.EValidator

validatePivot

protected boolean validatePivot(@NonNull
                                org.eclipse.emf.ecore.EClassifier eClassifier,
                                @Nullable
                                java.lang.Object object,
                                @Nullable
                                org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                java.util.Map<java.lang.Object,java.lang.Object> context)

Perform the additional Pivot-defined validation.