net.ontopia.topicmaps.nav2.impl.basic

Class NavigatorConfiguration

java.lang.Object

net.ontopia.topicmaps.nav2.impl.basic.NavigatorConfiguration

All Implemented Interfaces:

NavigatorConfigurationIF

public class NavigatorConfiguration
extends Object
implements NavigatorConfigurationIF

INTERNAL: A configuration holder class for storing and providing information about the application configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTOLOAD_ALL_KEY
protected Set	autoloads
protected Map	classmap
protected boolean	isAutoloadAll
protected MVSConfig	mvsConfig
protected Map	plugins
protected Map	properties

Fields inherited from interface net.ontopia.topicmaps.nav2.core.NavigatorConfigurationIF

ALLOW_LOAD_ON_REQUEST, ASSOC_CONTEXT_DECIDER, BASENAME_CONTEXT_DECIDER, CHECK_FOR_CHANGED_MODULES, DEF_CHAR_ENCODING, DEF_COMPARATOR, DEF_CONTENT_TYPE, DEF_DECIDER, DEF_FUNC_ONTRUNCATE, DEF_VAL_MAX_LIST_LENGTH, DEF_VAL_USERACTION_LOG_LENGTH, DEFVAL_COMPARATOR, DEFVAL_DECIDER, DEFVAL_OCC_EMPTYLOC, DEFVAL_OCC_EMPTYVALUE, DEFVAL_OCC_NULLLOC, DEFVAL_OCC_NULLVALUE, DEFVAL_OCCTYPE_DEFAULT, DEFVAL_OCCTYPE_DESCRIPTION, DEFVAL_OCCTYPE_METADATA, MAX_LIST_LENGTH, MODULE_READER, NAMESTRING_EMPTYVALUE, NAMESTRING_NONEXISTENT, NAMESTRING_NULLVALUE, OCC_CONTEXT_DECIDER, OCCTYPE_DEFAULT, OCCTYPE_DESCRIPTION, OCCTYPE_METADATA, OCCURRENCE_EMPTYLOCATOR, OCCURRENCE_EMPTYVALUE, OCCURRENCE_NULLLOCATOR, OCCURRENCE_NULLVALUE, PLUGINS_ORDER, USERACTION_LOG_LENGTH, VARIANT_CONTEXT_DECIDER

Constructor Summary

Constructors

Constructor and Description
NavigatorConfiguration() INTERNAL: default constructor.

Method Summary

Modifier and Type	Method and Description
void	addAutoloadTopicMap(String topicmapId)
void	addClass(String shortcut, String fullClassName)
void	addModel(String name, String title, boolean isDefault)
void	addPlugin(PluginIF aPlugin) Add a plugin to list of known plugins.
void	addProperty(String name, String value)
void	addSkin(String name, String title, boolean isDefault)
void	addView(String name, String title, boolean isDefault)
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.
void	setAutoloads(Collection autoloads)
void	setClassmap(Map classmap)
void	setMVSConfig(MVSConfig mvsConfig)
void	setProperties(Map properties)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

AUTOLOAD_ALL_KEY

public static final String AUTOLOAD_ALL_KEY

See Also:

Constant Field Values

properties

protected Map properties

classmap

protected Map classmap

plugins

protected Map plugins

mvsConfig

protected MVSConfig mvsConfig

autoloads

protected Set autoloads

isAutoloadAll

protected boolean isAutoloadAll

Constructor Detail

NavigatorConfiguration

public NavigatorConfiguration()

INTERNAL: default constructor.

Method Detail

addProperty

public void addProperty(String name,
                        String value)

getProperty

public String getProperty(String name)

Description copied from interface: NavigatorConfigurationIF

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

Specified by:

getProperty in interface NavigatorConfigurationIF

getProperty

public String getProperty(String name,
                          String defaultValue)

Description copied from interface: NavigatorConfigurationIF

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

Specified by:

getProperty in interface NavigatorConfigurationIF

getProperty

public int getProperty(String name,
                       int defaultValue)

Description copied from interface: NavigatorConfigurationIF

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

Specified by:

getProperty in interface NavigatorConfigurationIF

getProperties

public Map getProperties()

Description copied from interface: NavigatorConfigurationIF

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

Specified by:

getProperties in interface NavigatorConfigurationIF

setProperties

public void setProperties(Map properties)

addClass

public void addClass(String shortcut,
                     String fullClassName)

getClass

public String getClass(String shortcut)

Description copied from interface: NavigatorConfigurationIF

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.

