org.eclipse.emf.ecore.util

Class ExtendedMetaDataAnnotationValidator

java.lang.Object

org.eclipse.emf.ecore.util.BasicEAnnotationValidator

org.eclipse.emf.ecore.util.ExtendedMetaDataAnnotationValidator

All Implemented Interfaces:

EAnnotationValidator

public final class ExtendedMetaDataAnnotationValidator
extends BasicEAnnotationValidator

An annotation validator for ExtendedMetadata annotations.

Since:

2.14

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.emf.ecore.util.BasicEAnnotationValidator

BasicEAnnotationValidator.Assistant, BasicEAnnotationValidator.ValidationContext

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

EAnnotationValidator.Descriptor, EAnnotationValidator.Registry

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DIAGNOSTIC_SOURCE
static int	IGNORED_ENTRY
static ExtendedMetaDataAnnotationValidator	INSTANCE
static int	INVALID_VALUE_LITERAL

Fields inherited from class org.eclipse.emf.ecore.util.BasicEAnnotationValidator

annotationName, annotationSource, assistant, diagnosticSource, IGNORED_ANNOTATIONS, IGNORED_CONTENTS, IGNORED_REFERENCES, INVALID_ANNOTATION, INVALID_CONTENT, INVALID_DETAIL_VALUE, INVALID_DUPLICATE, INVALID_LOCATION, INVALID_REFERENCE, INVALID_REFERENCE_LITERAL, MISSING_ENTRY, MISSING_REQUIRED_ENTRY_VALUE, TOO_FEW_VALUES, TOO_MANY_VALUES

Constructor Summary

Constructors

Constructor and Description
ExtendedMetaDataAnnotationValidator()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<?>	filterChoiceOfValues(EObject eObject, EStructuralFeature eStructuralFeature, java.util.Collection<?> choiceOfValues)
protected java.util.List<EClass>	getPropertyClasses(EModelElement eModelElement) Returns the model classes used to represent annotations for the given model element.
protected ResourceLocator	getResourceLocator() Returns the resource locator for fetching implementation-specific messages.
protected EObject	initialize(EObject eObject, EAnnotation eAnnotation) Returns an initialized instance of the given object for the given annotation.
protected boolean	isApplicable(EObject eObject, EStructuralFeature eStructuralFeature) Returns whether the given feature of the given modeled representation is meaningful for the current state of the model.
protected boolean	isValidLocation(EAnnotation eAnnotation, EModelElement eModelElement) Returns whether this annotation contained by this model element is valid at this location.
protected boolean	validateDetails(EAnnotation eAnnotation, EModelElement eModelElement, DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) Returns whether this annotation's details are valid.
protected boolean	validateFeatureDetail(EAnnotation eAnnotation, EModelElement eModelElement, java.util.Map.Entry<java.lang.String,java.lang.String> entry, EStructuralFeature feature, DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) Returns whether the value of this detail entry for the corresponding feature is valid.
protected boolean	validateFeatureDetailValue(EAnnotation eAnnotation, EModelElement eModelElement, java.util.Map.Entry<java.lang.String,java.lang.String> entry, EStructuralFeature feature, java.util.List<java.lang.Object> values, DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) Returns whether the modeled values for this detail entry's corresponding feature are valid.
protected boolean	validateReferenceDetailValueLiteral(EAnnotation eAnnotation, EModelElement eModelElement, java.util.Map.Entry<java.lang.String,java.lang.String> entry, EReference reference, java.lang.String literalValue, java.util.List<java.lang.Object> referenceValues, DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) Returns whether the given literal value is valid with respect to this detail entry's corresponding reference's class.

Methods inherited from class org.eclipse.emf.ecore.util.BasicEAnnotationValidator

convertPropertyAttributeValueToLiteralItem, convertPropertyReferenceValueToLiteralItem, convertPropertyValueToLiteral, convertPropertyValueToLiteralItem, createAssistant, createDiagnostic, createInstance, createValueDiagnostic, getAllValidAnnotations, getAnnotationSource, getAssistant, getEcoreResourceLocator, getProperties, getRootEValidator, getString, getValidAnnotations, getValidContents, getValidLocationDescription, getValidReferences, isAnnotationsSupported, isContentsSupported, isDuplicateValid, isIncludedProperty, isReferencesSupported, isValidLocation, join, loadEPackage, reportDuplicate, reportIgnoredAnnotations, reportIgnoredContents, reportIgnoredEntry, reportIgnoredReferences, reportInvalidAnnotation, reportInvalidContent, reportInvalidLocation, reportInvalidReference, reportInvalidReferenceLiteral, reportInvalidValueLiteral, reportMissingEntry, reportMissingRequiredEntryValue, reportTooFewValues, reportTooManyValues, split, validate, validateAnnotations, validateAttributeDetailLiteralValue, validateAttributeDetailValueLiteral, validateContents, validateDetail, validateReferenceDetailLiteralValue, validateReferences

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ExtendedMetaDataAnnotationValidator INSTANCE

