Package hec.clientapp.script

Class ScriptManagerImpl

java.lang.Object

hec.clientapp.script.ScriptManagerImpl

All Implemented Interfaces:

ScriptConstants, ScriptManager

public class ScriptManagerImpl
extends Object
implements ScriptManager, ScriptConstants

Class for managing the storing and retrieving of scripts. possible places for storing scripts are: .../CWMS/All/scripts .../CWMS//scripts at some point these locations will also be supported: ...//All/scripts ...///scripts

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ScriptManagerImpl.ScriptHashtable	extension of Hashtable for some added functionality

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GLOBAL
static final String	WORKSPACE

Fields inherited from interface hec.script.ScriptConstants

ALL_MODULES, ALL_WORKSPACES, BASE, CACHE_DIR_PROP, CLIENT_MODULE, CURRENT_MODULES, CURRENT_WORKSPACE, DSS_IMPORT, JAVA_IMPORT, ROOT, SCRIPT_ZIPFILE, SCRIPTS_CONF, SCRIPTS_DIR, STD_IMPORT, SYSTEM, USER

Fields inherited from interface hec.script.ScriptManager

BG_COLOR, DESCRIPTION, DISPLAY_IN_MENU, DISPLAY_IN_SELECTOR, DISPLAY_TO_USER, GROUP, ICON_NAME, NAME

Constructor Summary

Constructors

Constructor	Description
ScriptManagerImpl(hec.clientapp.client.ClientWorkspace wksp)

Method Summary

Modifier and Type	Method	Description
void	addConfigChangeListener(hec.event.ConfigChangeListener listener)
static void	buildSortedVector(Vector src, Vector dest)
String	checkLockedBy(String scriptPath)
void	close()	remove the callbacks to the rmi files when the workspace closes.
static boolean	debug()
boolean	deleteScript(ScriptIdentifier sid)
boolean	deleteScript(ScriptIdentifier sid, boolean notify)
boolean	deleteScript(ScriptIdentifier sid, boolean notify, boolean warnUser)	If notify is false, only the cache removal of the script identifier will occur.
boolean	downLoadModule(String moduleName)	download the script from the remote workspace to the local drive
boolean	flushIds()	flush all the script id cache's
Hashtable	getCache()
Identifier	getIdFromScriptId(ScriptIdentifier sid)	get the identifier for the script file.
String	getPathFromTreePath(String treePath)	given a treepath return the directory where the script file resides.
Script	getScript(ScriptIdentifier sid)
Vector	getScriptIds(Vector paths)	get all the scriptIds
Vector	getScriptIdsForMode(String moduleName)	get all the script ids for a module gets scripts from the following locations .../CWMS/All/script/ .../CWMS/All/scripts/modules/ .../CWMS//scripts .../CWMS//scripts/modules/
Vector	getScriptIdsForObject(String scriptIdPath)
boolean	isUniqueScriptName(String s)
boolean	isUniqueScriptName(String s, Hashtable cache)
protected boolean	loadScript(Script newScript, Identifier id)	read the script text from and Identifier id and store it in newScript
protected boolean	loadScript(Script newScript, Identifier id, ScriptIdentifier sid)	read the script text from the Identifier id and store it in newScript
protected boolean	loadScripts(Vector v, Identifier dirId, String scriptTreePath)	find all the .py files in the directory and return Vector of ScriptIds
boolean	lockScriptFile(boolean lock, String scriptPath)	lock the script config file
void	notifyListeners(String file, int changeType, String otherInfo)
void	reloadScript(ScriptIdentifier sid)
void	removeConfigChangeListener(hec.event.ConfigChangeListener listener)
boolean	saveScript(ScriptIdentifier sid, Script script)
protected boolean	saveScriptIds(Vector list, Identifier fileId)	save the list script ids out to disk
void	scriptAdded(ScriptIdentifier sid)
void	setFileManager()

Methods inherited from class java.lang.Object

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

Field Details

GLOBAL

public static final String GLOBAL

See Also:

• Constant Field Values

WORKSPACE

public static final String WORKSPACE

See Also:

• Constant Field Values

Constructor Details

ScriptManagerImpl

public ScriptManagerImpl(hec.clientapp.client.ClientWorkspace wksp)

