org.eclipse.jpt.jpa.ui
Interface JpaPlatformUi

public interface JpaPlatformUi

This interface is to be implemented by a JPA vendor to provide extensions to JPA UI functionality. This is intended to work in conjunction with a core JPA platform implementation with the same ID.

Any implementation's state should be static.

The "generic" extension supplies UI for the core platform extension with the same ID.

See the extension point: org.eclipse.jpt.jpa.ui.jpaPlatform

To retrieve the JPA UI platform corresponding to a JPA platform:

 JpaProject jpaProject = ...;
 JpaPlatform jpaPlatform = jpaProject.getJpaPlatform();
 JpaPlatformUi jpaPlatformUi = (JpaPlatformUi) jpaPlatform.getAdapter(JpaPlatformUi.class);
 

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.

Method Summary

JpaComposite	buildAttributeMappingComposite(JptResourceType resourceType, String mappingKey, Composite parentComposite, PropertyValueModel<AttributeMapping> mappingModel, PropertyValueModel<Boolean> enabledModel, WidgetFactory widgetFactory, ResourceManager resourceManager)
JpaComposite	buildTypeMappingComposite(JptResourceType resourceType, String mappingKey, PropertyValueModel<TypeMapping> mappingModel, PropertyValueModel<Boolean> enabledModel, Composite parentComposite, WidgetFactory widgetFactory, ResourceManager resourceManager)
void	convertJavaGeneratorMetadataToGlobal(JpaProject project)
void	convertJavaQueryMetadataToGlobal(JpaProject project)
void	generateDDL(JpaProject project, IStructuredSelection selection)
void	generateEntities(JpaProject project, IStructuredSelection selection)
MappingUiDefinition	getAttributeMappingUiDefinition(JptResourceType resourceType, String mappingKey)
Iterable<MappingUiDefinition>	getAttributeMappingUiDefinitions(JptResourceType resourceType) Return the list of all the possible attribute mapping ui definitions for the given JptResourceType.
Iterable<MappingUiDefinition>	getAttributeMappingUiDefinitions(PersistentAttribute persistentAttribute) Return the list of possible attribute mapping ui definitions filtered using MappingUiDefinition#isEnabledFor(JpaContextNode).
DefaultMappingUiDefinition	getDefaultAttributeMappingUiDefinition(JptResourceType resourceType, String mappingKey)
DefaultMappingUiDefinition	getDefaultTypeMappingUiDefinition(JptResourceType resourceType)
JpaDetailsProvider	getDetailsProvider(JpaStructureNode node) Return a details provider for the specified JPA structure node.
ItemTreeStateProviderFactoryProvider	getNavigatorFactoryProvider() Return the platform's Navigator factory provider.
ResourceUiDefinition	getResourceUiDefinition(JptResourceType resourceType) Return a resource ui definition for the specified resource type.
ItemTreeStateProviderFactoryProvider	getStructureViewFactoryProvider(JpaFile jpaFile) Return a structure provider for the specified JPA file.
MappingUiDefinition	getTypeMappingUiDefinition(JptResourceType resourceType, String mappingKey)
Iterable<MappingUiDefinition>	getTypeMappingUiDefinitions(JptResourceType resourceType) Return the list of all the possible type mapping ui definitions for the given JptResourceType.
Iterable<MappingUiDefinition>	getTypeMappingUiDefinitions(PersistentType persistentType) Return the list of possible type mapping ui definitions filtered using MappingUiDefinition#isEnabledFor(JpaContextNode).

Method Detail

getNavigatorFactoryProvider

ItemTreeStateProviderFactoryProvider getNavigatorFactoryProvider()

Return the platform's Navigator factory provider. This is used by the Common Navigator to build and maintain the JPA content and labels. Do not return null.

See Also:

org.eclipse.jpt.common.ui.internal.jface.NullItemTreeStateProviderFactoryProvider

getStructureViewFactoryProvider

ItemTreeStateProviderFactoryProvider getStructureViewFactoryProvider(JpaFile jpaFile)

Return a structure provider for the specified JPA file.

getDetailsProvider

JpaDetailsProvider getDetailsProvider(JpaStructureNode node)

Return a details provider for the specified JPA structure node.

getResourceUiDefinition

ResourceUiDefinition getResourceUiDefinition(JptResourceType resourceType)

Return a resource ui definition for the specified resource type.

buildTypeMappingComposite

JpaComposite buildTypeMappingComposite(JptResourceType resourceType,
                                       String mappingKey,
                                       PropertyValueModel<TypeMapping> mappingModel,
                                       PropertyValueModel<Boolean> enabledModel,
                                       Composite parentComposite,
                                       WidgetFactory widgetFactory,
                                       ResourceManager resourceManager)

getTypeMappingUiDefinitions

Iterable<MappingUiDefinition> getTypeMappingUiDefinitions(PersistentType persistentType)

Return the list of possible type mapping ui definitions filtered using MappingUiDefinition#isEnabledFor(JpaContextNode).

See Also:

getTypeMappingUiDefinitions(JptResourceType)

getTypeMappingUiDefinitions

Iterable<MappingUiDefinition> getTypeMappingUiDefinitions(JptResourceType resourceType)

Return the list of all the possible type mapping ui definitions for the given JptResourceType.

See Also:

getTypeMappingUiDefinitions(PersistentType)

getTypeMappingUiDefinition

MappingUiDefinition getTypeMappingUiDefinition(JptResourceType resourceType,
                                               String mappingKey)

getDefaultTypeMappingUiDefinition

DefaultMappingUiDefinition getDefaultTypeMappingUiDefinition(JptResourceType resourceType)

buildAttributeMappingComposite

JpaComposite buildAttributeMappingComposite(JptResourceType resourceType,
                                            String mappingKey,
                                            Composite parentComposite,
                                            PropertyValueModel<AttributeMapping> mappingModel,
                                            PropertyValueModel<Boolean> enabledModel,
                                            WidgetFactory widgetFactory,
                                            ResourceManager resourceManager)

getAttributeMappingUiDefinitions

Iterable<MappingUiDefinition> getAttributeMappingUiDefinitions(PersistentAttribute persistentAttribute)

Return the list of possible attribute mapping ui definitions filtered using MappingUiDefinition#isEnabledFor(JpaContextNode).

See Also:

getAttributeMappingUiDefinitions(JptResourceType)

getAttributeMappingUiDefinitions

Iterable<MappingUiDefinition> getAttributeMappingUiDefinitions(JptResourceType resourceType)

Return the list of all the possible attribute mapping ui definitions for the given JptResourceType.

See Also:

getAttributeMappingUiDefinitions(PersistentAttribute)

getAttributeMappingUiDefinition

MappingUiDefinition getAttributeMappingUiDefinition(JptResourceType resourceType,
                                                    String mappingKey)

getDefaultAttributeMappingUiDefinition

DefaultMappingUiDefinition getDefaultAttributeMappingUiDefinition(JptResourceType resourceType,
                                                                  String mappingKey)

convertJavaQueryMetadataToGlobal

void convertJavaQueryMetadataToGlobal(JpaProject project)

convertJavaGeneratorMetadataToGlobal

void convertJavaGeneratorMetadataToGlobal(JpaProject project)

generateEntities

void generateEntities(JpaProject project,
                      IStructuredSelection selection)

generateDDL

void generateDDL(JpaProject project,
                 IStructuredSelection selection)