net.ontopia.topicmaps.nav2.core
Interface NavigatorConfigurationIF

All Known Implementing Classes:

BrokenNavigatorConfiguration, NavigatorConfiguration

public interface NavigatorConfigurationIF

INTERNAL: Implemented by an object which stores configuration information needed by the navigator.

Field Summary

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

Method Summary

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

See Also:

Constant Field Values

DEFVAL_OCCTYPE_METADATA

static final java.lang.String DEFVAL_OCCTYPE_METADATA

See Also:

Constant Field Values

OCCTYPE_DESCRIPTION

static final java.lang.String OCCTYPE_DESCRIPTION

See Also:

Constant Field Values

DEFVAL_OCCTYPE_DESCRIPTION

static final java.lang.String DEFVAL_OCCTYPE_DESCRIPTION

See Also:

Constant Field Values

OCCTYPE_DEFAULT

static final java.lang.String OCCTYPE_DEFAULT

See Also:

Constant Field Values

DEFVAL_OCCTYPE_DEFAULT

static final java.lang.String DEFVAL_OCCTYPE_DEFAULT

See Also:

Constant Field Values

DEF_COMPARATOR

static final java.lang.String DEF_COMPARATOR

See Also:

Constant Field Values

DEFVAL_COMPARATOR

static final java.lang.String DEFVAL_COMPARATOR

See Also:

Constant Field Values

DEF_DECIDER

static final java.lang.String DEF_DECIDER

See Also:

Constant Field Values

DEFVAL_DECIDER

static final java.lang.String DEFVAL_DECIDER

See Also:

Constant Field Values

DEF_CHAR_ENCODING

static final java.lang.String DEF_CHAR_ENCODING

See Also:

Constant Field Values

DEF_CONTENT_TYPE

static final java.lang.String DEF_CONTENT_TYPE

See Also:

Constant Field Values

ALLOW_LOAD_ON_REQUEST

static final java.lang.String ALLOW_LOAD_ON_REQUEST

See Also:

Constant Field Values

MAX_LIST_LENGTH

static final java.lang.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 java.lang.String DEF_FUNC_ONTRUNCATE

See Also:

Constant Field Values

USERACTION_LOG_LENGTH

static final java.lang.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 java.lang.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 java.lang.String BASENAME_CONTEXT_DECIDER

See Also:

Constant Field Values

VARIANT_CONTEXT_DECIDER

static final java.lang.String VARIANT_CONTEXT_DECIDER

See Also:

Constant Field Values

OCC_CONTEXT_DECIDER

static final java.lang.String OCC_CONTEXT_DECIDER

See Also:

Constant Field Values

ASSOC_CONTEXT_DECIDER

static final java.lang.String ASSOC_CONTEXT_DECIDER

See Also:

Constant Field Values

CHECK_FOR_CHANGED_MODULES

static final java.lang.String CHECK_FOR_CHANGED_MODULES

See Also:

Constant Field Values

NAMESTRING_NONEXISTENT

static final java.lang.String NAMESTRING_NONEXISTENT

See Also:

Constant Field Values

NAMESTRING_NULLVALUE

static final java.lang.String NAMESTRING_NULLVALUE

See Also:

Constant Field Values

NAMESTRING_EMPTYVALUE

static final java.lang.String NAMESTRING_EMPTYVALUE

See Also:

Constant Field Values

OCCURRENCE_EMPTYVALUE

static final java.lang.String OCCURRENCE_EMPTYVALUE

See Also:

Constant Field Values

DEFVAL_OCC_EMPTYVALUE

static final java.lang.String DEFVAL_OCC_EMPTYVALUE

See Also:

Constant Field Values

OCCURRENCE_EMPTYLOCATOR

static final java.lang.String OCCURRENCE_EMPTYLOCATOR

See Also:

Constant Field Values

DEFVAL_OCC_EMPTYLOC

static final java.lang.String DEFVAL_OCC_EMPTYLOC

See Also:

Constant Field Values

OCCURRENCE_NULLVALUE

static final java.lang.String OCCURRENCE_NULLVALUE

See Also:

Constant Field Values

DEFVAL_OCC_NULLVALUE

static final java.lang.String DEFVAL_OCC_NULLVALUE

See Also:

Constant Field Values

OCCURRENCE_NULLLOCATOR

static final java.lang.String OCCURRENCE_NULLLOCATOR

See Also:

Constant Field Values

DEFVAL_OCC_NULLLOC

static final java.lang.String DEFVAL_OCC_NULLLOC

See Also:

Constant Field Values

MODULE_READER

static final java.lang.String MODULE_READER

See Also:

Constant Field Values

Method Detail

getProperty

java.lang.String getProperty(java.lang.String name)

Get Property value as String for specified name. If property can not be found an empty String is returned.

getProperty

java.lang.String getProperty(java.lang.String name,
                             java.lang.String defaultValue)

Get Property value as String for specified name. If property can not be found return defaultValue.

getProperty

int getProperty(java.lang.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

java.util.Map getProperties()

Get all Configuration Properties as a Map containing key (=property-name) - value pairs.

getClass

java.lang.String getClass(java.lang.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

java.util.Map getClassmap()

Get Java-Classname Mapping as a Map containing key (=shortcut) - value (=full class name) pairs.

isAutoloadTopicMap

boolean isAutoloadTopicMap(java.lang.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

java.util.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

java.util.Collection getModels()

Get all available models.

getDefaultModel

java.lang.String getDefaultModel()

Retrieve the name of the application default model.

getViews

java.util.Collection getViews()

Get all available views.

getDefaultView

java.lang.String getDefaultView()

Retrieve the name of the application default view.

getSkins

java.util.Collection getSkins()

Get all available skins.

getDefaultSkin

java.lang.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(java.lang.String id)

Returns plugin object for specified identifier.

getPlugins

java.util.Collection getPlugins()

Return all plugin objects stored whatever their state (activated, deactivated) is.

getOrderedPlugins

java.util.Collection getOrderedPlugins()

Get all plugins independent of their state in alphabetical order.

getPlugins

java.util.Collection getPlugins(java.lang.String groupId)

Return plugin objects stored whatever their state (activated, deactivated) is that match the specified groupId.

getPluginGroups

java.util.List getPluginGroups()

Return a list of all available plugin groups, that is achieved by looping over all existing plugins and gather all distinct groups..