Method Details

debug

public static boolean debug()

getScript

public Script getScript(ScriptIdentifier sid)

Specified by:

getScript in interface ScriptManager

loadScript

protected boolean loadScript(Script newScript,
 Identifier id,
 ScriptIdentifier sid)

read the script text from the Identifier id and store it in newScript

loadScript

protected boolean loadScript(Script newScript,
 Identifier id)

read the script text from and Identifier id and store it in newScript

saveScript

public boolean saveScript(ScriptIdentifier sid,
 Script script)

Specified by:

saveScript in interface ScriptManager

saveScriptIds

protected boolean saveScriptIds(Vector list,
 Identifier fileId)

save the list script ids out to disk

flushIds

public boolean flushIds()

flush all the script id cache's

getIdFromScriptId

public Identifier getIdFromScriptId(ScriptIdentifier sid)

get the identifier for the script file.

Specified by:

getIdFromScriptId in interface ScriptManager

getPathFromTreePath

public String getPathFromTreePath(String treePath)

given a treepath return the directory where the script file resides.

Specified by:

getPathFromTreePath in interface ScriptManager

getScriptIdsForMode

public Vector getScriptIdsForMode(String moduleName)

get all the script ids for a module gets scripts from the following locations .../CWMS/All/script/ .../CWMS/All/scripts/modules/ .../CWMS//scripts .../CWMS//scripts/modules/

Specified by:

getScriptIdsForMode in interface ScriptManager

getScriptIds

public Vector getScriptIds(Vector paths)

get all the scriptIds

getScriptIdsForObject

public Vector getScriptIdsForObject(String scriptIdPath)

Specified by:

getScriptIdsForObject in interface ScriptManager

loadScripts

protected boolean loadScripts(Vector v,
 Identifier dirId,
 String scriptTreePath)

find all the .py files in the directory and return Vector of ScriptIds

deleteScript

public boolean deleteScript(ScriptIdentifier sid)

Specified by:

deleteScript in interface ScriptManager

deleteScript

public boolean deleteScript(ScriptIdentifier sid,
 boolean notify)

Specified by:

deleteScript in interface ScriptManager

deleteScript

public boolean deleteScript(ScriptIdentifier sid,
 boolean notify,
 boolean warnUser)

If notify is false, only the cache removal of the script identifier will occur.

Specified by:

deleteScript in interface ScriptManager

isUniqueScriptName

public boolean isUniqueScriptName(String s)

Specified by:

isUniqueScriptName in interface ScriptManager

isUniqueScriptName

public boolean isUniqueScriptName(String s,
 Hashtable cache)

Specified by:

isUniqueScriptName in interface ScriptManager

downLoadModule

public boolean downLoadModule(String moduleName)

download the script from the remote workspace to the local drive

Specified by:

downLoadModule in interface ScriptManager

lockScriptFile

public boolean lockScriptFile(boolean lock,
 String scriptPath)

lock the script config file

Specified by:

lockScriptFile in interface ScriptManager

Parameters:

lock - whether to lock or unlock the script, true to lock, false to unlock

scriptPath - path to script file

checkLockedBy

public String checkLockedBy(String scriptPath)

Specified by:

checkLockedBy in interface ScriptManager

addConfigChangeListener

public void addConfigChangeListener(hec.event.ConfigChangeListener listener)

Specified by:

addConfigChangeListener in interface ScriptManager

removeConfigChangeListener

public void removeConfigChangeListener(hec.event.ConfigChangeListener listener)

Specified by:

removeConfigChangeListener in interface ScriptManager

notifyListeners

public void notifyListeners(String file,
 int changeType,
 String otherInfo)

close

public void close()

remove the callbacks to the rmi files when the workspace closes.

Specified by:

close in interface ScriptManager

buildSortedVector

public static void buildSortedVector(Vector src,
 Vector dest)

setFileManager

public void setFileManager()

scriptAdded

public void scriptAdded(ScriptIdentifier sid)

Specified by:

scriptAdded in interface ScriptManager

reloadScript

public void reloadScript(ScriptIdentifier sid)

Specified by:

reloadScript in interface ScriptManager

getCache

public Hashtable getCache()

Specified by:

getCache in interface ScriptManager