org.eclipse.ocl.examples.validity.locator

Class PivotConstraintLocator

java.lang.Object

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

org.eclipse.ocl.examples.validity.locator.PivotConstraintLocator

All Implemented Interfaces:

ConstraintLocator, ConstraintLocator.Descriptor

Direct Known Subclasses:

CompleteOCLCSConstraintLocator, PivotUIConstraintLocator

public class PivotConstraintLocator
extends AbstractConstraintLocator

Nested Class Summary

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

ConstraintLocator.Descriptor

Field Summary

Fields

Modifier and Type	Field and Description
static PivotConstraintLocator	INSTANCE

Constructor Summary

Constructors

Constructor and Description
PivotConstraintLocator()

Method Summary

Modifier and Type	Method and Description
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.
protected org.eclipse.emf.ecore.EObject	getConstrainedESObject(EnvironmentFactory environmentFactory, Constraint asConstraint)
java.util.Map<org.eclipse.emf.ecore.EObject,java.util.List<LeafConstrainingNode>>	getConstraints(ValidityModel validityModel, org.eclipse.emf.ecore.EPackage ePackage, java.util.Set<org.eclipse.emf.ecore.resource.Resource> resources, org.eclipse.emf.common.util.Monitor monitor) Return a constrainedType-to-constraint map for all types in the given resources that have an ePackage whose URI complies with the registration of this ConstraintLocator.
java.lang.Object	getImage() Return an icon to identify this kind of ConstraintLocator.
ConstraintLocator	getInstance() Return the singleton instance of this ConstraintLocator to avoid duplicate registrations.
java.lang.String	getName() Return a descriptive name for this kind of constraint.
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 constrainedObject) Return the URI that provides a distinct identity for a constraining element when applied to a validatable element.
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 org.eclipse.ocl.examples.emf.validation.validity.locator.AbstractConstraintLocator

createLeafConstrainingNode, getConstrainingType, getConstrainingURI, getConstraintLocator, getImports, getLabel, getSeverity, getTypeURIs, initialize, toString

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

@NonNull
public static PivotConstraintLocator INSTANCE

Constructor Detail

PivotConstraintLocator

public PivotConstraintLocator()

Method Detail

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

Overrides:

getAllTypes in class AbstractConstraintLocator

getConstrainedESObject

protected org.eclipse.emf.ecore.EObject getConstrainedESObject(@NonNull
                                                               EnvironmentFactory environmentFactory,
                                                               @NonNull
                                                               Constraint asConstraint)

getConstraints

@Nullable
public java.util.Map<org.eclipse.emf.ecore.EObject,java.util.List<LeafConstrainingNode>> getConstraints(@NonNull
                                                                                                                   ValidityModel validityModel,
                                                                                                                   @NonNull
                                                                                                                   org.eclipse.emf.ecore.EPackage ePackage,
                                                                                                                   @NonNull
                                                                                                                   java.util.Set<org.eclipse.emf.ecore.resource.Resource> resources,
                                                                                                                   @NonNull
                                                                                                                   org.eclipse.emf.common.util.Monitor monitor)

Description copied from interface: ConstraintLocator

Return a constrainedType-to-constraint map for all types in the given resources that have an ePackage whose URI complies with the registration of this ConstraintLocator. The validityModel is used to create the LeafConstrainingNodes for each constraint.

getImage

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

Overrides:

getImage in class AbstractConstraintLocator

getInstance

@NonNull
public ConstraintLocator getInstance()

Description copied from interface: ConstraintLocator

Return the singleton instance of this ConstraintLocator to avoid duplicate registrations.

getName

@NonNull
public java.lang.String getName()

Description copied from interface: ConstraintLocator

Return a descriptive name for this kind of constraint.

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

Overrides:

getSourceExpression in class AbstractConstraintLocator

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

Overrides:

getSourceResource in class AbstractConstraintLocator

getTypeURI

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

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

Overrides:

getTypeURI in class AbstractConstraintLocator

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

Overrides:

validate in class AbstractConstraintLocator