Skip navigation links

oracle.jdeveloper.offlinedb.model
Class ProviderSettings

java.lang.Object
oracle.javatools.data.HashStructureAdapter
oracle.jdeveloper.offlinedb.model.ProviderSettings

All Implemented Interfaces:

PropertyStorage

public class ProviderSettings

extends HashStructureAdapter

implements PropertyStorage

Settings for a provider in the offline database.

Field Summary

static java.lang.String

DEFAULT_SCHEMA_NAME

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Fields inherited from interface oracle.javatools.data.PropertyStorage

DATA_KEY

Constructor Summary

ProviderSettings()

Method Summary

ProviderSettings	createCopy() Returns a copy of this settings object.
DataTypeSettings	getDataTypeSettings() Returns the data type settings for this provider.
java.lang.String	getDefaultSchemaName() Returns the settings for the default schema name.
java.lang.String	getDefaultSchemaName(boolean defaultIfNone) Returns the setting for the default schema name.
static ProviderSettings	getDefaultSettings() Gets the default ProviderSettings.
java.lang.Class<? extends oracle.jdevimpl.offlinedb.browser.DBObjectFileWrapper>	getFileWrapperClass() Deprecated.
java.lang.String	getID() Returns a unqiue ID for this provider.
OfflineDBObjectFactory.IDScheme	getIDScheme() Deprecated.
java.lang.String	getName() Returns the name of this provider.
HashStructure	getProperties() Returns the property storage for this settings object.
static ProviderSettings	getSettings(PropertyStorage ps) Creates a settings wrapper around the given property storage.
static boolean	isNameProperty(java.lang.String propertyName)
boolean	needsProviderRestart(ProviderSettings newSettings) Tests whether there are changes in the given settings object compared with the settings in this object that would require a provider restart.
static boolean	needsProviderRestart(java.lang.String propertyName) Returns true if the given fully qualified property name (from the hash) requires a provider restart to be applied.
void	setDefaultSchemaName(java.lang.String name) Set the default schema name (replacing any existing value).
void	setDefaultSchemaName(java.lang.String name, boolean overwrite) Set the default schema name.
void	setFileWrapperClass(java.lang.Class<? extends oracle.jdevimpl.offlinedb.browser.DBObjectFileWrapper> clz) Deprecated.
void	setIDScheme(OfflineDBObjectFactory.IDScheme scheme) Deprecated.
void	setName(java.lang.String name) Sets the name of this provider.

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

DEFAULT_SCHEMA_NAME

public static final java.lang.String DEFAULT_SCHEMA_NAME

Constructor Detail

ProviderSettings

public ProviderSettings()

Method Detail

createCopy

public ProviderSettings createCopy()

Returns a copy of this settings object.

getID

public java.lang.String getID()

Returns a unqiue ID for this provider.

getDataTypeSettings

public DataTypeSettings getDataTypeSettings()

Returns the data type settings for this provider. Please note: changing the datatype settings will mean that the provider will restart in order to perform the correct emulation. This should not be done if the provider contains objects.

getName

public java.lang.String getName()

Returns the name of this provider.

setName

public void setName(java.lang.String name)

Sets the name of this provider. Please note: changing the name of the provider will result in all files within the provider being moved on the filesystem to a new location reflecting the provider's new name.

getDefaultSchemaName

public java.lang.String getDefaultSchemaName(boolean defaultIfNone)

Returns the setting for the default schema name. If one has not been set this will return null. See getDefaultSchemaName().

getDefaultSchemaName

public java.lang.String getDefaultSchemaName()

Returns the settings for the default schema name. If one has not been set this will return a default of "SCHEMA1". See getSchemaName().

setDefaultSchemaName

public void setDefaultSchemaName(java.lang.String name)

Set the default schema name (replacing any existing value).

setDefaultSchemaName

public void setDefaultSchemaName(java.lang.String name,
                                 boolean overwrite)

Set the default schema name. Optionally won't overwrite an existing value.

getFileWrapperClass

@Deprecated
public java.lang.Class<? extends oracle.jdevimpl.offlinedb.browser.DBObjectFileWrapper> getFileWrapperClass()

Deprecated.

Gets the default wrapper class that will be used by the provider when loading objects from file.

setFileWrapperClass

@Deprecated
public void setFileWrapperClass(java.lang.Class<? extends oracle.jdevimpl.offlinedb.browser.DBObjectFileWrapper> clz)

Deprecated.

Sets the default wrapper class that will be used by the provider when loading objects from file.

getIDScheme

@Deprecated
public OfflineDBObjectFactory.IDScheme getIDScheme()

Deprecated.

Gets the ID scheme that the provider's factory will use when ensuring that objects have an ID.

setIDScheme

@Deprecated
public void setIDScheme(OfflineDBObjectFactory.IDScheme scheme)

Deprecated.

Sets the ID scheme that the provider's factory will use when ensuring that objects have an ID.

needsProviderRestart

public final boolean needsProviderRestart(ProviderSettings newSettings)

Tests whether there are changes in the given settings object compared with the settings in this object that would require a provider restart.

Returns:

true if the a provider restart will be required when the given newSettings are applied to these settings.

See Also:

needsProviderRestart(String)

isNameProperty

public static final boolean isNameProperty(java.lang.String propertyName)

needsProviderRestart

public static final boolean needsProviderRestart(java.lang.String propertyName)

Returns true if the given fully qualified property name (from the hash) requires a provider restart to be applied.

getSettings

public static final ProviderSettings getSettings(PropertyStorage ps)

Creates a settings wrapper around the given property storage.

getProperties

public HashStructure getProperties()

Returns the property storage for this settings object. This can be used by downstream extensions that want to store extra properties in the provider settings object.

Specified by:

getProperties in interface PropertyStorage

Returns:

The HashStructure wrapped by this PropertyStorage.

getDefaultSettings

public static ProviderSettings getDefaultSettings()

Gets the default ProviderSettings. If these are changed in any way then subsequent calls to new ProviderSettings() will automatically contain these defaults.

Skip navigation links