persistence.xml and mapping
* (orm.xml) files.
* The org.eclipse.jpt.core.generic 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.
* * 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. *
* See the org.eclipse.jpt.core.jpaPlatforms extension point.
* @see JpaPlatformFactory
* @see JpaPlatformProvider
*/
public interface JpaPlatform
{
/**
* Get the ID for this platform
*/
String getId();
/**
* Get the version object for this platform.
*/
Version getJpaVersion();
// ********** factory **********
/**
* Return a factory responsible for creating core (e.g. JpaProject), resource
* (e.g. PersistenceResource), and context (e.g. PersistenceUnit) model
* objects
*/
JpaFactory getJpaFactory();
// ********** JPA files **********
/**
* Return a JPA file corresponding to the specified Eclipse file.
* Return null if the file's content is unsupported.
*/
JpaFile buildJpaFile(JpaProject jpaProject, IFile file);
// ********** Java annotations **********
/**
* Return an annotation provider responsible for determining what Java
* annotations are supported and constructing java resource model objects.
*/
JpaAnnotationProvider getAnnotationProvider();
/**
* Return a formatter that can clean up the Java annotations added to source
* code.
*/
AnnotationEditFormatter getAnnotationEditFormatter();
// ********** Java type/attribute mappings **********
/**
* Return a {@link JavaTypeMappingDefinition} that describes the interpretation of the type
* as it exists, complete with annotations.
* This may not be null (@see {@link NullJavaTypeMappingDefinition},) else
* an {@link IllegalStateException} is thrown.
*
* @param type The persistent type to analyze
* @return The mapping definition used to describe the annotated state of the type
*/
JavaTypeMappingDefinition getJavaTypeMappingDefinition(JavaPersistentType type);
/**
* Return a {@link JavaTypeMappingDefinition} for the given mapping key.
* Throw an {@link IllegalArgumentException} if the key is not supported by the platform.
*/
JavaTypeMappingDefinition getJavaTypeMappingDefinition(String mappingKey);
/**
* Return a {@link JavaAttributeMappingDefinition} that describes the interpretation of the attribute
* as it exists, ignoring all annotations.
* This may not be null (@see {@link NullDefaultJavaAttributeMappingDefinition},) else
* an {@link IllegalStateException} is thrown.
*
* @param attribute The persistent attribute to analyze
* @return The mapping definition describing the unannotated state of the attribute
*/
JavaAttributeMappingDefinition getDefaultJavaAttributeMappingDefinition(JavaPersistentAttribute attribute);
/**
* Return a {@link JavaAttributeMappingDefinition} that describes the interpretation of the attribute
* as it exists, complete with annotations. It is assumed that the attribute's default mapping
* has already been determined.
* This may not be null (@see {@link NullSpecifiedJavaAttributeMappingDefinition},) else
* an {@link IllegalStateException} is thrown.
*
* @param attribute The persistent attribute to analyze
* @return The mapping definition describing the annotated state of the attribute
*/
JavaAttributeMappingDefinition getSpecifiedJavaAttributeMappingDefinition(JavaPersistentAttribute attribute);
/**
* Return a {@link JavaAttributeMappingDefinition} for the given mapping key.
* Throw an {@link IllegalArgumentException} if the key is not supported by the platform.
*/
JavaAttributeMappingDefinition getSpecifiedJavaAttributeMappingDefinition(String mappingKey);
// ********** Mapping Files **********
/**
* Return a {@link ResourceDefinition} to describe the context model for a file of the given
* resource type.
* Thrown an {@link IllegalArgumentException} if the resource type is not supported by the platform.
*
* @param resourceType The resource type of a potential mapping file
* @return The resource definition that can be used to describe the context model of such
* a file
*/
ResourceDefinition getResourceDefinition(JpaResourceType resourceType);
// ********** database **********
/**
* Return a connection repository that can be used to query the database
* about database metadata.
*/
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();
/**
* Return a finder that can be used to look up various objects (schemata,
* tables, columns, etc.) on the database, respecting the platform's and
* database's case-sensitivity.
*/
DatabaseFinder getDatabaseFinder();
// ********** platform variation **********
/**
* Return a platform variation that is used to determine differences platforms and/or JPA specification versions
*/
JpaPlatformVariation getJpaVariation();
interface Version
{
/**
* Return the platform's version.
*/
String getVersion();
/**
* Return the highest JPA specification version supported by the platform.
* @see JptCorePlugin#JPA_FACET_VERSION_1_0
* @see JptCorePlugin#JPA_FACET_VERSION_2_0
*/
String getJpaVersion();
/**
* Return whether the platform is compatible with the specified JPA
* specification version.
* @see JptCorePlugin#JPA_FACET_VERSION_1_0
* @see JptCorePlugin#JPA_FACET_VERSION_2_0
*/
boolean isCompatibleWithJpaVersion(String jpaVersion);
}
}