NavigatorConfigurationIF (Ontopia)

All Known Implementing Classes:

BrokenNavigatorConfiguration, NavigatorConfiguration
```
public interface NavigatorConfigurationIF
```
INTERNAL: Implemented by an object which stores configuration information needed by the navigator.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALLOW_LOAD_ON_REQUEST`
`static String`	`ASSOC_CONTEXT_DECIDER`
`static String`	`BASENAME_CONTEXT_DECIDER`
`static String`	`CHECK_FOR_CHANGED_MODULES`
`static String`	`DEF_CHAR_ENCODING`
`static String`	`DEF_COMPARATOR`
`static String`	`DEF_CONTENT_TYPE`
`static String`	`DEF_DECIDER`
`static String`	`DEF_FUNC_ONTRUNCATE`
`static int`	`DEF_VAL_MAX_LIST_LENGTH`
`static int`	`DEF_VAL_USERACTION_LOG_LENGTH`
`static String`	`DEFVAL_COMPARATOR`
`static String`	`DEFVAL_DECIDER`
`static String`	`DEFVAL_OCC_EMPTYLOC`
`static String`	`DEFVAL_OCC_EMPTYVALUE`
`static String`	`DEFVAL_OCC_NULLLOC`
`static String`	`DEFVAL_OCC_NULLVALUE`
`static String`	`DEFVAL_OCCTYPE_DEFAULT`
`static String`	`DEFVAL_OCCTYPE_DESCRIPTION`
`static String`	`DEFVAL_OCCTYPE_METADATA`
`static String`	`MAX_LIST_LENGTH`
`static String`	`MODULE_READER`
`static String`	`NAMESTRING_EMPTYVALUE`
`static String`	`NAMESTRING_NONEXISTENT`
`static String`	`NAMESTRING_NULLVALUE`
`static String`	`OCC_CONTEXT_DECIDER`
`static String`	`OCCTYPE_DEFAULT`
`static String`	`OCCTYPE_DESCRIPTION`
`static String`	`OCCTYPE_METADATA`
`static String`	`OCCURRENCE_EMPTYLOCATOR`
`static String`	`OCCURRENCE_EMPTYVALUE`
`static String`	`OCCURRENCE_NULLLOCATOR`
`static String`	`OCCURRENCE_NULLVALUE`
`static String`	`PLUGINS_ORDER` Common base name for those properties specifying the display order of the plugins.
`static String`	`USERACTION_LOG_LENGTH`
`static String`	`VARIANT_CONTEXT_DECIDER`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPlugin(PluginIF aPlugin)` Add a plugin to list of known plugins.
`Collection`	`getAutoloadTopicMaps()` Get Set of Topicmaps which are supposed to be autoloaded by application as a `Collection` of TopicMap ID Strings (used by TopicMapRegistry).
`String`	`getClass(String shortcut)` Get full-qualified java classname for the specified shortcut name, which can be used by the some tags as attribute value.
`Map`	`getClassmap()` Get Java-Classname Mapping as a Map containing key (=shortcut) - value (=full class name) pairs.
`String`	`getDefaultModel()` Retrieve the name of the application default model.
`String`	`getDefaultSkin()` Retrieve the name of the application default skin.
`String`	`getDefaultView()` Retrieve the name of the application default view.
`Collection`	`getModels()` Get all available models.
`MVSConfig`	`getMVSConfig()` get storage object for Model/View/Skin settings.
`Collection`	`getOrderedPlugins()` Get all plugins independent of their state in alphabetical order.
`PluginIF`	`getPlugin(String id)` Returns plugin object for specified identifier.
`List`	`getPluginGroups()` Return a list of all available plugin groups, that is achieved by looping over all existing plugins and gather all distinct groups..
`Collection`	`getPlugins()` Return all plugin objects stored whatever their state (activated, deactivated) is.
`Collection`	`getPlugins(String groupId)` Return plugin objects stored whatever their state (activated, deactivated) is that match the specified `groupId`.
`Map`	`getProperties()` Get all Configuration Properties as a Map containing key (=property-name) - value pairs.
`String`	`getProperty(String name)` Get Property value as String for specified name.
`int`	`getProperty(String name, int defaultValue)` INTERNAL: Get Property value as int for specified name.
`String`	`getProperty(String name, String defaultValue)` Get Property value as String for specified name.
`Collection`	`getSkins()` Get all available skins.
`Collection`	`getViews()` Get all available views.
`boolean`	`isAutoloadAllTopicMaps()` Returns true if all available topicmaps should be autoloaded at startup time.
`boolean`	`isAutoloadTopicMap(String topicmapId)` Returns true if specified TopicMap ID (used by TopicMapRegistry) should be autoloaded at startup or can be loaded afterwards by request otherwise false.

- Field Detail
  - OCCTYPE_METADATA
```
static final String OCCTYPE_METADATA
```
    See Also:
    
    Constant Field Values
  - DEFVAL_OCCTYPE_METADATA
```
static final String DEFVAL_OCCTYPE_METADATA
```
    See Also:
    
    Constant Field Values
  - OCCTYPE_DESCRIPTION
