org.eclipse.ocl.examples.emf.validation.validity.locator

Class AbstractConstraintLocator

java.lang.Object

org.eclipse.ocl.examples.emf.validation.validity.locator.AbstractConstraintLocator

All Implemented Interfaces:

ConstraintLocator, ConstraintLocator.Descriptor

Direct Known Subclasses:

AbstractPivotConstraintLocator, EClassConstraintLocator, EClassifierConstraintLocator, EValidatorConstraintLocator, PivotConstraintLocator

public abstract class AbstractConstraintLocator
extends java.lang.Object
implements ConstraintLocator, ConstraintLocator.Descriptor

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ocl.examples.emf.validation.validity.locator.ConstraintLocator

ConstraintLocator.Descriptor

Constructor Summary

Constructors

Constructor and Description
AbstractConstraintLocator()

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<org.eclipse.emf.ecore.EObject,java.util.List<LeafConstrainingNode>>	createLeafConstrainingNode(java.util.Map<org.eclipse.emf.ecore.EObject,java.util.List<LeafConstrainingNode>> map, ValidityModel validityModel, org.eclipse.emf.ecore.EObject constrainingType, java.lang.Object constrainingObject, java.lang.String label)
java.util.Set<TypeURI>	getAllTypes(ValidityManager validityManager, org.eclipse.emf.ecore.EObject constrainingObject) Return all typeURIs for a given type; typically this returns the supertype closure.
org.eclipse.emf.ecore.EObject	getConstrainingType(org.eclipse.emf.ecore.EObject constrainedType, java.lang.Object constrainingObject) Return the RH constraining type that supplies the constrainingObject to the constrainedType.
ConstrainingURI	getConstrainingURI(org.eclipse.emf.ecore.EObject eObject) Return the URI that provides a distinct identity for a constraining element in the constraining elements view.
ConstraintLocator	getConstraintLocator() Return the ConstraintLocator described by this.
java.lang.Object	getImage() Return an icon to identify this kind of ConstraintLocator.
java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getImports(org.eclipse.emf.ecore.EPackage ePackage, org.eclipse.emf.ecore.resource.Resource resource) Return any resources imported from within resource.
java.lang.String	getLabel(org.eclipse.emf.ecore.EModelElement eObject) Return a diagnostic label for eObject.
protected Severity	getSeverity(org.eclipse.emf.common.util.Diagnostic diagnostic)
java.lang.String	getSourceExpression(LeafConstrainingNode node) Return the source representation of the Constraint.
org.eclipse.emf.ecore.resource.Resource	getSourceResource(LeafConstrainingNode node) Return the Resource from which the Constraint was obtained.
TypeURI	getTypeURI(org.eclipse.emf.ecore.EObject eObject) Return the URI that provides a distinct identity for a constraining element when applied to a validatable element.
java.util.Set<TypeURI>	getTypeURIs(ValidityManager validityManager, org.eclipse.emf.ecore.EObject validatableObject) Return the type URIs of all 'types' that provide constraints for validatableObject.
static void	initialize() Perform the standalone initialization of the ValidityManager constraint locator registry with all EMF-only ConstraintLocators.
java.lang.String	toString()
void	validate(Result result, ValidityManager validityManager, org.eclipse.emf.common.util.Monitor monitor) Update the validation result to include the verdict of the validation using validityManager to provide shared services.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ocl.examples.emf.validation.validity.locator.ConstraintLocator

getConstraints, getInstance, getName

Constructor Detail

AbstractConstraintLocator

public AbstractConstraintLocator()

Method Detail

initialize

public static void initialize()

Perform the standalone initialization of the ValidityManager constraint locator registry with all EMF-only ConstraintLocators. (Use AbstractPivotConstraintLocator.initalize() for UML and OCL constraint locators as well.)

createLeafConstrainingNode

@NonNull
protected java.util.Map<org.eclipse.emf.ecore.EObject,java.util.List<LeafConstrainingNode>> createLeafConstrainingNode(@Nullable
                                                                                                                                 java.util.Map<org.eclipse.emf.ecore.EObject,java.util.List<LeafConstrainingNode>> map,
                                                                                                                                 @NonNull
                                                                                                                                 ValidityModel validityModel,
                                                                                                                                 @NonNull
                                                                                                                                 org.eclipse.emf.ecore.EObject constrainingType,
                                                                                                                                 @NonNull
                                                                                                                                 java.lang.Object constrainingObject,
                                                                                                                                 @NonNull
                                                                                                                                 java.lang.String label)

