org.eclipse.emfforms.spi.core.services.domainexpander

Interface EMFFormsDMRExpander

All Known Implementing Classes:

EMFFormsCustomDMRExpander, EMFFormsDMRExpanderDefaultHeuristic, EMFFormsIndexDMRExpander, EMFFormsKeyAttributeDMRExpander, EMFFormsMappingDMRExpander, EMFFormsTableDMRExpander

public interface EMFFormsDMRExpander

This service offers the method prepareDomainObject(VDomainModelReference, EObject) that allows to expand a given domain object for a VDomainModelReference. The method isApplicable(VDomainModelReference) is used to determine how suitable this service is for a certain VDomainModelReference.

Note: This interface is not intended for public use but defines the services which are internally used in the EMFFormsDomainExpander.

Since:

1.7

Author:

Lucas Koehler

Field Summary

Fields

Modifier and Type	Field and Description
static Double	NOT_APPLICABLE This value is returned by isApplicable(VDomainModelReference) if the EMFFormsDMRExpander is not applicable for the given VDomainModelReference and domain object.

Method Summary

Modifier and Type	Method and Description
double	isApplicable(VDomainModelReference domainModelReference) Returns how suitable this EMFFormsDMRExpander is for the given VDomainModelReference.
void	prepareDomainObject(VDomainModelReference domainModelReference, org.eclipse.emf.ecore.EObject domainObject) Prepares a domain object for the given VDomainModelReference.

Field Detail

NOT_APPLICABLE

static final Double NOT_APPLICABLE

This value is returned by isApplicable(VDomainModelReference) if the EMFFormsDMRExpander is not applicable for the given VDomainModelReference and domain object.

Method Detail

prepareDomainObject

void prepareDomainObject(VDomainModelReference domainModelReference,
                         org.eclipse.emf.ecore.EObject domainObject)
                  throws EMFFormsExpandingFailedException

Prepares a domain object for the given VDomainModelReference. Thereby, the path defined by the VDomainModelReference is analyzed and missing objects in the domain model are created. Thereby, the VDomainModelReference is not changed.

Example:
DMR: A -> B -> x
domain model is instance of A but does not reference an instance of B
=> An instance of B is created and referenced by the domain model.

Parameters:

domainModelReference - The VDomainModelReference for which the domain object should be prepared.

domainObject - The domain object to prepare.

Throws:

EMFFormsExpandingFailedException - if the domain expansion fails.

isApplicable

double isApplicable(VDomainModelReference domainModelReference)

Returns how suitable this EMFFormsDMRExpander is for the given VDomainModelReference.

Parameters:

domainModelReference - The VDomainModelReference for which a domain object should be prepared.

Returns:

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