org.eclipse.jpt.core.jpa2
Interface JpaProject2_0

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaNode, JpaProject, MetamodelSynchronizer, Model

public interface JpaProject2_0
extends JpaProject, MetamodelSynchronizer

JPA 2.0 project.

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.

Since:

2.3

Version:

2.3

Nested Class Summary

static interface

JpaProject2_0.Config The settings used to construct a JPA 2.0 project.

Nested classes/interfaces inherited from interface org.eclipse.jpt.core.JpaProject

JpaProject.Updater

Nested classes/interfaces inherited from interface org.eclipse.jpt.core.jpa2.MetamodelSynchronizer

MetamodelSynchronizer.Null

Field Summary

static java.lang.String

METAMODEL_SOURCE_FOLDER_NAME_PROPERTY ID string used when metamodelSourceFolderName property is changed.

Fields inherited from interface org.eclipse.jpt.core.JpaProject

DISCOVERS_ANNOTATED_CLASSES_PROPERTY, EXTERNAL_JAVA_RESOURCE_COMPILATION_UNITS_COLLECTION, JPA_FILES_COLLECTION, USER_OVERRIDE_DEFAULT_CATALOG_PROPERTY, USER_OVERRIDE_DEFAULT_SCHEMA_PROPERTY

Method Summary

JavaResourcePersistentType2_0	getGeneratedMetamodelTopLevelType(org.eclipse.core.resources.IFile file) Return the top-level generated metamodel Java resource persistent type in the specified file.
java.lang.Iterable<JavaResourcePersistentType2_0>	getGeneratedMetamodelTopLevelTypes() Return the JPA project's generated metamodel Java resource persistent top-level types.
java.lang.Iterable<java.lang.String>	getJavaSourceFolderNames() Return a list of the names of the Java source folders.
org.eclipse.jdt.core.IPackageFragmentRoot	getMetamodelPackageFragmentRoot() Return the package fragment root that holds the generated Canonical Metamodel.
java.lang.String	getMetamodelSourceFolderName() Return the name of the folder that holds the generated Canonical Metamodel.
void	setMetamodelSourceFolderName(java.lang.String metamodelSourceFolderName) Set the name of the folder that holds the generated Canonical Metamodel.

Methods inherited from interface org.eclipse.jpt.core.JpaProject

annotatedJavaSourceClassNames, convertToPlatformFile, discoversAnnotatedClasses, dispose, externalJavaResourceCompilationUnits, externalJavaResourceCompilationUnitsSize, getConnectionProfile, getDataSource, getDefaultCatalog, getDefaultDbCatalog, getDefaultDbSchema, getDefaultDbSchemaContainer, getDefaultOrmXmlResource, getDefaultSchema, getExternalJavaResourcePersistentTypeCache, getJavaProject, getJavaResourcePackageFragmentRoot, getJavaResourcePersistentType, getJpaFile, getJpaPlatform, getMappingFileXmlResource, getModifySharedDocumentCommandExecutor, getName, getPersistenceXmlResource, getProject, getRootContextNode, getUpdater, getUserOverrideDefaultCatalog, getUserOverrideDefaultSchema, javaElementChanged, jpaFiles, jpaFilesSize, mappedJavaSourceClassNames, projectChanged, setDiscoversAnnotatedClasses, setThreadLocalModifySharedDocumentCommandExecutor, setUpdater, setUserOverrideDefaultCatalog, setUserOverrideDefaultSchema, synchronizeContextModel, update, update, updateQuiesced, validationMessages

Methods inherited from interface org.eclipse.jpt.core.JpaNode

getJpaProject, getParent

Methods inherited from interface org.eclipse.jpt.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.core.IResourcePart

getResource

Methods inherited from interface org.eclipse.jpt.core.jpa2.MetamodelSynchronizer

disposeMetamodel, initializeMetamodel, synchronizeMetamodel

Field Detail

METAMODEL_SOURCE_FOLDER_NAME_PROPERTY

static final java.lang.String METAMODEL_SOURCE_FOLDER_NAME_PROPERTY

ID string used when metamodelSourceFolderName property is changed.

See Also:

Model.addPropertyChangeListener(String, org.eclipse.jpt.utility.model.listener.PropertyChangeListener), Constant Field Values

Method Detail

getMetamodelSourceFolderName

java.lang.String getMetamodelSourceFolderName()

Return the name of the folder that holds the generated Canonical Metamodel.

setMetamodelSourceFolderName

void setMetamodelSourceFolderName(java.lang.String metamodelSourceFolderName)

Set the name of the folder that holds the generated Canonical Metamodel.

getMetamodelPackageFragmentRoot

org.eclipse.jdt.core.IPackageFragmentRoot getMetamodelPackageFragmentRoot()

Return the package fragment root that holds the generated Canonical Metamodel.

getJavaSourceFolderNames

java.lang.Iterable<java.lang.String> getJavaSourceFolderNames()

Return a list of the names of the Java source folders. (These can be used to hold the generated Canonical Metamodel.)

getGeneratedMetamodelTopLevelTypes

java.lang.Iterable<JavaResourcePersistentType2_0> getGeneratedMetamodelTopLevelTypes()

Return the JPA project's generated metamodel Java resource persistent top-level types.

See Also:

org.eclipse.jpt.core.internal.resource.java.source.SourcePersistentType#isGeneratedMetamodel(IPackageFragmentRoot)

getGeneratedMetamodelTopLevelType

JavaResourcePersistentType2_0 getGeneratedMetamodelTopLevelType(org.eclipse.core.resources.IFile file)

Return the top-level generated metamodel Java resource persistent type in the specified file. Return null if any of the following is true:

• the file is not a Java source file
• the top-level Java class is not annotated with the appropriate javax.annotation.Generated annotation
• neither the top-level Java class nor any of its nested classes is annotated with the appropriate javax.persistence.metamodel.StaticMetamodel annotation