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

Class MappingSegmentExpander

java.lang.Object

org.eclipse.emfforms.internal.core.services.segments.mapping.MappingSegmentExpander

All Implemented Interfaces:

EMFFormsDMRSegmentExpander

public class MappingSegmentExpander
extends java.lang.Object
implements EMFFormsDMRSegmentExpander

An EMFFormsDMRSegmentExpander for VMappingDomainModelReferenceSegments.

Author:

Lucas Koehler

Field Summary

Fields inherited from interface org.eclipse.emfforms.spi.core.services.domainexpander.EMFFormsDMRSegmentExpander

NOT_APPLICABLE

Constructor Summary

Constructors

Constructor	Description
MappingSegmentExpander()

Method Summary

Modifier and Type	Method	Description
double	isApplicable(VDomainModelReferenceSegment segment)	Returns how suitable this EMFFormsDMRSegmentExpander is for the given VDomainModelReferenceSegment.
boolean	needsToExpandLastSegment()	Returns whether a supported segment needs to be expanded when it is the last segment of a VDomainModelReferenceSegment.
java.util.Optional<org.eclipse.emf.ecore.EObject>	prepareDomainObject(VDomainModelReferenceSegment segment, org.eclipse.emf.ecore.EObject domainObject)	Prepares a domain object for the given VDomainModelReferenceSegment.
protected void	setReportService(ReportService reportService)	Called by the framework to set the ReportService.

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingSegmentExpander

public MappingSegmentExpander()

Method Detail

setReportService

protected void setReportService(ReportService reportService)

Called by the framework to set the ReportService.

Parameters:

reportService - The ReportService

isApplicable

public double isApplicable(VDomainModelReferenceSegment segment)

Returns how suitable this EMFFormsDMRSegmentExpander is for the given VDomainModelReferenceSegment.

Specified by:

isApplicable in interface EMFFormsDMRSegmentExpander

Parameters:

segment - The VDomainModelReferenceSegment for which an domain object should be prepared.

Returns:

a value indicating how suitable this EMFFormsDMRSegmentExpander is to expand a domain object for the given VDomainModelReferenceSegment. Returns NOT_APPLICABLE if it's not applicable.

See Also:

EMFFormsDMRSegmentExpander.isApplicable(org.eclipse.emf.ecp.view.spi.model.VDomainModelReferenceSegment)

prepareDomainObject

public java.util.Optional<org.eclipse.emf.ecore.EObject> prepareDomainObject(VDomainModelReferenceSegment segment,
                                                                             org.eclipse.emf.ecore.EObject domainObject)
                                                                      throws EMFFormsExpandingFailedException

Prepares a domain object for the given VDomainModelReferenceSegment. Thereby, the feature defined by the segment is analyzed and if it is a reference, the missing target object will be created. Thereby, the segment is not changed. The target of the segment's feature is returned. This is the created EObject if it was created by this method or the already existing target of the segment's feature.

Example:
DMR: A -a-> B
The domain model is instance of A but does not reference an instance of B. The segment contains the feature 'a'.
=> An instance of B is created and referenced by the domain model. B is returned by this expander.

Specified by:

prepareDomainObject in interface EMFFormsDMRSegmentExpander

Parameters:

segment - The VDomainModelReferenceSegment for which the domain object should be prepared.

domainObject - The domain object to prepare.

Returns:

The new target of the segment's feature. If an EObject was created, it is returned, otherwise the already existing target is returned. May return nothing. If the given segment was not the DMR's last segment, this causes the DMR expansion process to fail.

Throws:

EMFFormsExpandingFailedException - if the domain expansion fails.

See Also:

EMFFormsDMRSegmentExpander.prepareDomainObject(org.eclipse.emf.ecp.view.spi.model.VDomainModelReferenceSegment, org.eclipse.emf.ecore.EObject)

needsToExpandLastSegment

public boolean needsToExpandLastSegment()

Returns whether a supported segment needs to be expanded when it is the last segment of a VDomainModelReferenceSegment.

Specified by:

needsToExpandLastSegment in interface EMFFormsDMRSegmentExpander

Returns:

Whether the last segment needs to be expanded

See Also:

EMFFormsDMRSegmentExpander.needsToExpandLastSegment()