org.apache.xindice.server
Interface ScriptManager

All Known Implementing Classes:

StdScriptManager

public interface ScriptManager

ScriptManager is an interface that is implemented to handle the management and execution of Scripts. StdScriptManager is the standard implementation of this interface.

See Also:

StdScriptManager

Method Summary

boolean	addScript(java.lang.String name, Script script) addScript adds a Script to the ScriptManager's storage by name.
Script	getScript(java.lang.String name) getScript retrieves a Script from the ScriptManager's storage by name.
void	removeScript(java.lang.String name) removeScript removes a Script from the ScriptManager storage by name.
void	runScript(Script script, Gateway gateway, boolean useFilters) runScript directly executs a Script.
void	runScript(java.lang.String name, Gateway gateway, boolean useFilters) runScript executs a Script in the ScriptManager's storage by name.

Method Detail

addScript

public boolean addScript(java.lang.String name,
                         Script script)

addScript adds a Script to the ScriptManager's storage by name.

Parameters:

name - the Script name

script - the Script to add

Returns:

whether or not the Script could be added

removeScript

public void removeScript(java.lang.String name)

removeScript removes a Script from the ScriptManager storage by name.

Parameters:

name - the Script name

getScript

public Script getScript(java.lang.String name)

getScript retrieves a Script from the ScriptManager's storage by name.

Parameters:

name - the Script name

Returns:

the retrieved Script

runScript

public void runScript(java.lang.String name,
                      Gateway gateway,
                      boolean useFilters)

runScript executs a Script in the ScriptManager's storage by name.

Parameters:

name - the Script name

gateway - the Gateway to use for I/O

useFilters - whether or not to process filters before executing

runScript

public void runScript(Script script,
                      Gateway gateway,
                      boolean useFilters)

runScript directly executs a Script.

Parameters:

name - the Script to execute

gateway - the Gateway to use for I/O

useFilters - whether or not to process filters before executing