DIAGNOSTIC_SOURCE

public static final java.lang.String DIAGNOSTIC_SOURCE

See Also:

Constant Field Values

INVALID_VALUE_LITERAL

public static final int INVALID_VALUE_LITERAL

See Also:

SpecializedExtendedMetaData#reportBadValue(Object, DiagnosticChain, int, String, Object...), Constant Field Values

IGNORED_ENTRY

public static final int IGNORED_ENTRY

See Also:

SpecializedExtendedMetaData#reportIgnoredEntry(Map.Entry, DiagnosticChain, String, Object...), Constant Field Values

Constructor Detail

ExtendedMetaDataAnnotationValidator

public ExtendedMetaDataAnnotationValidator()

Method Detail

getResourceLocator

protected ResourceLocator getResourceLocator()

Description copied from class: BasicEAnnotationValidator

Returns the resource locator for fetching implementation-specific messages.

Specified by:

getResourceLocator in class BasicEAnnotationValidator

Returns:

the resource locator for fetching model-specific messages.

initialize

protected EObject initialize(EObject eObject,
                             EAnnotation eAnnotation)

Description copied from class: BasicEAnnotationValidator

Returns an initialized instance of the given object for the given annotation.

This implementation handles only the case of modeled attributes. For each detail entry, it looks up the corresponding property via the key. If it's not an EAttribute it will throw an UnsupportedOperationException. If the attribute property is multi-valued, it splits the detail entry value, and converts each literal item into a value of the attribute's data type. If it's single-valued, the literal value is directly converted to the attributes data type. The resulting list value or single value is reflectively set into the instance. If the model representation includes references, an annotation validator implementation must specialize this method for the assistant to function correctly.

Overrides:

initialize in class BasicEAnnotationValidator

Parameters:

eObject - the object to initialize.

eAnnotation - the annotation used to initialize the object.

Returns:

an initialized instance.

isApplicable

protected boolean isApplicable(EObject eObject,
                               EStructuralFeature eStructuralFeature)

Description copied from class: BasicEAnnotationValidator

Returns whether the given feature of the given modeled representation is meaningful for the current state of the model.

This method is used to induce the applicable properties by the assistant. It is not directly used by the annotation validator itself. This implementation always returns true.

Overrides:

isApplicable in class BasicEAnnotationValidator

Parameters:

eObject - the modeled object in question.

eStructuralFeature - a feature of that object.

Returns:

whether the given feature of the given modeled representation is meaningful for the current state of the model.

isValidLocation

protected boolean isValidLocation(EAnnotation eAnnotation,
                                  EModelElement eModelElement)

Description copied from class: BasicEAnnotationValidator

Returns whether this annotation contained by this model element is valid at this location.

This implementation returns false if the element is not a named element. It's typically the case that annotations on annotations aren't meaningful and valid.

Overrides:

isValidLocation in class BasicEAnnotationValidator

Parameters:

eAnnotation - the annotation in question.

eModelElement - the annotation's containing model element.

Returns:

whether this annotation contained by this model element is valid at this location.

See Also:

BasicEAnnotationValidator.isValidLocation(EAnnotation), BasicEAnnotationValidator.validate(EAnnotation, DiagnosticChain, Map)

getPropertyClasses

protected java.util.List<EClass> getPropertyClasses(EModelElement eModelElement)

Description copied from class: BasicEAnnotationValidator

Returns the model classes used to represent annotations for the given model element.

Typically an annotation validator implementation will return a single class. An induced user interface will generally require the ability to create instances of the classes returned by this method. The annotation validator implementation itself does not require that ability.

Specified by:

getPropertyClasses in class BasicEAnnotationValidator

Parameters:

eModelElement - the model element in question.

Returns:

the model classes used to represent annotations for the given model element.

validateDetails

protected boolean validateDetails(EAnnotation eAnnotation,
                                  EModelElement eModelElement,
                                  DiagnosticChain diagnostics,
                                  java.util.Map<java.lang.Object,java.lang.Object> context)

Description copied from class: BasicEAnnotationValidator

Returns whether this annotation's details are valid.

This implementation uses the properties of the model element. For each detail, it determines whether there is a corresponding feature in the properties. If not, it validates the detail without a property feature. If so, it validates the detail with the property feature. If all the details are valid, it will check whether any required property feature is absent from the details and reports it missing.