```
static final String OCCTYPE_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - DEFVAL_OCCTYPE_DESCRIPTION
```
static final String DEFVAL_OCCTYPE_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - OCCTYPE_DEFAULT
```
static final String OCCTYPE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - DEFVAL_OCCTYPE_DEFAULT
```
static final String DEFVAL_OCCTYPE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - DEF_COMPARATOR
```
static final String DEF_COMPARATOR
```
    See Also:
    
    Constant Field Values
  - DEFVAL_COMPARATOR
```
static final String DEFVAL_COMPARATOR
```
    See Also:
    
    Constant Field Values
  - DEF_DECIDER
```
static final String DEF_DECIDER
```
    See Also:
    
    Constant Field Values
  - DEFVAL_DECIDER
```
static final String DEFVAL_DECIDER
```
    See Also:
    
    Constant Field Values
  - DEF_CHAR_ENCODING
```
static final String DEF_CHAR_ENCODING
```
    See Also:
    
    Constant Field Values
  - DEF_CONTENT_TYPE
```
static final String DEF_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - ALLOW_LOAD_ON_REQUEST
```
static final String ALLOW_LOAD_ON_REQUEST
```
    See Also:
    
    Constant Field Values
  - MAX_LIST_LENGTH
```
static final String MAX_LIST_LENGTH
```
    See Also:
    
    Constant Field Values
  - DEF_VAL_MAX_LIST_LENGTH
```
static final int DEF_VAL_MAX_LIST_LENGTH
```
    See Also:
    
    Constant Field Values
  - DEF_FUNC_ONTRUNCATE
```
static final String DEF_FUNC_ONTRUNCATE
```
    See Also:
    
    Constant Field Values
  - USERACTION_LOG_LENGTH
```
static final String USERACTION_LOG_LENGTH
```
    See Also:
    
    Constant Field Values
  - DEF_VAL_USERACTION_LOG_LENGTH
```
static final int DEF_VAL_USERACTION_LOG_LENGTH
```
    See Also:
    
    Constant Field Values
  - PLUGINS_ORDER
```
static final String PLUGINS_ORDER
```
    Common base name for those properties specifying the display order of the plugins. Append underscore and plugin group Id to this base name. For example: "pluginsOrder_topic".
    
    See Also:
    
    Constant Field Values
  - BASENAME_CONTEXT_DECIDER
```
static final String BASENAME_CONTEXT_DECIDER
```
    See Also:
    
    Constant Field Values
  - VARIANT_CONTEXT_DECIDER
```
static final String VARIANT_CONTEXT_DECIDER
```
    See Also:
    
    Constant Field Values
  - OCC_CONTEXT_DECIDER
```
static final String OCC_CONTEXT_DECIDER
```
    See Also:
    
    Constant Field Values
  - ASSOC_CONTEXT_DECIDER
```
static final String ASSOC_CONTEXT_DECIDER
```
    See Also:
    
    Constant Field Values
  - CHECK_FOR_CHANGED_MODULES
```
static final String CHECK_FOR_CHANGED_MODULES
```
    See Also:
    
    Constant Field Values
  - NAMESTRING_NONEXISTENT
```
static final String NAMESTRING_NONEXISTENT
```
    See Also:
    
    Constant Field Values
  - NAMESTRING_NULLVALUE
```
static final String NAMESTRING_NULLVALUE
```
    See Also:
    
    Constant Field Values
  - NAMESTRING_EMPTYVALUE
```
static final String NAMESTRING_EMPTYVALUE
```
    See Also:
    
    Constant Field Values
  - OCCURRENCE_EMPTYVALUE
```
static final String OCCURRENCE_EMPTYVALUE
```
    See Also:
    
    Constant Field Values
  - DEFVAL_OCC_EMPTYVALUE
```
static final String DEFVAL_OCC_EMPTYVALUE
```
    See Also:
    
    Constant Field Values
  - OCCURRENCE_EMPTYLOCATOR
```
static final String OCCURRENCE_EMPTYLOCATOR
```
    See Also:
    
    Constant Field Values
  - DEFVAL_OCC_EMPTYLOC
```
static final String DEFVAL_OCC_EMPTYLOC
```
    See Also:
    
    Constant Field Values
  - OCCURRENCE_NULLVALUE
```
static final String OCCURRENCE_NULLVALUE
```
    See Also:
    
    Constant Field Values
  - DEFVAL_OCC_NULLVALUE
```
static final String DEFVAL_OCC_NULLVALUE
```
    See Also:
    
    Constant Field Values
  - OCCURRENCE_NULLLOCATOR
```
static final String OCCURRENCE_NULLLOCATOR
```
    See Also:
    
    Constant Field Values
  - DEFVAL_OCC_NULLLOC
```
static final String DEFVAL_OCC_NULLLOC
```
    See Also:
    
    Constant Field Values
  - MODULE_READER
```
static final String MODULE_READER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getProperty
```
String getProperty(String name)
```
    Get Property value as String for specified name. If property can not be found an empty String is returned.
  - getProperty
