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

Interface EMFFormsDatabindingEMF

All Superinterfaces:

EMFFormsDatabinding

All Known Implementing Classes:

EMFFormsDatabindingImpl

public interface EMFFormsDatabindingEMF
extends EMFFormsDatabinding

EMF specific interface of the EMFFormsDatabinding.

Since:

1.7

Author:

Eugen Neufeld

Method Summary

Modifier and Type	Method and Description
org.eclipse.emf.ecore.EStructuralFeature	extractFeature(org.eclipse.core.databinding.observable.list.IObservableList observableList) Extracts the EStructuralFeature from the provided IObservableList.
org.eclipse.emf.ecore.EStructuralFeature	extractFeature(org.eclipse.core.databinding.observable.value.IObservableValue observableValue) Extracts the EStructuralFeature from the provided IObservableValue.
org.eclipse.emf.ecore.EObject	extractObserved(org.eclipse.core.databinding.observable.list.IObservableList observableList) Extracts the observed EObject from the provided IObservableList.
org.eclipse.emf.ecore.EObject	extractObserved(org.eclipse.core.databinding.observable.value.IObservableValue observableValue) Extracts the observed EObject from the provided IObservableValue.
org.eclipse.emf.databinding.IEMFListProperty	getListProperty(VDomainModelReference domainModelReference, org.eclipse.emf.ecore.EObject object) Returns an IListProperty described by the given VDomainModelReference.
org.eclipse.core.databinding.observable.list.IObservableList	getObservableList(VDomainModelReference domainModelReference, org.eclipse.emf.ecore.EObject object) Returns an IObservableList by observing the list described by the given VDomainModelReference of the given EObject.
org.eclipse.core.databinding.observable.value.IObservableValue	getObservableValue(VDomainModelReference domainModelReference, org.eclipse.emf.ecore.EObject object) Returns an IObservableValue by observing the value described by the given VDomainModelReference of the given EObject.
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.
org.eclipse.emf.databinding.IEMFValueProperty	getValueProperty(VDomainModelReference domainModelReference, org.eclipse.emf.ecore.EObject object) Returns an IValueProperty described by the given VDomainModelReference.

Method Detail

getObservableValue

org.eclipse.core.databinding.observable.value.IObservableValue getObservableValue(VDomainModelReference domainModelReference,
                                                                                  org.eclipse.emf.ecore.EObject object)
                                                                           throws DatabindingFailedException

Returns an IObservableValue by observing the value described by the given VDomainModelReference of the given EObject.

Specified by:

getObservableValue in interface EMFFormsDatabinding

Parameters:

domainModelReference - The domain model reference pointing to the desired value

object - The root object of the rendered form. If the VDomainModelReference contains a path, the object is the first node of the path. Therefore, the IObservableValue can be bound to a feature of a sub element in case of a path.

Returns:

The resulting IObservableValue, does not return null.

Throws:

DatabindingFailedException - if the databinding could not be executed successfully.

See Also:

EMFFormsDatabinding.getObservableValue(org.eclipse.emf.ecp.view.spi.model.VDomainModelReference, org.eclipse.emf.ecore.EObject)

getObservableList

org.eclipse.core.databinding.observable.list.IObservableList getObservableList(VDomainModelReference domainModelReference,
                                                                               org.eclipse.emf.ecore.EObject object)
                                                                        throws DatabindingFailedException

Returns an IObservableList by observing the list described by the given VDomainModelReference of the given EObject.

Specified by:

getObservableList in interface EMFFormsDatabinding

Parameters:

domainModelReference - The domain model reference pointing to the desired list

object - The root object of the rendered form. If the VDomainModelReference contains a path, the object is the first node of the path. Therefore, the IObservableValue can be bound to a feature of a sub element in case of a path.

Returns:

The resulting IObservableList, does not return null

Throws:

DatabindingFailedException - if the databinding could not be executed successfully.

See Also:

EMFFormsDatabinding.getObservableList(org.eclipse.emf.ecp.view.spi.model.VDomainModelReference, org.eclipse.emf.ecore.EObject)

getValueProperty

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

Returns an IValueProperty described by the given VDomainModelReference.

Specified by:

getValueProperty in interface EMFFormsDatabinding

Parameters:

domainModelReference - The domain model reference pointing to the desired value

object - The root object of the rendered form. If the VDomainModelReference contains a path, the object is the first node of the path. Therefore, the IValueProperty can be bound to a feature of a sub element in case of a path.

Returns:

The resulting IValueProperty, does not return null.

Throws:

DatabindingFailedException - if the databinding could not be executed successfully.

See Also:

EMFFormsDatabinding.getValueProperty(org.eclipse.emf.ecp.view.spi.model.VDomainModelReference, org.eclipse.emf.ecore.EObject)

getListProperty

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

Returns an IListProperty described by the given VDomainModelReference.

Specified by:

getListProperty in interface EMFFormsDatabinding

Parameters:

domainModelReference - The domain model reference pointing to the desired list

object - The root object of the rendered form. If the VDomainModelReference contains a path, the object is the first node of the path. Therefore, the IValueProperty can be bound to a feature of a sub element in case of a path.

Returns:

The resulting IListProperty, does not return null.

Throws:

DatabindingFailedException - if the databinding could not be executed successfully.

See Also:

EMFFormsDatabinding.getListProperty(org.eclipse.emf.ecp.view.spi.model.VDomainModelReference, org.eclipse.emf.ecore.EObject)

extractFeature

org.eclipse.emf.ecore.EStructuralFeature extractFeature(org.eclipse.core.databinding.observable.value.IObservableValue observableValue)
                                                 throws DatabindingFailedException

Extracts the EStructuralFeature from the provided IObservableValue.

Parameters:

observableValue - The IObservableValue to extract the EStructuralFeature from

Returns:

The extracted EStructuralFeature

Throws:

DatabindingFailedException - when the IObservableValue doesn't implement IEMFObservable

extractFeature

org.eclipse.emf.ecore.EStructuralFeature extractFeature(org.eclipse.core.databinding.observable.list.IObservableList observableList)
                                                 throws DatabindingFailedException

Extracts the EStructuralFeature from the provided IObservableList.

Parameters:

observableList - The IObservableList to extract the EStructuralFeature from

Returns:

The extracted EStructuralFeature

Throws:

DatabindingFailedException - when the IObservableValue doesn't implement IEMFObservable

extractObserved

org.eclipse.emf.ecore.EObject extractObserved(org.eclipse.core.databinding.observable.value.IObservableValue observableValue)
                                       throws DatabindingFailedException

Extracts the observed EObject from the provided IObservableValue.

Parameters:

observableValue - The IObservableValue to extract the observed EObject from

Returns:

The extracted EObject

Throws:

DatabindingFailedException - when the IObservableValue doesn't implement IEMFObservable

extractObserved

org.eclipse.emf.ecore.EObject extractObserved(org.eclipse.core.databinding.observable.list.IObservableList observableList)
                                       throws DatabindingFailedException

Extracts the observed EObject from the provided IObservableList.

Parameters:

observableList - The IObservableList to extract the observed EObject from

Returns:

The extracted EObject

Throws:

DatabindingFailedException - when the IObservableValue doesn't implement IEMFObservable

getSetting

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

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

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.

Since:

1.8