Package org.eclipse.emf.ecp.view.spi.custom.model.impl

Class CustomDMRConverter

java.lang.Object

org.eclipse.emf.ecp.view.spi.custom.model.impl.CustomDMRConverter

All Implemented Interfaces:

DomainModelReferenceConverter, DomainModelReferenceConverterEMF

public class CustomDMRConverter
extends java.lang.Object
implements DomainModelReferenceConverterEMF

DomainModelReferenceConverter for CustomDomainModelReferences.

Since:

1.6

Author:

Eugen Neufeld

Field Summary

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

NOT_APPLICABLE

Constructor Summary

Constructors

Constructor	Description
CustomDMRConverter()

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.framework.BundleContext bundleContext)	This method is called by the OSGI framework when this DomainModelReferenceConverterEMF is activated.
org.eclipse.emf.databinding.IEMFListProperty	convertToListProperty(VDomainModelReference domainModelReference, org.eclipse.emf.ecore.EObject object)	Converts a VDomainModelReference to an IListProperty.
org.eclipse.emf.databinding.IEMFValueProperty	convertToValueProperty(VDomainModelReference domainModelReference, org.eclipse.emf.ecore.EClass rootEClass, org.eclipse.emf.edit.domain.EditingDomain editingDomain)	Converts a VDomainModelReference to a IValueProperty which uses the given EditingDomain.
org.eclipse.emf.databinding.IEMFValueProperty	convertToValueProperty(VDomainModelReference domainModelReference, org.eclipse.emf.ecore.EObject object)	Converts a VDomainModelReference to a IValueProperty.
protected void	deactivate(org.osgi.framework.BundleContext bundleContext)	This method is called by the OSGI framework when this DomainModelReferenceConverterEMF is deactivated.
org.eclipse.emf.ecore.EStructuralFeature.Setting	getSetting(VDomainModelReference domainModelReference, org.eclipse.emf.ecore.EObject object)	Retrieve the Setting which is described by the provided VDomainModelReference and the provided EObject.
double	isApplicable(VDomainModelReference domainModelReference)	Checks whether the given VDomainModelReference can be converted by this DomainModelReferenceConverter to a IValueProperty.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomDMRConverter

public CustomDMRConverter()

Method Detail

activate

protected final void activate(org.osgi.framework.BundleContext bundleContext)

This method is called by the OSGI framework when this DomainModelReferenceConverterEMF is activated. It retrieves the EMF Forms databinding service.

Parameters:

bundleContext - The BundleContext of this classes bundle.

deactivate

protected final void deactivate(org.osgi.framework.BundleContext bundleContext)

This method is called by the OSGI framework when this DomainModelReferenceConverterEMF is deactivated. It frees the EMF Forms databinding service.

Parameters:

bundleContext - The BundleContext of this classes bundle.

isApplicable

public double isApplicable(VDomainModelReference domainModelReference)

Description copied from interface: DomainModelReferenceConverter

Checks whether the given VDomainModelReference can be converted by this DomainModelReferenceConverter to a IValueProperty. The return value is the priority of this converter. The higher the priority, the better suits the converter the given VDomainModelReference.

Specified by:

isApplicable in interface DomainModelReferenceConverter

Parameters:

domainModelReference - The VDomainModelReference whose priority is wanted.

Returns:

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

convertToValueProperty

public org.eclipse.emf.databinding.IEMFValueProperty convertToValueProperty(VDomainModelReference domainModelReference,
                                                                            org.eclipse.emf.ecore.EObject object)
                                                                     throws DatabindingFailedException

Description copied from interface: DomainModelReferenceConverter

Converts a VDomainModelReference to a IValueProperty.

Specified by:

convertToValueProperty in interface DomainModelReferenceConverter

Specified by:

convertToValueProperty in interface DomainModelReferenceConverterEMF

Parameters:

domainModelReference - The VDomainModelReference that will be converted to a IValueProperty

object - The root object of the rendered form

Returns:

The created IValueProperty, does not return null.

Throws:

DatabindingFailedException - if no value property could be created due to an invalid VDomainModelReference.

convertToValueProperty

public org.eclipse.emf.databinding.IEMFValueProperty convertToValueProperty(VDomainModelReference domainModelReference,
                                                                            org.eclipse.emf.ecore.EClass rootEClass,
                                                                            org.eclipse.emf.edit.domain.EditingDomain editingDomain)
                                                                     throws DatabindingFailedException

Description copied from interface: DomainModelReferenceConverterEMF

Converts a VDomainModelReference to a IValueProperty which uses the given EditingDomain.

Specified by:

convertToValueProperty in interface DomainModelReferenceConverterEMF

Parameters:

domainModelReference - The VDomainModelReference that will be converted to a IValueProperty

rootEClass - The root EClass of the given VDomainModelReference

editingDomain - The EditingDomain used by the created value property. The EditingDomain might be null but in this case the value property will not support set functionality

Returns:

The created IValueProperty, does not return null.

Throws:

DatabindingFailedException - if no value property could be created due to an invalid VDomainModelReference.

convertToListProperty

public org.eclipse.emf.databinding.IEMFListProperty convertToListProperty(VDomainModelReference domainModelReference,
                                                                          org.eclipse.emf.ecore.EObject object)
                                                                   throws DatabindingFailedException

Description copied from interface: DomainModelReferenceConverter

Converts a VDomainModelReference to an IListProperty.

Specified by:

convertToListProperty in interface DomainModelReferenceConverter

Specified by:

convertToListProperty in interface DomainModelReferenceConverterEMF

Parameters:

domainModelReference - The VDomainModelReference that will be converted to an IListProperty

object - The root object of the rendered form

Returns:

The created IListProperty, does not return null.

Throws:

DatabindingFailedException - if no value property could be created due to an invalid VDomainModelReference.

getSetting

public org.eclipse.emf.ecore.EStructuralFeature.Setting getSetting(VDomainModelReference domainModelReference,
                                                                   org.eclipse.emf.ecore.EObject object)
                                                            throws DatabindingFailedException

Description copied from interface: DomainModelReferenceConverterEMF

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

Specified by:

getSetting in interface DomainModelReferenceConverterEMF

Parameters:

domainModelReference - The VDomainModelReference to use to retrieve the setting

object - The EObject to use to retrieve the setting

Returns:

The Setting being described by the VDomainModelReference

Throws:

DatabindingFailedException - if the databinding could not be executed successfully.