```
String getProperty(String name,
                   String defaultValue)
```
    Get Property value as String for specified name. If property can not be found return defaultValue.
  - getProperty
```
int getProperty(String name,
                int defaultValue)
```
    INTERNAL: Get Property value as int for specified name. If property can not be found return defaultValue.
    
    Since:
    
    1.4.1
  - getProperties
```
Map getProperties()
```
    Get all Configuration Properties as a Map containing key (=property-name) - value pairs.
  - getClass
```
String getClass(String shortcut)
```
    Get full-qualified java classname for the specified shortcut name, which can be used by the some tags as attribute value. If shortcut can not be retrieved return empty String.
  - getClassmap
```
Map getClassmap()
```
    Get Java-Classname Mapping as a Map containing key (=shortcut) - value (=full class name) pairs.
  - isAutoloadTopicMap
```
boolean isAutoloadTopicMap(String topicmapId)
```
    Returns true if specified TopicMap ID (used by TopicMapRegistry) should be autoloaded at startup or can be loaded afterwards by request otherwise false.
    
    See Also:
    
    TopicMapRepositoryIF
  - isAutoloadAllTopicMaps
```
boolean isAutoloadAllTopicMaps()
```
    Returns true if all available topicmaps should be autoloaded at startup time.
  - getAutoloadTopicMaps
```
Collection getAutoloadTopicMaps()
```
    Get Set of Topicmaps which are supposed to be autoloaded by application as a Collection of TopicMap ID Strings (used by TopicMapRegistry).
  - getMVSConfig
```
MVSConfig getMVSConfig()
```
    get storage object for Model/View/Skin settings.
  - getModels
```
Collection getModels()
```
    Get all available models.
  - getDefaultModel
```
String getDefaultModel()
```
    Retrieve the name of the application default model.
  - getViews
```
Collection getViews()
```
    Get all available views.
  - getDefaultView
```
String getDefaultView()
```
    Retrieve the name of the application default view.
  - getSkins
```
Collection getSkins()
```
    Get all available skins.
  - getDefaultSkin
```
String getDefaultSkin()
```
    Retrieve the name of the application default skin.
  - addPlugin
```
void addPlugin(PluginIF aPlugin)
```
    Add a plugin to list of known plugins.
  - getPlugin
```
PluginIF getPlugin(String id)
```
    Returns plugin object for specified identifier.
  - getPlugins
```
Collection getPlugins()
```
    Return all plugin objects stored whatever their state (activated, deactivated) is.
  - getOrderedPlugins
```
Collection getOrderedPlugins()
```
    Get all plugins independent of their state in alphabetical order.
  - getPlugins
```
Collection getPlugins(String groupId)
```
    Return plugin objects stored whatever their state (activated, deactivated) is that match the specified groupId.
  - getPluginGroups
```
List getPluginGroups()
```
    Return a list of all available plugin groups, that is achieved by looping over all existing plugins and gather all distinct groups..

Interface NavigatorConfigurationIF

Field Summary

Method Summary

Field Detail

OCCTYPE_METADATA

DEFVAL_OCCTYPE_METADATA

OCCTYPE_DESCRIPTION

DEFVAL_OCCTYPE_DESCRIPTION

OCCTYPE_DEFAULT

DEFVAL_OCCTYPE_DEFAULT

DEF_COMPARATOR

DEFVAL_COMPARATOR

DEF_DECIDER

DEFVAL_DECIDER

DEF_CHAR_ENCODING

DEF_CONTENT_TYPE

ALLOW_LOAD_ON_REQUEST

MAX_LIST_LENGTH

DEF_VAL_MAX_LIST_LENGTH

DEF_FUNC_ONTRUNCATE

USERACTION_LOG_LENGTH

DEF_VAL_USERACTION_LOG_LENGTH

PLUGINS_ORDER

BASENAME_CONTEXT_DECIDER

VARIANT_CONTEXT_DECIDER

OCC_CONTEXT_DECIDER

ASSOC_CONTEXT_DECIDER

CHECK_FOR_CHANGED_MODULES

NAMESTRING_NONEXISTENT

NAMESTRING_NULLVALUE

NAMESTRING_EMPTYVALUE

OCCURRENCE_EMPTYVALUE

DEFVAL_OCC_EMPTYVALUE

OCCURRENCE_EMPTYLOCATOR

DEFVAL_OCC_EMPTYLOC

OCCURRENCE_NULLVALUE

DEFVAL_OCC_NULLVALUE

OCCURRENCE_NULLLOCATOR

DEFVAL_OCC_NULLLOC

MODULE_READER

Method Detail

getProperty

getProperty

getProperty

getProperties

getClass

getClassmap

isAutoloadTopicMap

isAutoloadAllTopicMaps

getAutoloadTopicMaps

getMVSConfig

getModels

getDefaultModel

getViews

getDefaultView

getSkins

getDefaultSkin

addPlugin

getPlugin

getPlugins

getOrderedPlugins

getPlugins

getPluginGroups