Package org.eclipse.emfforms.spi.core.services.databinding.emf

Interface DomainModelReferenceSegmentConverterEMF

All Known Implementing Classes:

FeatureSegmentConverter, IndexSegmentConverter, MappingSegmentConverter, MultiSegmentConverter

public interface DomainModelReferenceSegmentConverterEMF

Converts a VDomainModelReferenceSegment to an IEMFValueProperty or an IEMFListProperty.

Since:

1.19

Author:

Lucas Koehler

Field Summary

Fields

Modifier and Type	Field	Description
static double	NOT_APPLICABLE	The constant defining the priority that a DomainModelReferenceSegmentConverterEMF is not suitable for a VDomainModelReferenceSegment.

Method Summary

Modifier and Type	Method	Description
SegmentConverterListResultEMF	convertToListProperty(VDomainModelReferenceSegment segment, org.eclipse.emf.ecore.EClass segmentRoot, org.eclipse.emf.edit.domain.EditingDomain editingDomain)	Converts a VDomainModelReferenceSegment to an IListProperty.
SegmentConverterValueResultEMF	convertToValueProperty(VDomainModelReferenceSegment segment, org.eclipse.emf.ecore.EClass segmentRoot, org.eclipse.emf.edit.domain.EditingDomain editingDomain)	Converts a VDomainModelReferenceSegment to an IValueProperty.
org.eclipse.emf.ecore.EStructuralFeature.Setting	getSetting(VDomainModelReferenceSegment segment, org.eclipse.emf.ecore.EObject eObject)	Retrieve the Setting which is described by the provided VDomainModelReferenceSegment and the provided EObject.
double	isApplicable(VDomainModelReferenceSegment segment)	Checks whether the given VDomainModelReferenceSegment can be converted by this DomainModelReferenceSegmentConverterEMF to an IValueProperty or an IListProperty.

Field Detail

NOT_APPLICABLE

static final double NOT_APPLICABLE

The constant defining the priority that a DomainModelReferenceSegmentConverterEMF is not suitable for a VDomainModelReferenceSegment.

See Also:

Constant Field Values

Method Detail

isApplicable

double isApplicable(VDomainModelReferenceSegment segment)

Checks whether the given VDomainModelReferenceSegment can be converted by this DomainModelReferenceSegmentConverterEMF to an IValueProperty or an IListProperty. The return value is the priority of this converter. The higher the priority, the better the converter suits the given VDomainModelReferenceSegment.

Parameters:

segment - The VDomainModelReferenceSegment whose priority is wanted.

Returns:

The priority of the given VDomainModelReferenceSegment; negative infinity if this converter is not applicable.

convertToValueProperty

SegmentConverterValueResultEMF convertToValueProperty(VDomainModelReferenceSegment segment,
                                                      org.eclipse.emf.ecore.EClass segmentRoot,
                                                      org.eclipse.emf.edit.domain.EditingDomain editingDomain)
                                               throws DatabindingFailedException

Converts a VDomainModelReferenceSegment to an IValueProperty.

Parameters:

segment - The VDomainModelReferenceSegment that will be converted to an IValueProperty

segmentRoot - The root EClass of the segment used to resolve the segment to an EStructuralFeature. This means the EClass has to contain the feature used in the segment

editingDomain - The EditingDomain in which the IEMFValueProperty is created

Returns:

The SegmentConverterValueResultEMF with the created IEMFValueProperty, does not return null

Throws:

DatabindingFailedException - if no value property could be created

convertToListProperty

SegmentConverterListResultEMF convertToListProperty(VDomainModelReferenceSegment segment,
                                                    org.eclipse.emf.ecore.EClass segmentRoot,
                                                    org.eclipse.emf.edit.domain.EditingDomain editingDomain)
                                             throws DatabindingFailedException

Converts a VDomainModelReferenceSegment to an IListProperty.

Parameters:

segment - The VDomainModelReferenceSegment that will be converted to an IValueProperty

segmentRoot - The root EClass of the segment used to resolve the segment to an EStructuralFeature. This means the EClass has to contain the feature used in the segment

editingDomain - The EditingDomain in which the IEMFValueProperty is created

Returns:

The SegmentConverterListResultEMF with the created IEMFListProperty, does not return null

Throws:

DatabindingFailedException - if no value property could be created

getSetting

org.eclipse.emf.ecore.EStructuralFeature.Setting getSetting(VDomainModelReferenceSegment segment,
                                                            org.eclipse.emf.ecore.EObject eObject)
                                                     throws DatabindingFailedException

Retrieve the Setting which is described by the provided VDomainModelReferenceSegment and the provided EObject.

Parameters:

segment - The VDomainModelReferenceSegment to use to retrieve the setting

eObject - The EObject to use to retrieve the setting. This EObject must have the same EClass as the feature used in the segment

Returns:

The Setting being described by the segment and EObject

Throws:

DatabindingFailedException - if the databinding could not be executed successfully.