org.eclipse.jpt.ui.details
Interface MappingUiProvider<T>

All Known Subinterfaces:

AttributeMappingUiProvider<T>, TypeMappingUiProvider<T>

public interface MappingUiProvider<T>

A UI provider is reponsible to provide the support for displaying the information for a certain mapping type.

Since:

2.0 Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Version:

2.0

See Also:

AttributeMappingUiProvider, TypeMappingUiProvider

Method Summary

org.eclipse.swt.graphics.Image	getImage() Returns an image that represents the mapping type defined by this provider.
java.lang.String	getLabel() Returns a human readable text of the mapping type.
java.lang.String	getMappingKey() Returns a unique string that corresponds to the key of the mapping in the core (JavaAttributeMappingProvider and/or OrmAttributeMappingProvider).

Method Detail

getLabel

java.lang.String getLabel()

Returns a human readable text of the mapping type.

Returns:

A display string for the mapping type

getImage

org.eclipse.swt.graphics.Image getImage()

Returns an image that represents the mapping type defined by this provider.

Returns:

An image representing a mapping or null if no image is required

getMappingKey

java.lang.String getMappingKey()

Returns a unique string that corresponds to the key of the mapping in the core (JavaAttributeMappingProvider and/or OrmAttributeMappingProvider).

Returns:

The key representing the mapping