gui.help
Class LocalHelpFileStorageManager

java.lang.Object
  gui.help.AbstractHelpFileStorageManager
      gui.help.LocalHelpFileStorageManager

public class LocalHelpFileStorageManager
extends AbstractHelpFileStorageManager

Field Summary

private java.util.Observable	DUMMY
private java.lang.String	LOCAL_HELP_PATH

Fields inherited from class gui.help.AbstractHelpFileStorageManager

HELP_DIR_EXISTS, HELP_FOLDER, HELP_INVALID_NOREAD, HELP_INVALID_NOWRITE, HELP_INVALID_NULL, HELP_INVALID_PATH_NOT_EXISTS, HELP_JONDO_EXISTS, HELP_NESTED, HELP_NO_DIR, HELP_VALID, HELP_VIRTUAL

Constructor Summary

LocalHelpFileStorageManager(java.lang.String a_applicationName)

Method Summary

boolean	ensureMostRecentVersion(java.lang.String helpPath)
java.lang.String	getInitPath()
java.util.Observable	getStorageObservable() returns an observable object which allows ViewObjects to display storage processes, i.e.
boolean	handleHelpPathChanged(java.lang.String oldHelpPath, java.lang.String newHelpPath, boolean a_bIgnoreExistingHelpDir) Performs the specific file storage operation to maintain a consistent file storage state when the help path changes
boolean	helpInstallationExists(java.lang.String helpPath)
java.lang.String	helpPathValidityCheck(java.lang.String absolutePath, boolean a_bIgnoreExistingHelpDir)

Methods inherited from class gui.help.AbstractHelpFileStorageManager

extractHelpFiles, getLocalisedHelpDir

Methods inherited from class java.lang.Object

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

Field Detail

DUMMY

private final java.util.Observable DUMMY

LOCAL_HELP_PATH

private final java.lang.String LOCAL_HELP_PATH

Constructor Detail

LocalHelpFileStorageManager

public LocalHelpFileStorageManager(java.lang.String a_applicationName)

Method Detail

ensureMostRecentVersion

public boolean ensureMostRecentVersion(java.lang.String helpPath)

Specified by:

ensureMostRecentVersion in class AbstractHelpFileStorageManager

getStorageObservable

public java.util.Observable getStorageObservable()

Description copied from class: AbstractHelpFileStorageManager

returns an observable object which allows ViewObjects to display storage processes, i.e. to display the file installation progress in a JProgressBar

Specified by:

getStorageObservable in class AbstractHelpFileStorageManager

Returns:

an observable object from which to obtain storage process informations or null if the manager has no such object associated with it.

handleHelpPathChanged

public boolean handleHelpPathChanged(java.lang.String oldHelpPath,
                                     java.lang.String newHelpPath,
                                     boolean a_bIgnoreExistingHelpDir)

Description copied from class: AbstractHelpFileStorageManager

Performs the specific file storage operation to maintain a consistent file storage state when the help path changes

Specified by:

handleHelpPathChanged in class AbstractHelpFileStorageManager

Parameters:

oldHelpPath - the path of the help files before the change.

newHelpPath - the path where the help files shall be installed

a_bIgnoreExistingHelpDir - true if any existing directory named help will be removed in the installation folder

Returns:

true if the storage layer could be maintained consistent, false otherwise. In the latter case the file storage layer must be in the same state as if there has not been a change at all.

helpInstallationExists

public boolean helpInstallationExists(java.lang.String helpPath)

Specified by:

helpInstallationExists in class AbstractHelpFileStorageManager

helpPathValidityCheck

public java.lang.String helpPathValidityCheck(java.lang.String absolutePath,
                                              boolean a_bIgnoreExistingHelpDir)

Specified by:

helpPathValidityCheck in class AbstractHelpFileStorageManager

getInitPath

public java.lang.String getInitPath()

Overrides:

getInitPath in class AbstractHelpFileStorageManager