Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.5.0)

E13403-06


oracle.jdeveloper.offlinedb.model
Class OfflineDBProjectSettings

java.lang.Object
  extended by oracle.javatools.data.HashStructureAdapter
      extended by oracle.jdeveloper.offlinedb.model.OfflineDBProjectSettings


public class OfflineDBProjectSettings
extends HashStructureAdapter

Object to encapsulate offline database settings in a project's configuration. This object is added to the common data of a project when it is first given an OfflineDBObjectProvider. Provides access to offline database information such as the database path under which the offline objects' .xml files are stored.


Field Summary
static java.lang.String CONTENT_SET_KEY
           
static java.lang.String CONTENT_SET_LOCAL_KEY
           
static java.lang.String DATABASE_PATH
          Deprecated. - use CONTENT_SET_KEY
static java.lang.String DATABASE_SETTINGS_KEY
          Key to use for storage of the modeler project specific settings
static java.lang.String DATATYPE_SETTINGS_KEY
           
static java.lang.String DEFAULT_SCHEMA_NAME
           
static java.lang.String SCHEMA_KEY
           

 

Fields inherited from class oracle.javatools.data.HashStructureAdapter
_hash

 

Method Summary
 OfflineDBProjectSettings createCopy()
          Returns a copy of this project settings object.
static OfflineDBProjectSettings createDatabaseSettings(Project proj)
          Create default settings on the given project.
static OfflineDBProjectSettings createDatabaseSettings(Project proj, boolean userSettings, boolean defaultProject)
          Creates offline database settings for the given project and sets them in the common data appropriately.
static void ensureContentSetDefaults(ContentSet contentSet, Project proj)
           
 ContentSet getContentSet()
          Returns the ContentSet for these OfflineDBProjectSettings.
static OfflineDBProjectSettings getDatabaseSettings(Project project)
          Given a project, returns the offline database settings stored for that project.
static OfflineDBProjectSettings getDatabaseSettings(Project proj, HashStructure props)
          Given a PropertyStorage object, returns the offline database settings.
 DataTypeSettings getDataTypeSettings()
          Deprecated. - moved to ProviderSettings
static java.lang.String getDefaultDatabasePath()
          Returns the default database path settings for the IDE.
static java.net.URL getDefaultDatabasePath(Locatable proj)
          Given a project this creates a default database path relative the project's base URL and returns the URL of the new directory.
 java.lang.String getDefaultSchemaName()
          Deprecated. - moved to ProviderSettings
 java.lang.String getDefaultSchemaName(boolean defaultIfNone)
          Deprecated. - moved to ProviderSettings
 void setDefaultSchemaName(java.lang.String name)
          Deprecated. - moved to ProviderSettings
 void setDefaultSchemaName(java.lang.String name, boolean overwrite)
          Deprecated. - moved to ProviderSettings

 

Methods inherited from class oracle.javatools.data.HashStructureAdapter
addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals

 

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

DATABASE_SETTINGS_KEY

public static final java.lang.String DATABASE_SETTINGS_KEY
Key to use for storage of the modeler project specific settings

CONTENT_SET_LOCAL_KEY

public static final java.lang.String CONTENT_SET_LOCAL_KEY
See Also:
Constant Field Values

CONTENT_SET_KEY

public static final java.lang.String CONTENT_SET_KEY

DATATYPE_SETTINGS_KEY

public static final java.lang.String DATATYPE_SETTINGS_KEY
See Also:
Constant Field Values

SCHEMA_KEY

public static final java.lang.String SCHEMA_KEY
See Also:
Constant Field Values

DEFAULT_SCHEMA_NAME

public static final java.lang.String DEFAULT_SCHEMA_NAME

DATABASE_PATH

@Deprecated
public static final java.lang.String DATABASE_PATH
Deprecated. - use CONTENT_SET_KEY
See Also:
Constant Field Values

Method Detail

createCopy

public OfflineDBProjectSettings createCopy()
Returns a copy of this project settings object.

getContentSet

public ContentSet getContentSet()
Returns the ContentSet for these OfflineDBProjectSettings.

getDataTypeSettings

@Deprecated
public DataTypeSettings getDataTypeSettings()
Deprecated. - moved to ProviderSettings

getDefaultSchemaName

@Deprecated
public java.lang.String getDefaultSchemaName(boolean defaultIfNone)
Deprecated. - moved to ProviderSettings
Returns the setting for the default schema name. If one has not been set this will return null. See getDefaultSchemaName().

getDefaultSchemaName

@Deprecated
public java.lang.String getDefaultSchemaName()
Deprecated. - moved to ProviderSettings
Returns the settings for the default schema name. If one has not been set this will return a default of "MYSCHEMA". See getSchemaName().

setDefaultSchemaName

@Deprecated
public void setDefaultSchemaName(java.lang.String name)
Deprecated. - moved to ProviderSettings
Set the default schema name (replacing any existing value).

setDefaultSchemaName

@Deprecated
public void setDefaultSchemaName(java.lang.String name,
                                            boolean overwrite)
Deprecated. - moved to ProviderSettings
Set the default schema name. Optionally won't overwrite an existing value.

getDatabaseSettings

public static OfflineDBProjectSettings getDatabaseSettings(Project project)
Given a project, returns the offline database settings stored for that project. Returns null if the project doesn't already have any offline db settings. Will return the user specific settings if they exist and are valid, otherwise returns the shared settings.

getDatabaseSettings

public static OfflineDBProjectSettings getDatabaseSettings(Project proj,
                                                           HashStructure props)
Given a PropertyStorage object, returns the offline database settings. Returns null if the object contains no offline db settings.

getDefaultDatabasePath

public static java.net.URL getDefaultDatabasePath(Locatable proj)
Given a project this creates a default database path relative the project's base URL and returns the URL of the new directory.

getDefaultDatabasePath

public static java.lang.String getDefaultDatabasePath()
Returns the default database path settings for the IDE. "database" by default.

createDatabaseSettings

public static OfflineDBProjectSettings createDatabaseSettings(Project proj)
Create default settings on the given project.

createDatabaseSettings

public static OfflineDBProjectSettings createDatabaseSettings(Project proj,
                                                              boolean userSettings,
                                                              boolean defaultProject)
Creates offline database settings for the given project and sets them in the common data appropriately. The new settings are returned. This will OVERWRITE existing settings if there are any - check them using getDatabaseSettings() first.
Parameters:
proj - the project to create the settings for
propertydata - the data container for the settings
userSettings - whether this is the user specific settings
defaultProject - whether this is the default project

ensureContentSetDefaults

public static void ensureContentSetDefaults(ContentSet contentSet,
                                            Project proj)

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.5.0)

E13403-06


Copyright © 1997, 2011, Oracle. All rights reserved.