Specified by:

getClass in interface NavigatorConfigurationIF

getClassmap

public Map getClassmap()

Description copied from interface: NavigatorConfigurationIF

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

Specified by:

getClassmap in interface NavigatorConfigurationIF

setClassmap

public void setClassmap(Map classmap)

addAutoloadTopicMap

public void addAutoloadTopicMap(String topicmapId)

isAutoloadTopicMap

public boolean isAutoloadTopicMap(String topicmapId)

Description copied from interface: NavigatorConfigurationIF

Returns true if specified TopicMap ID (used by TopicMapRegistry) should be autoloaded at startup or can be loaded afterwards by request otherwise false.

Specified by:

isAutoloadTopicMap in interface NavigatorConfigurationIF

See Also:

TopicMapRepositoryIF

isAutoloadAllTopicMaps

public boolean isAutoloadAllTopicMaps()

Description copied from interface: NavigatorConfigurationIF

Returns true if all available topicmaps should be autoloaded at startup time.

Specified by:

isAutoloadAllTopicMaps in interface NavigatorConfigurationIF

getAutoloadTopicMaps

public Collection getAutoloadTopicMaps()

Description copied from interface: NavigatorConfigurationIF

Get Set of Topicmaps which are supposed to be autoloaded by application as a Collection of TopicMap ID Strings (used by TopicMapRegistry).

Specified by:

getAutoloadTopicMaps in interface NavigatorConfigurationIF

setAutoloads

public void setAutoloads(Collection autoloads)

getMVSConfig

public MVSConfig getMVSConfig()

Description copied from interface: NavigatorConfigurationIF

get storage object for Model/View/Skin settings.

Specified by:

getMVSConfig in interface NavigatorConfigurationIF

setMVSConfig

public void setMVSConfig(MVSConfig mvsConfig)

addModel

public void addModel(String name,
                     String title,
                     boolean isDefault)

getModels

public Collection getModels()

Description copied from interface: NavigatorConfigurationIF

Get all available models.

Specified by:

getModels in interface NavigatorConfigurationIF

getDefaultModel

public String getDefaultModel()

Description copied from interface: NavigatorConfigurationIF

Retrieve the name of the application default model.

Specified by:

getDefaultModel in interface NavigatorConfigurationIF

addView

public void addView(String name,
                    String title,
                    boolean isDefault)

getViews

public Collection getViews()

Description copied from interface: NavigatorConfigurationIF

Get all available views.

Specified by:

getViews in interface NavigatorConfigurationIF

getDefaultView

public String getDefaultView()

Description copied from interface: NavigatorConfigurationIF

Retrieve the name of the application default view.

Specified by:

getDefaultView in interface NavigatorConfigurationIF

addSkin

public void addSkin(String name,
                    String title,
                    boolean isDefault)

getSkins

public Collection getSkins()

Description copied from interface: NavigatorConfigurationIF

Get all available skins.

Specified by:

getSkins in interface NavigatorConfigurationIF

getDefaultSkin

public String getDefaultSkin()

Description copied from interface: NavigatorConfigurationIF

Retrieve the name of the application default skin.

Specified by:

getDefaultSkin in interface NavigatorConfigurationIF

addPlugin

public void addPlugin(PluginIF aPlugin)

Description copied from interface: NavigatorConfigurationIF

Add a plugin to list of known plugins.

Specified by:

addPlugin in interface NavigatorConfigurationIF

getPlugin

public PluginIF getPlugin(String id)

Description copied from interface: NavigatorConfigurationIF

Returns plugin object for specified identifier.

Specified by:

getPlugin in interface NavigatorConfigurationIF

getPlugins

public Collection getPlugins(String groupId)

Description copied from interface: NavigatorConfigurationIF

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

Specified by:

getPlugins in interface NavigatorConfigurationIF

getPlugins

public Collection getPlugins()

Description copied from interface: NavigatorConfigurationIF

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

Specified by:

getPlugins in interface NavigatorConfigurationIF

getOrderedPlugins

public Collection getOrderedPlugins()

Description copied from interface: NavigatorConfigurationIF

Get all plugins independent of their state in alphabetical order.

Specified by:

getOrderedPlugins in interface NavigatorConfigurationIF

getPluginGroups

public List getPluginGroups()

Description copied from interface: NavigatorConfigurationIF

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

Specified by:

getPluginGroups in interface NavigatorConfigurationIF

toString

public String toString()

Overrides:

toString in class Object