Overrides:

validateDetails in class BasicEAnnotationValidator

Parameters:

eAnnotation - the annotation in question.

eModelElement - the annotation's containing model element.

diagnostics - a place to accumulate diagnostics; if it's null, no diagnostics should be produced.

context - a place to cache information, if it's null, no cache is supported.

Returns:

whether this annotation's details are valid.

validateFeatureDetail

protected boolean validateFeatureDetail(EAnnotation eAnnotation,
                                        EModelElement eModelElement,
                                        java.util.Map.Entry<java.lang.String,java.lang.String> entry,
                                        EStructuralFeature feature,
                                        DiagnosticChain diagnostics,
                                        java.util.Map<java.lang.Object,java.lang.Object> context)

Description copied from class: BasicEAnnotationValidator

Returns whether the value of this detail entry for the corresponding feature is valid.

This implementation delegates to validateAttributeDetail or to validateReferenceDetail depending on whether the feature is an EAttribute or an EReference. It creates a place holder diagnostic that it passed to those methods, so all diagnostics gathered by those methods are grouped as children of the placeholder. Both those methods build the corresponding modeled values as a side-effect. If the detail entry is otherwise valid, the modeled value is validated.

Overrides:

validateFeatureDetail in class BasicEAnnotationValidator

Parameters:

eAnnotation - the annotation in question.

eModelElement - the annotation's containing model element.

entry - the annotation detail in question.

feature - the property associated with entry.

diagnostics - a place to accumulate diagnostics; if it's null, no diagnostics should be produced.

context - a place to cache information, if it's null, no cache is supported.

Returns:

whether the value of this detail entry for the corresponding feature is valid.

validateReferenceDetailValueLiteral

protected boolean validateReferenceDetailValueLiteral(EAnnotation eAnnotation,
                                                      EModelElement eModelElement,
                                                      java.util.Map.Entry<java.lang.String,java.lang.String> entry,
                                                      EReference reference,
                                                      java.lang.String literalValue,
                                                      java.util.List<java.lang.Object> referenceValues,
                                                      DiagnosticChain diagnostics,
                                                      java.util.Map<java.lang.Object,java.lang.Object> context)

Description copied from class: BasicEAnnotationValidator

Returns whether the given literal value is valid with respect to this detail entry's corresponding reference's class. As a side-effect, if the literal value can be converted to an instance value, the corresponding instance value is added to the list of reference values.

This implementation always returns false and reports an invalid reference literal. An annotation validator implementation that supports reference literals must specialize this method.

Overrides:

validateReferenceDetailValueLiteral in class BasicEAnnotationValidator

Parameters:

eAnnotation - the annotation in question.

eModelElement - the annotation's containing model element.

entry - the annotation detail in question.

reference - the reference property associated with entry.

literalValue - the literal value of the class.

referenceValues - the list in which to accumulate valid instance values.

diagnostics - a place to accumulate diagnostics; if it's null, no diagnostics should be produced.

context - a place to cache information, if it's null, no cache is supported.

Returns:

whether the given literal value is valid with respect to this detail entry's corresponding references's class.

validateFeatureDetailValue

protected boolean validateFeatureDetailValue(EAnnotation eAnnotation,
                                             EModelElement eModelElement,
                                             java.util.Map.Entry<java.lang.String,java.lang.String> entry,
                                             EStructuralFeature feature,
                                             java.util.List<java.lang.Object> values,
                                             DiagnosticChain diagnostics,
                                             java.util.Map<java.lang.Object,java.lang.Object> context)

Description copied from class: BasicEAnnotationValidator

Returns whether the modeled values for this detail entry's corresponding feature are valid.

For a many-valued feature, it validates that the lower and upper bounds are respected. For a singled valued feature that is required, it validates that the value is present; in the single-valued case, the values list should contain a single value.

Overrides:

validateFeatureDetailValue in class BasicEAnnotationValidator

Parameters:

eAnnotation - the annotation in question.

eModelElement - the annotation's containing model element.

entry - the annotation detail in question.

feature - the property associated with entry.

values - the list of instance values for this entry.

diagnostics - a place to accumulate diagnostics; if it's null, no diagnostics should be produced.

context - a place to cache information, if it's null, no cache is supported.

Returns:

whether the modeled values for this detail entry's corresponding feature are valid.

filterChoiceOfValues

public java.util.Collection<?> filterChoiceOfValues(EObject eObject,
                                                    EStructuralFeature eStructuralFeature,
                                                    java.util.Collection<?> choiceOfValues)