jpa/plugins/org.eclipse.jpt.jpa.core/src/org/eclipse/jpt/jpa/core/JpaPlatform.java - dali/webtools.dali - Git at Google

 /*******************************************************************************
  * Copyright (c) 2006, 2013 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.jpa.core;

 import org.eclipse.core.resources.IFile;
 import org.eclipse.core.runtime.IAdaptable;
 import org.eclipse.core.runtime.content.IContentType;
 import org.eclipse.jpt.common.core.AnnotationProvider;
 import org.eclipse.jpt.common.core.JptResourceType;
 import org.eclipse.jpt.common.core.utility.jdt.AnnotationEditFormatter;
 import org.eclipse.jpt.common.utility.predicate.Predicate;
 import org.eclipse.jpt.jpa.core.context.java.DefaultJavaAttributeMappingDefinition;
 import org.eclipse.jpt.jpa.core.context.java.JavaAttributeMappingDefinition;
 import org.eclipse.jpt.jpa.core.context.java.JavaManagedTypeDefinition;
 import org.eclipse.jpt.jpa.core.context.java.JavaTypeMappingDefinition;
 import org.eclipse.jpt.jpa.core.jpa2.JpaProject2_0;
 import org.eclipse.jpt.jpa.core.jpa2_1.JpaProject2_1;
 import org.eclipse.jpt.jpa.core.platform.JpaPlatformManager;
 import org.eclipse.jpt.jpa.db.ConnectionProfileFactory;
 import org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar;
 import org.eclipse.wst.common.project.facet.core.IProjectFacetVersion;

 /**
  * This interface is to be implemented by a JPA vendor to provide extensions to
  * the core JPA model. The core JPA model will provide functionality for JPA
  * spec annotations in Java, <code>persistence.xml</code> and mapping
  * (<code>orm.xml</code>) files.
  * The <code>org.eclipse.jpt.jpa.core.generic</code> extension supplies
  * resource models for those file types. As another vendor option you
  * will have to supply those resource models as well or different ones
  * as necessary. In the extension point you actually provide a
  * {@link JpaPlatformFactory} that will build the JPA platform.
  * <p>
  * 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.
  * <p>
  * See the <code>org.eclipse.jpt.jpa.core.jpaPlatforms</code> extension point.
  * @see JpaPlatformFactory
  * @see JpaPlatformProvider
  *
  * @version 3.2
  * @since 2.0
  */
 public interface JpaPlatform
 	extends IAdaptable
 {
 	// ********** meta stuff **********

 	/**
 	 * Return the JPA platform's ID.
 	 */
 	String getId();

 	/**
 	 * Return the JPA platform's config (i.e. the config defined by
 	 * the JPA platform's plug-in extension).
 	 */
 	Config getConfig();

 	/**
 	 * Return the JPA platform's version.
 	 */
 	Version getJpaVersion();


 	// ********** factory **********

 	/**
 	 * Return the factory responsible for constructing various
 	 * JPA model objects:<ul>
 	 * <li>core (e.g. {@link JpaProject})
 	 * <li>Java context (e.g. {@link org.eclipse.jpt.jpa.core.context.persistence.PersistenceUnit})
 	 * </ul>
 	 */
 	JpaFactory getJpaFactory();


 	// ********** JPA files **********

 	/**
 	 * Return a JPA file corresponding to the specified Eclipse file.
 	 * Return <code>null</code> if the file's content is unsupported.
 	 */
 	JpaFile buildJpaFile(JpaProject jpaProject, IFile file);

 	/**
 	 * Return the specified file's content type, as defined by various
 	 * extensions.
 	 */
 	IContentType getContentType(IFile file);


 	// ********** Managed Types **********

 	/**
 	 * Return the Java managed type definitions that will be used to build Java
 	 * managed types and their corresponding annotations.
 	 */
 	Iterable<JavaManagedTypeDefinition> getJavaManagedTypeDefinitions();


 	// ********** Java annotations **********

 	/**
 	 * Return an annotation provider responsible for determining what Java
 	 * annotations are supported and constructing the corresponding Java
 	 * resource model objects.
 	 */
 	AnnotationProvider getAnnotationProvider();

 	/**
 	 * Return a formatter that can clean up the Java annotations added to source
 	 * code.
 	 */
 	AnnotationEditFormatter getAnnotationEditFormatter();


 	// ********** Java type mappings **********

 	/**
 	 * Return the Java type mapping definitions that will be used to build Java
 	 * type mappings and their corresponding annotations.
 	 */
 	Iterable<JavaTypeMappingDefinition> getJavaTypeMappingDefinitions();


 	// ********** Java attribute mappings **********

 	/**
 	 * Return the Java attribute mapping definitions that will be used to build
 	 * Java attribute mappings and their corresponding annotations.
 	 */
 	Iterable<JavaAttributeMappingDefinition> getSpecifiedJavaAttributeMappingDefinitions();

 	/**
 	 * Return the Java attribute mapping definitions that will be used to build
 	 * default Java attribute mappings.
 	 */
 	Iterable<DefaultJavaAttributeMappingDefinition> getDefaultJavaAttributeMappingDefinitions();


 	// ********** resource types and definitions **********

 	/**
 	 * Return whether the JPA platform supports the specified resource type.
 	 * This method is consistent with {@link #getResourceDefinition(JptResourceType)}.
 	 */
 	boolean supportsResourceType(JptResourceType resourceType);

 	/**
 	 * Return the JPA platform's resource definition for the specified resource type.
 	 * The returned definition describes the JPA platform's corresponding context model.
 	 * Throw an {@link IllegalArgumentException} if the resource type is not
 	 * supported by the JPA platform.
 	 * This method is consistent with {@link #supportsResourceType(JptResourceType)}.
 	 */
 	ResourceDefinition getResourceDefinition(JptResourceType resourceType);

 	/**
 	 * Return the most recent supported resource type for the specified content
 	 * type. Throw an {@link IllegalArgumentException} if the content type is not
 	 * supported by the JPA platform.
 	 */
 	JptResourceType getMostRecentSupportedResourceType(IContentType contentType);


 	// ********** database **********

 	/**
 	 * Return a connection factory that can be used to query the database
 	 * about its metadata etc.
 	 */
 	ConnectionProfileFactory getConnectionProfileFactory();

 	/**
 	 * Return an entity generator database annotation name builder, which is
 	 * used by Entity Generation to determine whether and how the entity generator
 	 * prints the names of various database objects.
 	 */
 	EntityGeneratorDatabaseAnnotationNameBuilder getEntityGeneratorDatabaseAnnotationNameBuilder();


 	// ********** platform variation **********

 	/**
 	 * Return a JPA platform variation that is used to determine differences
 	 * among JPA platforms and/or JPA specification versions.
 	 */
 	JpaPlatformVariation getJpaVariation();


 	// ********** Hermes integration **********

 	/**
 	 * Return the JPQL grammar that will be used to parse JPQL queries.
 	 * @since 3.2
 	 */
 	JPQLGrammar getJpqlGrammar();


 	// ********** JPA platform version **********

 	interface Version {
 		/**
 		 * Return the platform's version.
 		 */
 		String getVersion();

 		/**
 		 * Return the highest JPA specification version supported by the platform.
 		 * @see JpaProject#FACET_VERSION_STRING
 		 * @see JpaProject2_0#FACET_VERSION_STRING
 		 * @see JpaProject2_1#FACET_VERSION_STRING
 		 */
 		String getJpaVersion();

 		/**
 		 * Return whether the platform is compatible with the specified JPA
 		 * specification version.
 		 * @see JpaProject#FACET_VERSION_STRING
 		 * @see JpaProject2_0#FACET_VERSION_STRING
 		 * @see JpaProject2_1#FACET_VERSION_STRING
 		 */
 		boolean isCompatibleWithJpaVersion(String jpaVersion);
 	}


 	// ********** JPA platform config **********

 	/**
 	 * Metadata that describes a JPA platform as defined in an
 	 * extension to the <code>org.eclipse.jpt.jpa.core.jpaPlatforms</code>
 	 * extension point.
 	 * <p>
 	 * See <code>org.eclipse.jpt.jpa.core/plugin.xml:jpaPlatforms</code>.
 	 * <p>
 	 * Not intended to be implemented by clients.
 	 */
 	public interface Config {
 		/**
 		 * Return the config's manager.
 		 */
 		JpaPlatformManager getJpaPlatformManager();

 		/**
 		 * Return the config's extension-supplied ID.
 		 * This is unique among all the JPA platform configs.
 		 */
 		String getId();

 		/**
 		 * Return the config's extension-supplied label.
 		 */
 		String getLabel();

 		/**
 		 * Return the config's JPA facet version or null if the extension
 		 * does <em>not</em> specify a JPA facet version.
 		 */
 		IProjectFacetVersion getJpaFacetVersion();

 		/**
 		 * Return whether the config's JPA platform supports the specified
 		 * JPA facet version. If the extension specifies a JPA facet version, it
 		 * must be the same as the specified JPA facet version. If the extension
 		 * does <em>not</em> specify a JPA facet version, the config's JPA
 		 * platform supports all JPA facet versions.
 		 * @exception IllegalArgumentException if the specified facet version is
 		 * not for a JPA facet
 		 */
 		boolean supportsJpaFacetVersion(IProjectFacetVersion jpaFacetVersion);

 		/**
 		 * Return whether the config's JPA platform can be used as the default
 		 * JPA platform for its {@link #supportsJpaFacetVersion(IProjectFacetVersion)
 		 * supported JPA facet versions}.
 		 */
 		boolean isDefault();

 		/**
 		 * Return config's group config.
 		 */
 		GroupConfig getGroupConfig();

 		/**
 		 * Return the ID of the plug-in that contributed the JPA platform
 		 * config.
 		 */
 		String getPluginId();

 		/**
 		 * Build and return the config's JPA platform.
 		 */
 		JpaPlatform getJpaPlatform();

 		Predicate<Config> DEFAULT_FILTER = new DefaultFilter();
 		/* CU private */ static class DefaultFilter
 			extends Predicate.Adapter<Config>
 		{
 			@Override
 			public boolean evaluate(Config config) {
 				return config.isDefault();
 			}
 		}
 	}


 	// ********** JPA platform config **********

 	/**
 	 * Metadata that describes a JPA platform group as defined in an
 	 * extension to the <code>org.eclipse.jpt.jpa.core.jpaPlatforms</code>
 	 * extension point.
 	 * <p>
 	 * See <code>org.eclipse.jpt.jpa.core/plugin.xml:jpaPlatforms</code>.
 	 * <p>
 	 * Not intended to be implemented by clients.
 	 */
 	interface GroupConfig {
 		/**
 		 * Return the config's manager.
 		 */
 		JpaPlatformManager getJpaPlatformManager();

 		/**
 		 * Return the JPA platform group config's extension-supplied ID.
 		 * This is unique among all the JPA platform group configs.
 		 */
 		String getId();

 		/**
 		 * Return the JPA platform group config's extension-supplied label.
 		 */
 		String getLabel();

 		/**
 		 * Return the JPA platform configs that belong to the group.
 		 */
 		Iterable<JpaPlatform.Config> getJpaPlatformConfigs();

 		/**
 		 * Return the ID of the plug-in that contributed the JPA platform group
 		 * config.
 		 */
 		String getPluginId();
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2006, 2013 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.jpa.core;

	import org.eclipse.core.resources.IFile;
	import org.eclipse.core.runtime.IAdaptable;
	import org.eclipse.core.runtime.content.IContentType;
	import org.eclipse.jpt.common.core.AnnotationProvider;
	import org.eclipse.jpt.common.core.JptResourceType;
	import org.eclipse.jpt.common.core.utility.jdt.AnnotationEditFormatter;
	import org.eclipse.jpt.common.utility.predicate.Predicate;
	import org.eclipse.jpt.jpa.core.context.java.DefaultJavaAttributeMappingDefinition;
	import org.eclipse.jpt.jpa.core.context.java.JavaAttributeMappingDefinition;
	import org.eclipse.jpt.jpa.core.context.java.JavaManagedTypeDefinition;
	import org.eclipse.jpt.jpa.core.context.java.JavaTypeMappingDefinition;
	import org.eclipse.jpt.jpa.core.jpa2.JpaProject2_0;
	import org.eclipse.jpt.jpa.core.jpa2_1.JpaProject2_1;
	import org.eclipse.jpt.jpa.core.platform.JpaPlatformManager;
	import org.eclipse.jpt.jpa.db.ConnectionProfileFactory;
	import org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar;
	import org.eclipse.wst.common.project.facet.core.IProjectFacetVersion;

	/**
	* This interface is to be implemented by a JPA vendor to provide extensions to
	* the core JPA model. The core JPA model will provide functionality for JPA
	* spec annotations in Java, <code>persistence.xml</code> and mapping
	* (<code>orm.xml</code>) files.
	* The <code>org.eclipse.jpt.jpa.core.generic</code> extension supplies
	* resource models for those file types. As another vendor option you
	* will have to supply those resource models as well or different ones
	* as necessary. In the extension point you actually provide a
	* {@link JpaPlatformFactory} that will build the JPA platform.
	* <p>
	* 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.
	* <p>
	* See the <code>org.eclipse.jpt.jpa.core.jpaPlatforms</code> extension point.
	* @see JpaPlatformFactory
	* @see JpaPlatformProvider
	*
	* @version 3.2
	* @since 2.0
	*/
	public interface JpaPlatform
	extends IAdaptable
	{
	// ******** meta stuff ********

	/**
	* Return the JPA platform's ID.
	*/
	String getId();

	/**
	* Return the JPA platform's config (i.e. the config defined by
	* the JPA platform's plug-in extension).
	*/
	Config getConfig();

	/**
	* Return the JPA platform's version.
	*/
	Version getJpaVersion();


	// ******** factory ********

	/**
	* Return the factory responsible for constructing various
	* JPA model objects:<ul>
	* <li>core (e.g. {@link JpaProject})
	* <li>Java context (e.g. {@link org.eclipse.jpt.jpa.core.context.persistence.PersistenceUnit})
	* </ul>
	*/
	JpaFactory getJpaFactory();


	// ******** JPA files ********

	/**
	* Return a JPA file corresponding to the specified Eclipse file.
	* Return <code>null</code> if the file's content is unsupported.
	*/
	JpaFile buildJpaFile(JpaProject jpaProject, IFile file);

	/**
	* Return the specified file's content type, as defined by various
	* extensions.
	*/
	IContentType getContentType(IFile file);


	// ******** Managed Types ********

	/**
	* Return the Java managed type definitions that will be used to build Java
	* managed types and their corresponding annotations.
	*/
	Iterable<JavaManagedTypeDefinition> getJavaManagedTypeDefinitions();


	// ******** Java annotations ********

	/**
	* Return an annotation provider responsible for determining what Java
	* annotations are supported and constructing the corresponding Java
	* resource model objects.
	*/
	AnnotationProvider getAnnotationProvider();

	/**
	* Return a formatter that can clean up the Java annotations added to source
	* code.
	*/
	AnnotationEditFormatter getAnnotationEditFormatter();


	// ******** Java type mappings ********

	/**
	* Return the Java type mapping definitions that will be used to build Java
	* type mappings and their corresponding annotations.
	*/
	Iterable<JavaTypeMappingDefinition> getJavaTypeMappingDefinitions();


	// ******** Java attribute mappings ********

	/**
	* Return the Java attribute mapping definitions that will be used to build
	* Java attribute mappings and their corresponding annotations.
	*/
	Iterable<JavaAttributeMappingDefinition> getSpecifiedJavaAttributeMappingDefinitions();

	/**
	* Return the Java attribute mapping definitions that will be used to build
	* default Java attribute mappings.
	*/
	Iterable<DefaultJavaAttributeMappingDefinition> getDefaultJavaAttributeMappingDefinitions();


	// ******** resource types and definitions ********

	/**
	* Return whether the JPA platform supports the specified resource type.
	* This method is consistent with {@link #getResourceDefinition(JptResourceType)}.
	*/
	boolean supportsResourceType(JptResourceType resourceType);

	/**
	* Return the JPA platform's resource definition for the specified resource type.
	* The returned definition describes the JPA platform's corresponding context model.
	* Throw an {@link IllegalArgumentException} if the resource type is not
	* supported by the JPA platform.
	* This method is consistent with {@link #supportsResourceType(JptResourceType)}.
	*/
	ResourceDefinition getResourceDefinition(JptResourceType resourceType);

	/**
	* Return the most recent supported resource type for the specified content
	* type. Throw an {@link IllegalArgumentException} if the content type is not
	* supported by the JPA platform.
	*/
	JptResourceType getMostRecentSupportedResourceType(IContentType contentType);


	// ******** database ********

	/**
	* Return a connection factory that can be used to query the database
	* about its metadata etc.
	*/
	ConnectionProfileFactory getConnectionProfileFactory();

	/**
	* Return an entity generator database annotation name builder, which is
	* used by Entity Generation to determine whether and how the entity generator
	* prints the names of various database objects.
	*/
	EntityGeneratorDatabaseAnnotationNameBuilder getEntityGeneratorDatabaseAnnotationNameBuilder();


	// ******** platform variation ********

	/**
	* Return a JPA platform variation that is used to determine differences
	* among JPA platforms and/or JPA specification versions.
	*/
	JpaPlatformVariation getJpaVariation();


	// ******** Hermes integration ********

	/**
	* Return the JPQL grammar that will be used to parse JPQL queries.
	* @since 3.2
	*/
	JPQLGrammar getJpqlGrammar();


	// ******** JPA platform version ********

	interface Version {
	/**
	* Return the platform's version.
	*/
	String getVersion();

	/**
	* Return the highest JPA specification version supported by the platform.
	* @see JpaProject#FACET_VERSION_STRING
	* @see JpaProject2_0#FACET_VERSION_STRING
	* @see JpaProject2_1#FACET_VERSION_STRING
	*/
	String getJpaVersion();

	/**
	* Return whether the platform is compatible with the specified JPA
	* specification version.
	* @see JpaProject#FACET_VERSION_STRING
	* @see JpaProject2_0#FACET_VERSION_STRING
	* @see JpaProject2_1#FACET_VERSION_STRING
	*/
	boolean isCompatibleWithJpaVersion(String jpaVersion);
	}


	// ******** JPA platform config ********

	/**
	* Metadata that describes a JPA platform as defined in an
	* extension to the <code>org.eclipse.jpt.jpa.core.jpaPlatforms</code>
	* extension point.
	* <p>
	* See <code>org.eclipse.jpt.jpa.core/plugin.xml:jpaPlatforms</code>.
	* <p>
	* Not intended to be implemented by clients.
	*/
	public interface Config {
	/**
	* Return the config's manager.
	*/
	JpaPlatformManager getJpaPlatformManager();

	/**
	* Return the config's extension-supplied ID.
	* This is unique among all the JPA platform configs.
	*/
	String getId();

	/**
	* Return the config's extension-supplied label.
	*/
	String getLabel();

	/**
	* Return the config's JPA facet version or null if the extension
	* does <em>not</em> specify a JPA facet version.
	*/
	IProjectFacetVersion getJpaFacetVersion();

	/**
	* Return whether the config's JPA platform supports the specified
	* JPA facet version. If the extension specifies a JPA facet version, it
	* must be the same as the specified JPA facet version. If the extension
	* does <em>not</em> specify a JPA facet version, the config's JPA
	* platform supports all JPA facet versions.
	* @exception IllegalArgumentException if the specified facet version is
	* not for a JPA facet
	*/
	boolean supportsJpaFacetVersion(IProjectFacetVersion jpaFacetVersion);

	/**
	* Return whether the config's JPA platform can be used as the default
	* JPA platform for its {@link #supportsJpaFacetVersion(IProjectFacetVersion)
	* supported JPA facet versions}.
	*/
	boolean isDefault();

	/**
	* Return config's group config.
	*/
	GroupConfig getGroupConfig();

	/**
	* Return the ID of the plug-in that contributed the JPA platform
	* config.
	*/
	String getPluginId();

	/**
	* Build and return the config's JPA platform.
	*/
	JpaPlatform getJpaPlatform();

	Predicate<Config> DEFAULT_FILTER = new DefaultFilter();
	/* CU private */ static class DefaultFilter
	extends Predicate.Adapter<Config>
	{
	@Override
	public boolean evaluate(Config config) {
	return config.isDefault();
	}
	}
	}


	// ******** JPA platform config ********

	/**
	* Metadata that describes a JPA platform group as defined in an
	* extension to the <code>org.eclipse.jpt.jpa.core.jpaPlatforms</code>
	* extension point.
	* <p>
	* See <code>org.eclipse.jpt.jpa.core/plugin.xml:jpaPlatforms</code>.
	* <p>
	* Not intended to be implemented by clients.
	*/
	interface GroupConfig {
	/**
	* Return the config's manager.
	*/
	JpaPlatformManager getJpaPlatformManager();

	/**
	* Return the JPA platform group config's extension-supplied ID.
	* This is unique among all the JPA platform group configs.
	*/
	String getId();

	/**
	* Return the JPA platform group config's extension-supplied label.
	*/
	String getLabel();

	/**
	* Return the JPA platform configs that belong to the group.
	*/
	Iterable<JpaPlatform.Config> getJpaPlatformConfigs();

	/**
	* Return the ID of the plug-in that contributed the JPA platform group
	* config.
	*/
	String getPluginId();
	}
	}