getAllTypes

@NonNull
public java.util.Set<TypeURI> getAllTypes(@NonNull
                                                    ValidityManager validityManager,
                                                    @NonNull
                                                    org.eclipse.emf.ecore.EObject constrainingObject)

Description copied from interface: ConstraintLocator

Return all typeURIs for a given type; typically this returns the supertype closure.

Specified by:

getAllTypes in interface ConstraintLocator

getConstrainingType

@NonNull
public org.eclipse.emf.ecore.EObject getConstrainingType(@NonNull
                                                                   org.eclipse.emf.ecore.EObject constrainedType,
                                                                   @NonNull
                                                                   java.lang.Object constrainingObject)

Description copied from interface: ConstraintLocator

Return the RH constraining type that supplies the constrainingObject to the constrainedType.

This just return constrainedType unless the RH pane has additional type information.

Specified by:

getConstrainingType in interface ConstraintLocator

getConstrainingURI

@Nullable
public ConstrainingURI getConstrainingURI(@NonNull
                                                     org.eclipse.emf.ecore.EObject eObject)

Description copied from interface: ConstraintLocator

Return the URI that provides a distinct identity for a constraining element in the constraining elements view.

Specified by:

getConstrainingURI in interface ConstraintLocator

getConstraintLocator

@NonNull
public ConstraintLocator getConstraintLocator()

Description copied from interface: ConstraintLocator.Descriptor

Return the ConstraintLocator described by this.

Specified by:

getConstraintLocator in interface ConstraintLocator.Descriptor

getImage

@Nullable
public java.lang.Object getImage()

Description copied from interface: ConstraintLocator

Return an icon to identify this kind of ConstraintLocator.

Specified by:

getImage in interface ConstraintLocator

getImports

@Nullable
public java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getImports(@NonNull
                                                                                           org.eclipse.emf.ecore.EPackage ePackage,
                                                                                           @NonNull
                                                                                           org.eclipse.emf.ecore.resource.Resource resource)

Description copied from interface: ConstraintLocator

Return any resources imported from within resource.

Specified by:

getImports in interface ConstraintLocator

getLabel

@NonNull
public java.lang.String getLabel(@NonNull
                                           org.eclipse.emf.ecore.EModelElement eObject)

Description copied from interface: ConstraintLocator

Return a diagnostic label for eObject.

Specified by:

getLabel in interface ConstraintLocator

getSeverity

@NonNull
protected Severity getSeverity(@NonNull
                                         org.eclipse.emf.common.util.Diagnostic diagnostic)

getSourceExpression

@Nullable
public java.lang.String getSourceExpression(@NonNull
                                                       LeafConstrainingNode node)

Description copied from interface: ConstraintLocator

Return the source representation of the Constraint. Returns null if none available.

Specified by:

getSourceExpression in interface ConstraintLocator

getSourceResource

@Nullable
public org.eclipse.emf.ecore.resource.Resource getSourceResource(@NonNull
                                                                            LeafConstrainingNode node)

Description copied from interface: ConstraintLocator

Return the Resource from which the Constraint was obtained. Returns null if none available.

Specified by:

getSourceResource in interface ConstraintLocator

getTypeURI

@Nullable
public TypeURI getTypeURI(@NonNull
                                     org.eclipse.emf.ecore.EObject eObject)

Description copied from interface: ConstraintLocator

Return the URI that provides a distinct identity for a constraining element when applied to a validatable element. This is not necessarily unique in the constraining elements view since multiple constraining models may contribute constraints to the same type.

Specified by:

getTypeURI in interface ConstraintLocator

getTypeURIs

@Nullable
public java.util.Set<TypeURI> getTypeURIs(@NonNull
                                                     ValidityManager validityManager,
                                                     @NonNull
                                                     org.eclipse.emf.ecore.EObject validatableObject)

Description copied from interface: ConstraintLocator

Return the type URIs of all 'types' that provide constraints for validatableObject.

Specified by:

getTypeURIs in interface ConstraintLocator

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validate

public void validate(@NonNull
                     Result result,
                     @NonNull
                     ValidityManager validityManager,
                     @Nullable
                     org.eclipse.emf.common.util.Monitor monitor)

Description copied from interface: ConstraintLocator

Update the validation result to include the verdict of the validation using validityManager to provide shared services.

Specified by:

validate in interface ConstraintLocator