org.eclipse.jpt.jpa.core
Class JpaPreferences

java.lang.Object
  org.eclipse.jpt.jpa.core.JpaPreferences

public final class JpaPreferences
extends Object

Public access to the Dali JPA preferences.

Preferences are a cross between public, model-related state and private, plug-in-related state; thus this public facade to state that is (traditionally) scoped by the source code's plug-in location. Another complication is that preferences must be available even when a model is not (yet) present (e.g. for a "creation" wizard).

Provisional API: This class 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:

3.2

Field Summary

static String	PROBLEM_ERROR
static String	PROBLEM_IGNORE
static String	PROBLEM_INFO
static String	PROBLEM_WARNING

Method Summary

static String	convertMessageSeverityToPreferenceValue(int severity) Convert the specified validation message severity to the corresponding problem severity preference value.
static String	getConnectionProfileName(IProject project) This preference is set in the workspace's metadata, not in the project's metadata.
static boolean	getDiscoverAnnotatedClasses(IProject project)
static String	getEntityGenDefaultPackageName()
static String	getEntityGenDefaultPackageName(IProject project)
static String	getJpaPlatformID(IProject project)
static boolean	getJpqlIdentifierLowercase()
static boolean	getJpqlIdentifierLowercaseDefault()
static boolean	getJpqlIdentifierMatchFirstCharacterCase()
static boolean	getJpqlIdentifierMatchFirstCharacterCaseDefault()
static int	getJpqlQueryTextAreaNumberOfLines()
static int	getJpqlQueryTextAreaNumberOfLinesDefault()
static String	getMetamodelSourceFolderName(IProject project)
static String	getProblemSeverity(IProject project, String messageID) Project-level problem preference.
static String	getProblemSeverity(String messageID) Workspace-level problem preference.
static String	getUserOverrideDefaultCatalog(IProject project) This preference is set in the workspace's metadata, not in the project's metadata.
static String	getUserOverrideDefaultSchema(IProject project) This preference is set in the workspace's metadata, not in the project's metadata.
static int	getValidationMessageSeverity(IProject project, String messageID, int defaultSeverity) Project-level validation message preference.
static boolean	getWorkspaceValidationPreferencesOverridden(IProject project)
static void	initializeDefaultPreferences() Internal: Called only by the JPA preferences initializer.
static void	removePreferences()
static void	removePreferences(IProject project) Remove both the project's settings and the workspace settings related to the project.
static void	setConnectionProfileName(IProject project, String name) This preference is set in the workspace's metadata, not in the project's metadata.
static void	setDiscoverAnnotatedClasses(IProject project, boolean value)
static void	setEntityGenDefaultPackageName(IProject project, String name)
static void	setEntityGenDefaultPackageName(String name)
static void	setJpaPlatformID(IProject project, String id)
static void	setJpqlIdentifierLowercase(boolean value)
static void	setJpqlIdentifierMatchFirstCharacterCase(boolean value)
static void	setJpqlQueryTextAreaNumberOfLines(int value)
static void	setMetamodelSourceFolderName(IProject project, String name)
static void	setProblemSeverity(IProject project, String messageID, String value) Project-level problem preference.
static void	setProblemSeverity(String messageID, String value) Workspace-level problem preference.
static void	setUserOverrideDefaultCatalog(IProject project, String catalog) This preference is set in the workspace's metadata, not in the project's metadata.
static void	setUserOverrideDefaultSchema(IProject project, String schema) This preference is set in the workspace's metadata, not in the project's metadata.
static void	setWorkspaceValidationPreferencesOverridden(IProject project, boolean value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROBLEM_ERROR

public static final String PROBLEM_ERROR

See Also:

Constant Field Values

PROBLEM_WARNING

public static final String PROBLEM_WARNING

See Also:

Constant Field Values

PROBLEM_INFO

public static final String PROBLEM_INFO

See Also:

Constant Field Values

PROBLEM_IGNORE

public static final String PROBLEM_IGNORE

See Also:

Constant Field Values

Method Detail

getJpaPlatformID

public static String getJpaPlatformID(IProject project)

setJpaPlatformID

public static void setJpaPlatformID(IProject project,
                                    String id)

getDiscoverAnnotatedClasses

public static boolean getDiscoverAnnotatedClasses(IProject project)

setDiscoverAnnotatedClasses

public static void setDiscoverAnnotatedClasses(IProject project,
                                               boolean value)

getMetamodelSourceFolderName

public static String getMetamodelSourceFolderName(IProject project)

setMetamodelSourceFolderName

public static void setMetamodelSourceFolderName(IProject project,
                                                String name)

getEntityGenDefaultPackageName

public static String getEntityGenDefaultPackageName(IProject project)

setEntityGenDefaultPackageName

public static void setEntityGenDefaultPackageName(IProject project,
                                                  String name)

getEntityGenDefaultPackageName

public static String getEntityGenDefaultPackageName()

setEntityGenDefaultPackageName

public static void setEntityGenDefaultPackageName(String name)

getUserOverrideDefaultCatalog

public static String getUserOverrideDefaultCatalog(IProject project)

This preference is set in the workspace's metadata, not in the project's metadata.

setUserOverrideDefaultCatalog

public static void setUserOverrideDefaultCatalog(IProject project,
                                                 String catalog)

This preference is set in the workspace's metadata, not in the project's metadata.

getUserOverrideDefaultSchema

public static String getUserOverrideDefaultSchema(IProject project)

This preference is set in the workspace's metadata, not in the project's metadata.

setUserOverrideDefaultSchema

public static void setUserOverrideDefaultSchema(IProject project,
                                                String schema)

This preference is set in the workspace's metadata, not in the project's metadata.

getConnectionProfileName

public static String getConnectionProfileName(IProject project)

This preference is set in the workspace's metadata, not in the project's metadata.

setConnectionProfileName

public static void setConnectionProfileName(IProject project,
                                            String name)

This preference is set in the workspace's metadata, not in the project's metadata.

getJpqlIdentifierLowercase

public static boolean getJpqlIdentifierLowercase()

getJpqlIdentifierLowercaseDefault

public static boolean getJpqlIdentifierLowercaseDefault()

setJpqlIdentifierLowercase

public static void setJpqlIdentifierLowercase(boolean value)

getJpqlIdentifierMatchFirstCharacterCase

public static boolean getJpqlIdentifierMatchFirstCharacterCase()

getJpqlIdentifierMatchFirstCharacterCaseDefault

public static boolean getJpqlIdentifierMatchFirstCharacterCaseDefault()

setJpqlIdentifierMatchFirstCharacterCase

public static void setJpqlIdentifierMatchFirstCharacterCase(boolean value)

getJpqlQueryTextAreaNumberOfLinesDefault

public static int getJpqlQueryTextAreaNumberOfLinesDefault()

getJpqlQueryTextAreaNumberOfLines

public static int getJpqlQueryTextAreaNumberOfLines()

setJpqlQueryTextAreaNumberOfLines

public static void setJpqlQueryTextAreaNumberOfLines(int value)

getWorkspaceValidationPreferencesOverridden

public static boolean getWorkspaceValidationPreferencesOverridden(IProject project)

setWorkspaceValidationPreferencesOverridden

public static void setWorkspaceValidationPreferencesOverridden(IProject project,
                                                               boolean value)

getValidationMessageSeverity

public static int getValidationMessageSeverity(IProject project,
                                               String messageID,
                                               int defaultSeverity)

Project-level validation message preference. Return -1 if the specified message is to be ignored.

See Also:

org.eclipse.wst.validation.internal.provisional.core.IMessage#getSeverity()

convertMessageSeverityToPreferenceValue

public static String convertMessageSeverityToPreferenceValue(int severity)

Convert the specified validation message severity to the corresponding problem severity preference value.

See Also:

getProblemSeverity(String), getProblemSeverity(IProject, String), IMessage#getSeverity(), ValidationMessage.getDefaultSeverity()

getProblemSeverity

public static String getProblemSeverity(IProject project,
                                        String messageID)

Project-level problem preference.

See Also:

PROBLEM_ERROR, PROBLEM_WARNING, PROBLEM_INFO, PROBLEM_IGNORE

setProblemSeverity

public static void setProblemSeverity(IProject project,
                                      String messageID,
                                      String value)

Project-level problem preference.

See Also:

PROBLEM_ERROR, PROBLEM_WARNING, PROBLEM_INFO, PROBLEM_IGNORE

getProblemSeverity

public static String getProblemSeverity(String messageID)

Workspace-level problem preference.

See Also:

PROBLEM_ERROR, PROBLEM_WARNING, PROBLEM_INFO, PROBLEM_IGNORE

setProblemSeverity

public static void setProblemSeverity(String messageID,
                                      String value)

Workspace-level problem preference.

See Also:

PROBLEM_ERROR, PROBLEM_WARNING, PROBLEM_INFO, PROBLEM_IGNORE

initializeDefaultPreferences

public static void initializeDefaultPreferences()

Internal: Called only by the JPA preferences initializer.

removePreferences

public static void removePreferences(IProject project)

Remove both the project's settings and the workspace settings related to the project.

removePreferences

public static void removePreferences()