|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JpaProject
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.
Nested Class Summary | |
---|---|
static interface |
JpaProject.Config
The settings used to construct a JPA project. |
static interface |
JpaProject.Updater
Define a strategy that can be used to "update" a JPA project whenever something changes. |
Field Summary | |
---|---|
static java.lang.String |
DISCOVERS_ANNOTATED_CLASSES_PROPERTY
ID string used when discoversAnnotatedClasses property is changed. |
static java.lang.String |
JPA_FILES_COLLECTION
ID string used when jpaFiles collection is changed. |
static java.lang.String |
USER_OVERRIDE_DEFAULT_SCHEMA_NAME_PROPERTY
ID string used when userOverrideDefaultSchemaName property is changed. |
Method Summary | |
---|---|
void |
addToMessages(java.util.List<org.eclipse.wst.validation.internal.provisional.core.IMessage> messages)
Add to the list of current validation messages |
java.util.Iterator<java.lang.String> |
annotatedClassNames()
Return the names of the JPA project's annotated classes. |
boolean |
discoversAnnotatedClasses()
Return whether the JPA project will "discover" annotated classes automatically, as opposed to requiring the classes to be listed in persistence.xml. |
void |
dispose()
The JPA project has been removed from the JPA model. |
ConnectionProfile |
getConnectionProfile()
Return the project's connection |
JpaDataSource |
getDataSource()
Return the data source the JPA project is mapped to. |
Schema |
getDefaultSchema()
Return the primary schema associated with this project, which unless overridden, is the default schema from the connection |
JavaResourcePersistentType |
getJavaPersistentTypeResource(java.lang.String typeName)
Return the Java persistent type resource for the specified fully qualified type name; null, if none exists. |
org.eclipse.jdt.core.IJavaProject |
getJavaProject()
Return the Java project associated with the JPA project. |
JpaFile |
getJpaFile(org.eclipse.core.resources.IFile file)
Return the JPA file corresponding to the specified file. |
JpaPlatform |
getJpaPlatform()
Return the vendor-specific JPA platform that builds the JPA project and its contents. |
CommandExecutorProvider |
getModifySharedDocumentCommandExecutorProvider()
Return the project-wide implementation of the CommandExecutorProvider interface. |
java.lang.String |
getName()
Return the JPA project's name, which is the Eclipse project's name. |
org.eclipse.core.resources.IProject |
getProject()
Return the Eclipse project associated with the JPA project. |
JpaRootContextNode |
getRootContext()
Return the JpaRootContextNode representing the JPA content of this project |
java.lang.String |
getRootDeployLocation()
Return the JPA project's root "deploy path". |
JpaProject.Updater |
getUpdater()
Return the implementation of the Updater interface that will be used to "update" a JPA project. |
Schema |
getUserOverrideDefaultSchema()
Return the user specified schema to be used as a default for this project. |
java.lang.String |
getUserOverrideDefaultSchemaName()
Return the name of the schema to be used as a default for the project instead of the one that is defaultly associated with the connection profile. |
void |
javaElementChanged(org.eclipse.jdt.core.ElementChangedEvent event)
Forward the Java element change event to the JPA project's JPA files. |
java.util.Iterator<JpaFile> |
jpaFiles()
Return the JPA project's JPA files. |
java.util.Iterator<JpaFile> |
jpaFiles(java.lang.String contentTypeId)
Return the JPA project's JPA files for the specified content type ID. |
int |
jpaFilesSize()
Return the size of the JPA project's JPA files. |
void |
setDiscoversAnnotatedClasses(boolean discoversAnnotatedClasses)
Set whether the JPA project will "discover" annotated classes automatically, as opposed to requiring the classes to be listed in persistence.xml. |
void |
setThreadLocalModifySharedDocumentCommandExecutor(CommandExecutor commandExecutor)
Set a thread-specific implementation of the CommandExecutor interface that will be used to execute a command to modify a shared document. |
void |
setUpdater(JpaProject.Updater updater)
Set the implementation of the Updater interface that will be used to "update" a JPA project. |
void |
setUserOverrideDefaultSchemaName(java.lang.String defaultSchemaName)
Set the name of the schema to be used as a default for the project instead of the one that is defaultly associated with the connection profile. |
void |
synchronizeJpaFiles(org.eclipse.core.resources.IResourceDelta delta)
Synchronize the JPA project's JPA files with the specified resource delta, watching for added and removed files. |
void |
update()
Something in the JPA project has changed, "update" those parts of the JPA project that are dependent on other parts of the JPA project. |
org.eclipse.core.runtime.IStatus |
update(org.eclipse.core.runtime.IProgressMonitor monitor)
This is the callback used by the updater to perform the actual "update". |
java.util.Iterator<org.eclipse.wst.validation.internal.provisional.core.IMessage> |
validationMessages()
Return project's validation messages. |
Methods inherited from interface org.eclipse.jpt.core.JpaNode |
---|
getJpaProject, getParent, getResource |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Field Detail |
---|
static final java.lang.String USER_OVERRIDE_DEFAULT_SCHEMA_NAME_PROPERTY
Model.addPropertyChangeListener(String, org.eclipse.jpt.utility.model.listener.PropertyChangeListener)
,
Constant Field Valuesstatic final java.lang.String DISCOVERS_ANNOTATED_CLASSES_PROPERTY
Model.addPropertyChangeListener(String, org.eclipse.jpt.utility.model.listener.PropertyChangeListener)
,
Constant Field Valuesstatic final java.lang.String JPA_FILES_COLLECTION
Model.addCollectionChangeListener(String, org.eclipse.jpt.utility.model.listener.CollectionChangeListener)
,
Constant Field ValuesMethod Detail |
---|
java.lang.String getName()
org.eclipse.core.resources.IProject getProject()
org.eclipse.jdt.core.IJavaProject getJavaProject()
JpaPlatform getJpaPlatform()
ConnectionProfile getConnectionProfile()
Schema getDefaultSchema()
getUserOverrideDefaultSchema()
Schema getUserOverrideDefaultSchema()
getUserOverrideDefaultSchemaName()
JpaDataSource getDataSource()
java.lang.String getUserOverrideDefaultSchemaName()
void setUserOverrideDefaultSchemaName(java.lang.String defaultSchemaName)
boolean discoversAnnotatedClasses()
void setDiscoversAnnotatedClasses(boolean discoversAnnotatedClasses)
java.util.Iterator<JpaFile> jpaFiles()
int jpaFilesSize()
JpaFile getJpaFile(org.eclipse.core.resources.IFile file)
java.util.Iterator<JpaFile> jpaFiles(java.lang.String contentTypeId)
java.lang.String getRootDeployLocation()
JpaRootContextNode getRootContext()
JpaRootContextNode
representing the JPA content of this project
java.util.Iterator<java.lang.String> annotatedClassNames()
JavaResourcePersistentType getJavaPersistentTypeResource(java.lang.String typeName)
void synchronizeJpaFiles(org.eclipse.core.resources.IResourceDelta delta) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreException
void javaElementChanged(org.eclipse.jdt.core.ElementChangedEvent event)
void dispose()
java.util.Iterator<org.eclipse.wst.validation.internal.provisional.core.IMessage> validationMessages()
void addToMessages(java.util.List<org.eclipse.wst.validation.internal.provisional.core.IMessage> messages)
void setThreadLocalModifySharedDocumentCommandExecutor(CommandExecutor commandExecutor)
CommandExecutorProvider getModifySharedDocumentCommandExecutorProvider()
JpaProject.Updater getUpdater()
void setUpdater(JpaProject.Updater updater)
void update()
setUpdater(Updater)
- anything in the JPA project changes
- the JPA project's database connection is changed, opened, or closed
org.eclipse.core.runtime.IStatus update(org.eclipse.core.runtime.IProgressMonitor monitor)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |