Package org.eclipse.emfforms.internal.core.services.segments.index

Class IndexSegmentConverter

java.lang.Object

org.eclipse.emfforms.internal.core.services.segments.index.IndexSegmentConverter

All Implemented Interfaces:

DomainModelReferenceSegmentConverterEMF

public class IndexSegmentConverter
extends java.lang.Object
implements DomainModelReferenceSegmentConverterEMF

Converts VIndexDomainModelReferenceSegments to value and list properties, and to settings.

Author:

Lucas Koehler

Field Summary

Fields inherited from interface org.eclipse.emfforms.spi.core.services.databinding.emf.DomainModelReferenceSegmentConverterEMF

NOT_APPLICABLE

Constructor Summary

Constructors

Constructor	Description
IndexSegmentConverter()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexSegmentConverter

public IndexSegmentConverter()

Method Detail

isApplicable

public double isApplicable(VDomainModelReferenceSegment segment)

Description copied from interface: DomainModelReferenceSegmentConverterEMF

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.

Specified by:

isApplicable in interface DomainModelReferenceSegmentConverterEMF

Parameters:

segment - The VDomainModelReferenceSegment whose priority is wanted.

Returns:

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

convertToValueProperty

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

Description copied from interface: DomainModelReferenceSegmentConverterEMF

Converts a VDomainModelReferenceSegment to an IValueProperty.

Specified by:

convertToValueProperty in interface DomainModelReferenceSegmentConverterEMF

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

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

Description copied from interface: DomainModelReferenceSegmentConverterEMF

Converts a VDomainModelReferenceSegment to an IListProperty.

Specified by:

convertToListProperty in interface DomainModelReferenceSegmentConverterEMF

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

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

Description copied from interface: DomainModelReferenceSegmentConverterEMF

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

Specified by:

getSetting in interface DomainModelReferenceSegmentConverterEMF

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.