| /******************************************************************************* |
| * Copyright (c) 2007, 2008 Oracle. All rights reserved. |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Public License v1.0, which accompanies this distribution |
| * and is available at http://www.eclipse.org/legal/epl-v10.html. |
| * |
| * Contributors: |
| * Oracle - initial API and implementation |
| ******************************************************************************/ |
| package org.eclipse.jpt.ui.internal.platform.base; |
| |
| import java.util.ArrayList; |
| import java.util.Collection; |
| import java.util.Iterator; |
| import java.util.List; |
| import java.util.ListIterator; |
| import org.eclipse.jface.viewers.IStructuredSelection; |
| import org.eclipse.jpt.core.JpaFile; |
| import org.eclipse.jpt.core.JpaProject; |
| import org.eclipse.jpt.core.JpaStructureNode; |
| import org.eclipse.jpt.core.ResourceModel; |
| import org.eclipse.jpt.core.context.AttributeMapping; |
| import org.eclipse.jpt.core.context.TypeMapping; |
| import org.eclipse.jpt.core.context.java.JavaJpaContextNode; |
| import org.eclipse.jpt.core.resource.java.JavaResourceModel; |
| import org.eclipse.jpt.core.resource.orm.OrmResourceModel; |
| import org.eclipse.jpt.core.resource.persistence.PersistenceResourceModel; |
| import org.eclipse.jpt.ui.JpaPlatformUi; |
| import org.eclipse.jpt.ui.JpaUiFactory; |
| import org.eclipse.jpt.ui.details.AttributeMappingUiProvider; |
| import org.eclipse.jpt.ui.details.JpaDetailsProvider; |
| import org.eclipse.jpt.ui.details.TypeMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.details.BasicMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.details.EmbeddableUiProvider; |
| import org.eclipse.jpt.ui.internal.details.EmbeddedIdMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.details.EmbeddedMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.details.IdMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.details.ManyToManyMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.details.ManyToOneMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.details.MappedSuperclassUiProvider; |
| import org.eclipse.jpt.ui.internal.details.OneToManyMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.details.OneToOneMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.details.TransientMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.details.VersionMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.java.details.DefaultBasicMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.java.details.DefaultEmbeddedMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.java.details.JavaDetailsProvider; |
| import org.eclipse.jpt.ui.internal.java.details.JavaEntityUiProvider; |
| import org.eclipse.jpt.ui.internal.java.details.NullAttributeMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.java.details.NullTypeMappingUiProvider; |
| import org.eclipse.jpt.ui.internal.orm.details.OrmDetailsProvider; |
| import org.eclipse.jpt.ui.internal.orm.details.OrmEntityUiProvider; |
| import org.eclipse.jpt.ui.internal.structure.JavaResourceModelStructureProvider; |
| import org.eclipse.jpt.ui.internal.structure.OrmResourceModelStructureProvider; |
| import org.eclipse.jpt.ui.internal.structure.PersistenceResourceModelStructureProvider; |
| import org.eclipse.jpt.ui.structure.JpaStructureProvider; |
| import org.eclipse.jpt.utility.internal.iterators.CloneIterator; |
| import org.eclipse.jpt.utility.internal.iterators.CloneListIterator; |
| |
| public abstract class BaseJpaPlatformUi implements JpaPlatformUi |
| { |
| // TODO: Transformed into a List for testing |
| private List<JpaDetailsProvider> detailsProviders; |
| |
| private List<TypeMappingUiProvider<? extends TypeMapping>> javaTypeMappingUiProviders; |
| private List<AttributeMappingUiProvider<? extends AttributeMapping>> javaAttributeMappingUiProviders; |
| private List<AttributeMappingUiProvider<? extends AttributeMapping>> defaultJavaAttributeMappingUiProviders; |
| |
| private List<TypeMappingUiProvider<? extends TypeMapping>> ormTypeMappingUiProviders; |
| private List<AttributeMappingUiProvider<? extends AttributeMapping>> ormAttributeMappingUiProviders; |
| private List<AttributeMappingUiProvider<? extends AttributeMapping>> defaultOrmAttributeMappingUiProviders; |
| |
| private JpaUiFactory jpaUiFactory; |
| |
| |
| protected BaseJpaPlatformUi() { |
| super(); |
| this.jpaUiFactory = createJpaUiFactory(); |
| } |
| |
| |
| // **************** structure view content ********************************* |
| |
| public JpaStructureProvider buildStructureProvider(JpaFile jpaFile) { |
| ResourceModel resourceModel = jpaFile.getResourceModel(); |
| String resourceType = resourceModel.getResourceType(); |
| |
| if (resourceType == ResourceModel.JAVA_RESOURCE_TYPE) { |
| return new JavaResourceModelStructureProvider((JavaResourceModel) resourceModel); |
| } |
| else if (resourceType == ResourceModel.ORM_RESOURCE_TYPE) { |
| return new OrmResourceModelStructureProvider((OrmResourceModel) resourceModel); |
| } |
| else if (resourceType == ResourceModel.PERSISTENCE_RESOURCE_TYPE) { |
| return new PersistenceResourceModelStructureProvider((PersistenceResourceModel) resourceModel); |
| } |
| |
| return null; |
| } |
| |
| |
| // ********** behavior ********** |
| |
| protected abstract JpaUiFactory createJpaUiFactory(); |
| |
| public JpaUiFactory getJpaUiFactory() { |
| return this.jpaUiFactory; |
| } |
| |
| public Iterator<JpaDetailsProvider> detailsProviders() { |
| if (this.detailsProviders == null) { |
| this.detailsProviders = new ArrayList<JpaDetailsProvider>(); |
| this.addDetailsProvidersTo(this.detailsProviders); |
| } |
| return new CloneIterator<JpaDetailsProvider>(this.detailsProviders); |
| } |
| |
| /** |
| * Override this to specify more or different details providers. |
| * The default includes the JPA spec-defined java and orm.xml |
| */ |
| protected void addDetailsProvidersTo(Collection<JpaDetailsProvider> providers) { |
| providers.add(new JavaDetailsProvider()); |
| providers.add(new OrmDetailsProvider()); |
| } |
| |
| public JpaDetailsProvider detailsProvider(JpaStructureNode structureNode) { |
| // TODO: To implement, this is written only for testing |
| detailsProviders(); |
| if (structureNode instanceof JavaJpaContextNode) { |
| return detailsProviders.get(0); |
| } |
| else { |
| return detailsProviders.get(1); |
| } |
| // for (Iterator<IJpaDetailsProvider> i = this.detailsProviders(); i.hasNext(); ) { |
| // IJpaDetailsProvider provider = i.next(); |
| // if (provider.fileContentType().equals(fileContentType)) { |
| // return provider; |
| // } |
| // } |
| // return null; |
| } |
| |
| public ListIterator<TypeMappingUiProvider<? extends TypeMapping>> javaTypeMappingUiProviders() { |
| if (this.javaTypeMappingUiProviders == null) { |
| this.javaTypeMappingUiProviders = new ArrayList<TypeMappingUiProvider<? extends TypeMapping>>(); |
| this.addJavaTypeMappingUiProvidersTo(this.javaTypeMappingUiProviders); |
| } |
| return new CloneListIterator<TypeMappingUiProvider<? extends TypeMapping>>( |
| this.javaTypeMappingUiProviders |
| ); |
| } |
| |
| /** |
| * Override this to specify more or different type mapping ui providers |
| * The default includes the JPA spec-defined entity, mapped superclass, embeddable, |
| * and null (when the others don't apply) |
| */ |
| protected void addJavaTypeMappingUiProvidersTo(List<TypeMappingUiProvider<? extends TypeMapping>> providers) { |
| providers.add(NullTypeMappingUiProvider.instance()); |
| providers.add(JavaEntityUiProvider.instance()); |
| providers.add(MappedSuperclassUiProvider.instance()); |
| providers.add(EmbeddableUiProvider.instance()); |
| } |
| |
| public ListIterator<AttributeMappingUiProvider<? extends AttributeMapping>> javaAttributeMappingUiProviders() { |
| if (this.javaAttributeMappingUiProviders == null) { |
| this.javaAttributeMappingUiProviders = new ArrayList<AttributeMappingUiProvider<? extends AttributeMapping>>(); |
| this.addJavaAttributeMappingUiProvidersTo(this.javaAttributeMappingUiProviders); |
| } |
| |
| return new CloneListIterator<AttributeMappingUiProvider<? extends AttributeMapping>>( |
| this.javaAttributeMappingUiProviders |
| ); |
| } |
| |
| /** |
| * Override this to specify more or different java attribute mapping ui providers. |
| * The default includes the JPA spec-defined basic, embedded, embeddedId, id, |
| * manyToMany, manyToOne, oneToMany, oneToOne, transient, and version |
| */ |
| protected void addJavaAttributeMappingUiProvidersTo(List<AttributeMappingUiProvider<? extends AttributeMapping>> providers) { |
| providers.add(BasicMappingUiProvider.instance()); |
| providers.add(EmbeddedMappingUiProvider.instance()); |
| providers.add(EmbeddedIdMappingUiProvider.instance()); |
| providers.add(IdMappingUiProvider.instance()); |
| providers.add(ManyToManyMappingUiProvider.instance()); |
| providers.add(ManyToOneMappingUiProvider.instance()); |
| providers.add(NullAttributeMappingUiProvider.instance()); |
| providers.add(OneToManyMappingUiProvider.instance()); |
| providers.add(OneToOneMappingUiProvider.instance()); |
| providers.add(TransientMappingUiProvider.instance()); |
| providers.add(VersionMappingUiProvider.instance()); |
| } |
| |
| public ListIterator<AttributeMappingUiProvider<? extends AttributeMapping>> defaultJavaAttributeMappingUiProviders() { |
| if (this.defaultJavaAttributeMappingUiProviders == null) { |
| this.defaultJavaAttributeMappingUiProviders = new ArrayList<AttributeMappingUiProvider<? extends AttributeMapping>>(); |
| this.addDefaultJavaAttributeMappingUiProvidersTo(this.defaultJavaAttributeMappingUiProviders); |
| } |
| |
| return new CloneListIterator<AttributeMappingUiProvider<? extends AttributeMapping>>( |
| this.defaultJavaAttributeMappingUiProviders |
| ); |
| } |
| |
| /** |
| * Override this to specify more or different default java attribute mapping ui providers. |
| * The default includes the JPA spec-defined basic, embedded |
| */ |
| protected void addDefaultJavaAttributeMappingUiProvidersTo(List<AttributeMappingUiProvider<? extends AttributeMapping>> providers) { |
| providers.add(DefaultBasicMappingUiProvider.instance()); |
| providers.add(DefaultEmbeddedMappingUiProvider.instance()); |
| } |
| |
| public void generateEntities(JpaProject project, IStructuredSelection selection) { |
| EntitiesGenerator.generate(project, selection); |
| } |
| |
| // *************** ORM mapping UI providers *************** |
| |
| public Iterator<AttributeMappingUiProvider<? extends AttributeMapping>> defaultOrmAttributeMappingUiProviders() { |
| if (this.defaultOrmAttributeMappingUiProviders == null) { |
| this.defaultOrmAttributeMappingUiProviders = new ArrayList<AttributeMappingUiProvider<? extends AttributeMapping>>(); |
| this.addDefaultOrmAttributeMappingUiProvidersTo(this.defaultOrmAttributeMappingUiProviders); |
| } |
| |
| return new CloneListIterator<AttributeMappingUiProvider<? extends AttributeMapping>>( |
| this.defaultOrmAttributeMappingUiProviders |
| ); |
| } |
| |
| /** |
| * Override this to specify more or different default ORM attribute mapping |
| * ui providers. The default has no specific mappings. |
| */ |
| protected void addDefaultOrmAttributeMappingUiProvidersTo(List<AttributeMappingUiProvider<? extends AttributeMapping>> providers) { |
| } |
| |
| public Iterator<AttributeMappingUiProvider<? extends AttributeMapping>> ormAttributeMappingUiProviders() { |
| if (this.ormAttributeMappingUiProviders == null) { |
| this.ormAttributeMappingUiProviders = new ArrayList<AttributeMappingUiProvider<? extends AttributeMapping>>(); |
| this.addOrmAttributeMappingUiProvidersTo(this.ormAttributeMappingUiProviders); |
| } |
| |
| return new CloneListIterator<AttributeMappingUiProvider<? extends AttributeMapping>>( |
| this.ormAttributeMappingUiProviders |
| ); |
| } |
| |
| /** |
| * Override this to specify more or different ORM attribute mapping ui |
| * providers. The default includes the JPA spec-defined basic, embedded, |
| * embeddedId, id, manyToMany, manyToOne, oneToMany, oneToOne, transient, |
| * and version. |
| */ |
| protected void addOrmAttributeMappingUiProvidersTo(List<AttributeMappingUiProvider<? extends AttributeMapping>> providers) { |
| providers.add(BasicMappingUiProvider.instance()); |
| providers.add(EmbeddedMappingUiProvider.instance()); |
| providers.add(EmbeddedIdMappingUiProvider.instance()); |
| providers.add(IdMappingUiProvider.instance()); |
| providers.add(ManyToManyMappingUiProvider.instance()); |
| providers.add(ManyToOneMappingUiProvider.instance()); |
| providers.add(OneToManyMappingUiProvider.instance()); |
| providers.add(OneToOneMappingUiProvider.instance()); |
| providers.add(TransientMappingUiProvider.instance()); |
| providers.add(VersionMappingUiProvider.instance()); |
| } |
| |
| public Iterator<TypeMappingUiProvider<? extends TypeMapping>> ormTypeMappingUiProviders() { |
| if (this.ormTypeMappingUiProviders == null) { |
| this.ormTypeMappingUiProviders = new ArrayList<TypeMappingUiProvider<? extends TypeMapping>>(); |
| this.addOrmTypeMappingUiProvidersTo(this.ormTypeMappingUiProviders); |
| } |
| |
| return new CloneListIterator<TypeMappingUiProvider<? extends TypeMapping>>( |
| this.ormTypeMappingUiProviders |
| ); |
| } |
| |
| /** |
| * Override this to specify more or different ORM type mapping ui providers. |
| * The default includes the JPA spec-defined entity, mapped superclass, |
| * embeddable, and null (when the others don't apply). |
| */ |
| protected void addOrmTypeMappingUiProvidersTo(List<TypeMappingUiProvider<? extends TypeMapping>> providers) { |
| providers.add(OrmEntityUiProvider.instance()); |
| providers.add(MappedSuperclassUiProvider.instance()); |
| providers.add(EmbeddableUiProvider.instance()); |
| } |
| } |