Package net.ontopia.topicmaps.nav2.core

Interface NavigatorApplicationIF

All Known Implementing Classes:
NavigatorApplication
public interface NavigatorApplicationIF
INTERNAL: Implemented by an object which stores all information and also all handles to configuration holders needed by the navigator web application.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    APP_CONFIG_DEFAULT_VALUE
    INTERNAL: Default value for the Application configuration filename.
    static final String
    APP_CONFIG_KEY
    INTERNAL: The context parameter name for the Application configuration file which value can be specified in web.xml.
    static final String
    CONTEXT_KEY
    INTERNAL: The request scope attribute under which the root context tag object of the JSP is stored.
    static final String
    FOREACH_SEQ_FIRST_KEY
    INTERNAL: Variable name which is used/setup inside a foreach-tag for describing if it is the first iteration we are in.
    static final String
    FOREACH_SEQ_INDEX_KEY
    INTERNAL: Variable name which is used/setup inside a foreach-tag for describing the index number iterated currently.
    static final String
    FOREACH_SEQ_LAST_KEY
    INTERNAL: Variable name which is used/setup inside a foreach-tag for describing if it is the last iteration we are in.
    static final String
    JNDI_REPOSITORY_KEY
    INTERNAL: The context parameter name (see web.xml) for specifying the JNDI repository name, if the TopicMap Sources should be shared between applications running on the same server.
    static final String
    LOG4J_CONFIG_DEFAULT_VALUE
    INTERNAL: Default value for the Log4J configuration filename.
    static final String
    LOG4J_CONFIG_KEY
    INTERNAL: The context parameter name for the Log4J configuration file which value can be specified in web.xml.
    static final String
    NAV_APP_KEY
    INTERNAL: The application scope attribute under which our main configuration object for the navigator Application is stored.
    static final String
    PLUGINS_ROOTDIR_KEY
    INTERNAL: The context parameter name for the directory containing all plugins, which value can be specified in web.xml.
    static final String
    SOURCE_CONFIG_DEFAULT_VALUE
    INTERNAL: Default value for the TopicMap Sources configuration filename.
    static final String
    SOURCE_CONFIG_KEY
    INTERNAL: The context parameter name for the TopicMap Sources configuration file which value can be specified in web.xml.
    static final String
    TOPICMAPS_REPOSITORY_ID
    INTERNAL: The id of the topic maps repository to use..
    static final String
    USER_KEY
    INTERNAL: The session scope attribute for storing information about the user preferences (ie.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    INTERNAL: Close navigator application and free all resources connected to it.
    NavigatorConfigurationIF
    getConfiguration()
    INTERNAL: Get NavigatorConfigurationIF object which allows access to all application relevant configuration information.
    Object
    getInstanceOf(String classname)
    INTERNAL: Get an object instance of specified class name centralized managed by this instance (application).
    ModuleIF
    getModule(URL location)
    INTERNAL: Return ModuleIF object for specified resource location (given as URL) of module.
    String
    getName()
    INTERNAL: Gets the name of this application.
    TopicMapIF
    getTopicMapById(String topicmapId)
    INTERNAL: Get TopicMapIF object for specified TopicMap String Identifier which is in accordance to the identifiers used by the TopicMapRepositoryIF.
    TopicMapIF
    getTopicMapById(String topicmapId, boolean readonly)
    INTERNAL: Get TopicMapIF object for specified TopicMap String Identifier which is in accordance to the identifiers used by the TopicMapRepositoryIF.
    String
    getTopicMapRefId(TopicMapIF topicmap)
    INTERNAL: Get the reference ID of the topic map within the application's store registry.
    TopicMapRepositoryIF
    getTopicMapRepository()
    INTERNAL: Returns the topic map repository used by the navigator application.
    void
    returnTopicMap(TopicMapIF topicmap)
    INTERNAL: Returns the TopicMapIF object to the navigator application.

  • Field Details

    • CONTEXT_KEY

      static final String CONTEXT_KEY
      INTERNAL: The request scope attribute under which the root context tag object of the JSP is stored.
      See Also:

    • USER_KEY

      static final String USER_KEY
      INTERNAL: The session scope attribute for storing information about the user preferences (ie. Model-View-Skin). Note: This is somewhat framework related.
      See Also:

    • FOREACH_SEQ_FIRST_KEY

      static final String FOREACH_SEQ_FIRST_KEY
      INTERNAL: Variable name which is used/setup inside a foreach-tag for describing if it is the first iteration we are in.
      See Also:

    • FOREACH_SEQ_LAST_KEY

      static final String FOREACH_SEQ_LAST_KEY
      INTERNAL: Variable name which is used/setup inside a foreach-tag for describing if it is the last iteration we are in.
      See Also:

    • FOREACH_SEQ_INDEX_KEY

      static final String FOREACH_SEQ_INDEX_KEY
      INTERNAL: Variable name which is used/setup inside a foreach-tag for describing the index number iterated currently.
      See Also:

    • LOG4J_CONFIG_KEY

      static final String LOG4J_CONFIG_KEY
      INTERNAL: The context parameter name for the Log4J configuration file which value can be specified in web.xml.
      See Also:

    • LOG4J_CONFIG_DEFAULT_VALUE

      static final String LOG4J_CONFIG_DEFAULT_VALUE
      INTERNAL: Default value for the Log4J configuration filename. WEB-INF/config/log4j.properties
      See Also:

    • APP_CONFIG_KEY

      static final String APP_CONFIG_KEY
      INTERNAL: The context parameter name for the Application configuration file which value can be specified in web.xml.
      See Also:

    • APP_CONFIG_DEFAULT_VALUE

      static final String APP_CONFIG_DEFAULT_VALUE
      INTERNAL: Default value for the Application configuration filename. WEB-INF/config/application.xml
      See Also:

    • SOURCE_CONFIG_KEY

      static final String SOURCE_CONFIG_KEY
      INTERNAL: The context parameter name for the TopicMap Sources configuration file which value can be specified in web.xml.
      See Also:

    • TOPICMAPS_REPOSITORY_ID

      static final String TOPICMAPS_REPOSITORY_ID
      INTERNAL: The id of the topic maps repository to use..
      See Also:

    • SOURCE_CONFIG_DEFAULT_VALUE

      static final String SOURCE_CONFIG_DEFAULT_VALUE
      INTERNAL: Default value for the TopicMap Sources configuration filename. WEB-INF/config/tm-sources.xml
      See Also:

    • PLUGINS_ROOTDIR_KEY

      static final String PLUGINS_ROOTDIR_KEY
      INTERNAL: The context parameter name for the directory containing all plugins, which value can be specified in web.xml.

      Note: If there is no value specified then the application will not fallback to a default value, but use no plugins at all.

      See Also:

    • JNDI_REPOSITORY_KEY

      static final String JNDI_REPOSITORY_KEY
      INTERNAL: The context parameter name (see web.xml) for specifying the JNDI repository name, if the TopicMap Sources should be shared between applications running on the same server.

      Since:
      1.3.2
      See Also:

  • Method Details

    • getName

      String getName()
      INTERNAL: Gets the name of this application.
      Since:
      1.3

    • getConfiguration

      NavigatorConfigurationIF getConfiguration()
      INTERNAL: Get NavigatorConfigurationIF object which allows access to all application relevant configuration information.

    • getInstanceOf

      Object getInstanceOf(String classname) throws NavigatorRuntimeException
      INTERNAL: Get an object instance of specified class name centralized managed by this instance (application).
      Parameters:
      classname - String which can be a shortcut for a full qualified class name (FQCN) specified in the classmap of NavigatorConfigurationIF If no entry is found the classname is interpreted as FQCN.
      Returns:
      An object instance of given class.
      Throws:
      NavigatorRuntimeException
      See Also:

    • getTopicMapRepository

      TopicMapRepositoryIF getTopicMapRepository()
      INTERNAL: Returns the topic map repository used by the navigator application.
      Since:
      2.1

    • getTopicMapById

      TopicMapIF getTopicMapById(String topicmapId) throws NavigatorRuntimeException
      INTERNAL: Get TopicMapIF object for specified TopicMap String Identifier which is in accordance to the identifiers used by the TopicMapRepositoryIF.
      Throws:
      NavigatorRuntimeException

    • getTopicMapById

      TopicMapIF getTopicMapById(String topicmapId, boolean readonly) throws NavigatorRuntimeException
      INTERNAL: Get TopicMapIF object for specified TopicMap String Identifier which is in accordance to the identifiers used by the TopicMapRepositoryIF.
      Throws:
      NavigatorRuntimeException
      Since:
      2.1

    • returnTopicMap

      void returnTopicMap(TopicMapIF topicmap)
      INTERNAL: Returns the TopicMapIF object to the navigator application. Note that the topic map object must have been retrieved from the navigator application for this to work properly.
      Since:
      2.0.7

    • getTopicMapRefId

      String getTopicMapRefId(TopicMapIF topicmap)
      INTERNAL: Get the reference ID of the topic map within the application's store registry.

      Since:
      1.3.3

    • getModule

      ModuleIF getModule(URL location) throws NavigatorRuntimeException
      INTERNAL: Return ModuleIF object for specified resource location (given as URL) of module. If the module cannot be found in internal object pool a new instance is created.
      Throws:
      NavigatorRuntimeException

    • close

      void close()
      INTERNAL: Close navigator application and free all resources connected to it.
      Since:
      2.1