org.apache.xindice.server.standard
Class StdScriptManager

java.lang.Object
  |
  +--org.apache.xindice.server.standard.StdScriptManager

All Implemented Interfaces:

Configurable, Disposable, KernelAccess, ScriptManager

public final class StdScriptManager

extends java.lang.Object

implements Configurable, ScriptManager, KernelAccess, Disposable

StdScriptManager

Constructor Summary

StdScriptManager()

Method Summary

boolean	addScript(java.lang.String name, Script script) addScript adds a Script to the ScriptManager's storage by name.
void	dispose() dispose disposes of the object instance.
Configuration	getConfig() getConfig retrieves the configuration information for the Configurable object instance.
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.
void	setConfig(Configuration config) setConfig sets the configuration information for the Configurable object instance.
void	setKernel(Kernel kernel) setKernel provides a Kernel callback interface to the implementing object.

Methods inherited from class java.lang.Object

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

Constructor Detail

StdScriptManager

public StdScriptManager()

Method Detail

setKernel

public void setKernel(Kernel kernel)

Description copied from interface: KernelAccess

setKernel provides a Kernel callback interface to the implementing object.

Specified by:

setKernel in interface KernelAccess

Following copied from interface: org.apache.xindice.server.KernelAccess

Parameters:

kernel - the Kernel reference

setConfig

public void setConfig(Configuration config)

Description copied from interface: Configurable

setConfig sets the configuration information for the Configurable object instance.

Specified by:

setConfig in interface Configurable

Following copied from interface: org.apache.xindice.util.Configurable

Parameters:

config - The configuration Node

getConfig

public Configuration getConfig()

Description copied from interface: Configurable

getConfig retrieves the configuration information for the Configurable object instance.

Specified by:

getConfig in interface Configurable

Following copied from interface: org.apache.xindice.util.Configurable

Returns:

The configuration Node

addScript

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

Description copied from interface: ScriptManager

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

Specified by:

addScript in interface ScriptManager

Following copied from interface: org.apache.xindice.server.ScriptManager

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)

Description copied from interface: ScriptManager

removeScript removes a Script from the ScriptManager storage by name.

Specified by:

removeScript in interface ScriptManager

Following copied from interface: org.apache.xindice.server.ScriptManager

Parameters:

name - the Script name

getScript

public Script getScript(java.lang.String name)

Description copied from interface: ScriptManager

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

Specified by:

getScript in interface ScriptManager

Following copied from interface: org.apache.xindice.server.ScriptManager

Parameters:

name - the Script name

Returns:

the retrieved Script

runScript

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

Description copied from interface: ScriptManager

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

Specified by:

runScript in interface ScriptManager

Following copied from interface: org.apache.xindice.server.ScriptManager

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)

Description copied from interface: ScriptManager

runScript directly executs a Script.

Specified by:

runScript in interface ScriptManager

Following copied from interface: org.apache.xindice.server.ScriptManager

Parameters:

name - the Script to execute

gateway - the Gateway to use for I/O

useFilters - whether or not to process filters before executing

dispose

public void dispose()

Description copied from interface: Disposable

dispose disposes of the object instance.

Specified by:

dispose in interface Disposable