Oracle Fusion Middleware Java API Reference for Oracle ADF Share
11g Release 1 (11.1.1)

E10686-04

oracle.adf.share.prefs
Class ADFPreferencesManager

java.lang.Object
  extended by oracle.adf.share.prefs.ADFPreferencesManager

public class ADFPreferencesManager
extends java.lang.Object

Since:
release specific (what release of product did this appear in)

Field Summary
protected static java.lang.String PREFS_MDS_ROOT
          The root path chosen to house the preferences documents in the associated MDS repository.
protected static java.lang.String PREFS_MDS_ROOT_WITH_SLASH
           
protected static java.lang.String SHARED_PREFS_MDS_ROOT
          The root path chosen to house the shared preferences documents in the associated MDS repository.
protected static java.lang.String SHARED_PREFS_MDS_ROOT_WITH_SLASH
           
protected static java.lang.String USER
          String used in user pref prefixation
protected static int USER_LENGTH
          int used in user pref prefixation length
 
Method Summary
protected  ADFPreferencesConfig getConfig()
          Returns the ADFPreferencesConfig object associated with this manager.
protected  java.lang.String getKeyPrefix()
          Returns the value of the Key Prefix.
protected  PreferenceLevel getLevel()
          Returns the Preference Level associated with this manager object.
protected  oracle.adf.share.prefs.MDSHelper getMDSHelper()
          Returns the MDSHelper object.
protected  ADFPreferences getPreference(ADFPreferences parent, java.lang.String name)
          Main accessor method to the ADFPreferences objects.
protected  ADFPreferences getRootNode()
          The root node accessor method
protected  java.lang.String getRootPath()
          Returns the root path without a trailing slash.
protected  java.lang.String getRootPathSlashAppended()
          Returns the root path with a trailing slash.
protected  boolean isUserPreference()
          Return TRUE if the level corresponds to one of the flavors of the "user" precedences.
protected  void removePreferenceFromNamespaceMap(java.lang.String namespace)
          This method removes a named preference from the persisted map.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

USER

protected static final java.lang.String USER
String used in user pref prefixation

See Also:
Constant Field Values

USER_LENGTH

protected static final int USER_LENGTH
int used in user pref prefixation length


PREFS_MDS_ROOT

protected static final java.lang.String PREFS_MDS_ROOT
The root path chosen to house the preferences documents in the associated MDS repository. Along with the associated mds runtime configuration update to the metadata-namespaces element, this is the one other place to update should the location of the preferences store change.

See Also:
Constant Field Values

PREFS_MDS_ROOT_WITH_SLASH

protected static final java.lang.String PREFS_MDS_ROOT_WITH_SLASH
See Also:
Constant Field Values

SHARED_PREFS_MDS_ROOT

protected static final java.lang.String SHARED_PREFS_MDS_ROOT
The root path chosen to house the shared preferences documents in the associated MDS repository. Along with the associated mds runtime configuration update to the metadata-namespaces element, this is the one other place to update should the location of the shared preferences store change.

See Also:
Constant Field Values

SHARED_PREFS_MDS_ROOT_WITH_SLASH

protected static final java.lang.String SHARED_PREFS_MDS_ROOT_WITH_SLASH
See Also:
Constant Field Values
Method Detail

getKeyPrefix

protected java.lang.String getKeyPrefix()
Returns the value of the Key Prefix.

Returns:
The value of the Key Prefix.

getPreference

protected ADFPreferences getPreference(ADFPreferences parent,
                                       java.lang.String name)
Main accessor method to the ADFPreferences objects. This method attempts to obtain the preference objects from a map of pre-build preferences. If the preference is not in the map it is created.

Parameters:
parent - The parent preference object.
name - The name of the preference node to be returned as a child of the parent
Returns:
The preference object.

removePreferenceFromNamespaceMap

protected void removePreferenceFromNamespaceMap(java.lang.String namespace)
This method removes a named preference from the persisted map.

Parameters:
namespace - The namespace to remove from the namespace map.

getRootNode

protected ADFPreferences getRootNode()
The root node accessor method

Returns:
The root node associated with this manager class.

getRootPath

protected java.lang.String getRootPath()
Returns the root path without a trailing slash.

Returns:
the root path without a trailing slash.

getRootPathSlashAppended

protected java.lang.String getRootPathSlashAppended()
Returns the root path with a trailing slash.

Returns:
the root path with a trailing slash.

isUserPreference

protected boolean isUserPreference()
Return TRUE if the level corresponds to one of the flavors of the "user" precedences.

Returns:
True, if precedence level passed corresponds to one of the "user" precedences.

getLevel

protected PreferenceLevel getLevel()
Returns the Preference Level associated with this manager object.

Returns:
the Preference Level.

getConfig

protected ADFPreferencesConfig getConfig()
Returns the ADFPreferencesConfig object associated with this manager.

Returns:
the ADFPreferencesConfig object

getMDSHelper

protected oracle.adf.share.prefs.MDSHelper getMDSHelper()
Returns the MDSHelper object.

Returns:
the MDSHelper object.

Oracle Fusion Middleware Java API Reference for Oracle ADF Share
11g Release 1 (11.1.1)

E10686-04

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