org.mmbase.module.tools
Class MMAdmin

java.lang.Object
  org.mmbase.util.functions.FunctionProvider
      org.mmbase.module.Module
          org.mmbase.module.ProcessorModule
              org.mmbase.module.tools.MMAdmin

All Implemented Interfaces:

ProcessorInterface

public class MMAdmin

extends ProcessorModule

Version:

$Id: MMAdmin.java,v 1.144 2006/04/04 21:13:14 daniel Exp $

Author:

Daniel Ockeloen, Pierre van Rooden

Class for Application :

Admin, Application

Warning: No Java Documentation Available.

Nested Class Summary

Nested classes inherited from class org.mmbase.module.ProcessorModule

ProcessorModule.GetNodeListFunction, ProcessorModule.ProcessFunction, ProcessorModule.ReplaceFunction

Field Summary

Fields inherited from class org.mmbase.module.ProcessorModule

PARAM_PAGEINFO, PARAMS_PAGEINFO

Fields inherited from class org.mmbase.module.Module

getMaintainerFunction, getVersionFunction

Fields inherited from class org.mmbase.util.functions.FunctionProvider

functions, getFunctions

Constructor Summary

MMAdmin()

Method Summary

void	addBuilderField(Map vars)
void	doBuilderPosts(String command, Hashtable cmds, Hashtable vars)
void	doModulePosts(String command, Hashtable cmds, Hashtable vars)
Vector	getList(PageInfo sp, StringTagger tagger, String value) Generate a list of values from a command to the processor
MMObjectBuilder	getListBuilder(String command, Map params) Returns a virtual builder used to create node lists from the results returned by getList().
MMObjectBuilder	getMMObject(String path) Retrieves a specified builder.
Vector	getMultilevelCacheEntries()
Vector	getNodeCacheEntries()
boolean	getState() Wether MMAdmin module was completely initialized (applications auto-deployed and so on).
void	init() Initializes the module. Init must be overridden to read the environment variables it needs. This method is called by Module.startModule(), which makes sure it is not called more than once. You should not call init() directly, call startModule() instead.
void	probeCall()
boolean	process(PageInfo sp, Hashtable cmds, Hashtable vars) Execute the commands provided in the form values
void	removeBuilderField(Hashtable vars)
String	replace(PageInfo sp, String cmds) Handle a $MOD command
void	setBuilderDBField(Hashtable vars)
void	setBuilderDBKey(Hashtable vars)
void	setBuilderDBNotNull(Hashtable vars)
void	setBuilderDBSize(Hashtable vars)
void	setBuilderDBState(Hashtable vars)
void	setBuilderDescription(Hashtable vars)
void	setBuilderEditorInput(Hashtable vars)
void	setBuilderEditorList(Hashtable vars)
void	setBuilderEditorSearch(Hashtable vars)
void	setBuilderGuiName(Hashtable vars)
void	setBuilderGuiType(Hashtable vars)
void	setModuleProperty(Hashtable vars)
void	syncBuilderXML(MMObjectBuilder bul, String builder)
void	syncModuleXML(Module mod, String modname)

Methods inherited from class org.mmbase.module.ProcessorModule

cacheCheck, getNodeList, onload, reload, replace, unload

Methods inherited from class org.mmbase.module.Module

getInitParameter, getInitParameters, getMaintainer, getModule, getModule, getModuleInfo, getModuleLoader, getModuleReader, getModules, getName, getProperties, getProperty, getVersion, hasStarted, maintainance, setInitParameter, setMaintainer, setName, setVersion, shutdown, shutdownModules, startModule, startModules, state

Methods inherited from class org.mmbase.util.functions.FunctionProvider

addFunction, createParameters, getFunction, getFunctions, getFunctionValue, newFunctionInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

MMAdmin

public MMAdmin()

Method Detail

init

public void init()

Description copied from class: ProcessorModule

Initializes the module. Init must be overridden to read the environment variables it needs.
This method is called by Module.startModule(), which makes sure it is not called more than once. You should not call init() directly, call startModule() instead.

Overrides:

init in class ProcessorModule

Warning: No Java Documentation Available.

getListBuilder

public MMObjectBuilder getListBuilder(String command,
                                      Map params)

Returns a virtual builder used to create node lists from the results returned by getList(). The default method does not associate the builder with a cloud (mmbase module), so processormodules that need this association need to override this method. Note that different lists may return different builders.

Specified by:

getListBuilder in interface ProcessorInterface

Overrides:

getListBuilder in class ProcessorModule

Parameters:

command - the LIST command for which to retrieve the builder

params - contains the attributes for the list

getMMObject

public MMObjectBuilder getMMObject(String path)

Retrieves a specified builder. The builder's name can be extended with the subpath of that builder's configuration file. i.e. 'core/typedef' or 'basic/images'. The subpath part is ignored.

Parameters:

path - The path of the builder to retrieve

Returns:

a MMObjectBuilder is found, null otherwise

getList

public Vector getList(PageInfo sp,
                      StringTagger tagger,
                      String value)

Generate a list of values from a command to the processor

Specified by:

getList in interface ProcessorInterface

Overrides:

getList in class ProcessorModule

Warning: No Java Documentation Available.

process

public boolean process(PageInfo sp,
                       Hashtable cmds,
                       Hashtable vars)

Execute the commands provided in the form values

Specified by:

process in interface ProcessorInterface

Overrides:

process in class ProcessorModule

Warning: No Java Documentation Available.

replace

public String replace(PageInfo sp,
                      String cmds)

Handle a $MOD command

Specified by:

replace in interface ProcessorInterface

Overrides:

replace in class ProcessorModule

Warning: No Java Documentation Available.

setModuleProperty

public void setModuleProperty(Hashtable vars)

Warning: No Java Documentation Available.

probeCall

public void probeCall()
               throws SearchQueryException

Throws:

SearchQueryException

Warning: No Java Documentation Available.

getState

public boolean getState()

Wether MMAdmin module was completely initialized (applications auto-deployed and so on).

Since:

MMBase-1.7

doModulePosts

public void doModulePosts(String command,
                          Hashtable cmds,
                          Hashtable vars)

Warning: No Java Documentation Available.

doBuilderPosts

public void doBuilderPosts(String command,
                           Hashtable cmds,
                           Hashtable vars)

Warning: No Java Documentation Available.

setBuilderGuiName

public void setBuilderGuiName(Hashtable vars)

Warning: No Java Documentation Available.

setBuilderDescription

public void setBuilderDescription(Hashtable vars)

Since:

MMBase-1.7

Warning: No Java Documentation Available.

setBuilderGuiType

public void setBuilderGuiType(Hashtable vars)

Warning: No Java Documentation Available.

setBuilderEditorInput

public void setBuilderEditorInput(Hashtable vars)

Warning: No Java Documentation Available.

setBuilderEditorList

public void setBuilderEditorList(Hashtable vars)

Warning: No Java Documentation Available.

setBuilderEditorSearch

public void setBuilderEditorSearch(Hashtable vars)

Warning: No Java Documentation Available.

setBuilderDBSize

public void setBuilderDBSize(Hashtable vars)

Warning: No Java Documentation Available.

setBuilderDBField

public void setBuilderDBField(Hashtable vars)

Warning: No Java Documentation Available.

setBuilderDBState

public void setBuilderDBState(Hashtable vars)

Warning: No Java Documentation Available.

setBuilderDBKey

public void setBuilderDBKey(Hashtable vars)

Warning: No Java Documentation Available.

setBuilderDBNotNull

public void setBuilderDBNotNull(Hashtable vars)

Warning: No Java Documentation Available.

addBuilderField

public void addBuilderField(Map vars)

Warning: No Java Documentation Available.

removeBuilderField

public void removeBuilderField(Hashtable vars)

Warning: No Java Documentation Available.

syncBuilderXML

public void syncBuilderXML(MMObjectBuilder bul,
                           String builder)

Warning: No Java Documentation Available.

syncModuleXML

public void syncModuleXML(Module mod,
                          String modname)

Warning: No Java Documentation Available.

getMultilevelCacheEntries

public Vector getMultilevelCacheEntries()

Warning: No Java Documentation Available.

getNodeCacheEntries

public Vector getNodeCacheEntries()

Warning: No Java Documentation Available.