org.mmbase.module.gui.html

Class HtmlBase

java.lang.Object

org.mmbase.util.functions.FunctionProvider

org.mmbase.util.functions.DescribedFunctionProvider

org.mmbase.module.Module

org.mmbase.module.ProcessorModule

org.mmbase.module.gui.html.HtmlBase

All Implemented Interfaces:

Descriptor

public class HtmlBase
extends ProcessorModule

The module which provides access to the multimedia database it creates, deletes and gives you methods to keep track of multimedia objects. It does not give you direct methods for inserting and reading them thats done by other objects

Version:

$Id$

Author:

Daniel Ockeloen

Application:

SCAN

Nested Class Summary

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

ProcessorModule.GetNodeListFunction, ProcessorModule.ProcessFunction, ProcessorModule.ReplaceFunction

Field Summary

Fields

Modifier and Type	Field and Description
(package private) MMBase	mmb
(package private) boolean	scancache
(package private) sessionsInterface	sessions

Fields inherited from class org.mmbase.module.ProcessorModule

PARAM_PAGEINFO, PARAMS_PAGEINFO

Fields inherited from class org.mmbase.module.Module

configurationPath, getMaintainerFunction, getVersionFunction, properties, STATE_START_TIME

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

description, guiName, name

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

functions, getFunctions

Constructor Summary

Constructors

Constructor and Description
HtmlBase()

Method Summary

Modifier and Type	Method and Description
Vector	doBuilder(PageInfo sp, StringTagger tagger, StringTokenizer tok)
String	doBuilderReplace(PageInfo sp, StringTokenizer tok)
(package private) String	doCache(PageInfo sp, StringTokenizer tok)
String	doGetAgeMarker(StringTokenizer tok) Returns the number of marked days from a specified daycount (?)
String	doGetRelationCount(PageInfo sp, StringTokenizer tok)
String	doGetRelationValue(PageInfo sp, StringTokenizer tok)
Vector	doMultiLevel(PageInfo sp, StringTagger tagger)
Vector	doObjects(PageInfo sp, StringTagger tagger) show Objects
String	doObjects(StringTagger tagger)
Vector	doRelations_replace(PageInfo sp, StringTokenizer tok) show Relations
Vector	doRelations(PageInfo sp, StringTagger tagger) show Relations
String	doSetRelationValue(PageInfo sp, StringTokenizer tok)
(package private) String	getBuilderValue(PageInfo sp, StringTokenizer tok)
(package private) String	getGuiIndicator(PageInfo sp, StringTokenizer tok)
List<String>	getList(PageInfo sp, StringTagger tagger, String value) Generate a list of values from a command to the processor
MultilevelCacheHandler	getMultilevelCacheHandler()
(package private) String	getObjectField(PageInfo sp, StringTokenizer tok)
(package private) String	getObjectField(StringTokenizer tok)
(package private) String	getObjectProperty(PageInfo sp, StringTokenizer tok)
(package private) String	getObjectType(PageInfo sp, StringTokenizer tok)
(package private) String	getObjectTypeName(PageInfo sp, StringTokenizer tok)
sessionInfo	getPageSession(scanpage sp) Deprecated. always returns null, do not use.
String	getSearchAge(StringTokenizer tok)
Hashtable<Integer,MMObjectNode>	getSearchHash(Vector se, String mapper)
(package private) static NodeSearchQuery	getSearchQuery(MMObjectBuilder bul, String where, String sorted, String directions)
String	getWhereList(Vector se, String mapper)
void	init() Initializes the module.
String	isBuilderActive(StringTokenizer tok) Returns whether a builder is active.
boolean	process(PageInfo sp, Hashtable cmds, Hashtable vars) Execute the commands provided in the form values
String	replace(PageInfo sp, String cmds) Handle a $MOD command
(package private) static Enumeration	search(MMObjectBuilder bul, String where, String sorted, boolean direction)
void	stop()

Methods inherited from class org.mmbase.module.ProcessorModule

getListBuilder, getNodeList, onload, reload, replace, unload

Methods inherited from class org.mmbase.module.Module

addInitParameters, getInitParameter, getInitParameter, getInitParameter, getInitParameters, getInitParameters, getMaintainer, getModule, getModule, getModule, getModule, getModuleInfo, getModuleLoader, getModuleReader, getModuleReader, getModules, getState, getStates, getVersion, hasModule, hasStarted, loadInitParameters, loadInitParameters, maintainance, setInitParameter, setMaintainer, setState, setVersion, shutdown, shutdownModules, startModule, startModules

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

getDefaultLocale, getDescription, getDescription, getGUIName, getGUIName, getLocalizedDescription, getLocalizedGUIName, getName, setDescription, setDescription, setGUIName, setGUIName, setLocalizedDescription, setLocalizedGUIName, setName

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

Field Detail

sessions

sessionsInterface sessions

scancache

boolean scancache

mmb

MMBase mmb

Constructor Detail

HtmlBase

public HtmlBase()

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

search

static Enumeration search(MMObjectBuilder bul,
                          String where,
                          String sorted,
                          boolean direction)

getSearchQuery

static NodeSearchQuery getSearchQuery(MMObjectBuilder bul,
                                      String where,
                                      String sorted,
                                      String directions)

getList

public List<String> getList(PageInfo sp,
                            StringTagger tagger,
                            String value)

Generate a list of values from a command to the processor

Overrides:

getList in class ProcessorModule

doObjects

public Vector doObjects(PageInfo sp,
                        StringTagger tagger)

show Objects

doRelations

public Vector doRelations(PageInfo sp,
                          StringTagger tagger)

show Relations

doGetRelationValue

public String doGetRelationValue(PageInfo sp,
                                 StringTokenizer tok)

doGetRelationCount

public String doGetRelationCount(PageInfo sp,
                                 StringTokenizer tok)

doSetRelationValue

public String doSetRelationValue(PageInfo sp,
                                 StringTokenizer tok)

doRelations_replace

public Vector doRelations_replace(PageInfo sp,
                                  StringTokenizer tok)

show Relations

process

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

Execute the commands provided in the form values

Overrides:

process in class ProcessorModule

replace

public String replace(PageInfo sp,
                      String cmds)

Handle a $MOD command

Overrides:

replace in class ProcessorModule

doCache

String doCache(PageInfo sp,
               StringTokenizer tok)

getObjectType

String getObjectType(PageInfo sp,
                     StringTokenizer tok)

getObjectTypeName

String getObjectTypeName(PageInfo sp,
                         StringTokenizer tok)

getGuiIndicator

String getGuiIndicator(PageInfo sp,
                       StringTokenizer tok)

getBuilderValue

String getBuilderValue(PageInfo sp,
                       StringTokenizer tok)

getObjectField

String getObjectField(PageInfo sp,
                      StringTokenizer tok)

getObjectProperty

String getObjectProperty(PageInfo sp,
                         StringTokenizer tok)

getSearchHash

public Hashtable<Integer,MMObjectNode> getSearchHash(Vector se,
                                                     String mapper)

getWhereList

public String getWhereList(Vector se,
                           String mapper)

doMultiLevel

public Vector doMultiLevel(PageInfo sp,
                           StringTagger tagger)
                    throws MultiLevelParseException

Throws:

MultiLevelParseException

doBuilderReplace

public String doBuilderReplace(PageInfo sp,
                               StringTokenizer tok)

isBuilderActive

public String isBuilderActive(StringTokenizer tok)

Returns whether a builder is active.

Parameters:

tok - tokenized command, should contain the builder name

Returns:

TRUE if the builder is active, FALSE otherwise

doBuilder

public Vector doBuilder(PageInfo sp,
                        StringTagger tagger,
                        StringTokenizer tok)
                 throws ParseException

Throws:

ParseException

getPageSession

public sessionInfo getPageSession(scanpage sp)

Deprecated. always returns null, do not use.

Vpro:

refers to 'James'

stop

public void stop()

getObjectField

String getObjectField(StringTokenizer tok)

doObjects

public String doObjects(StringTagger tagger)

getSearchAge

public String getSearchAge(StringTokenizer tok)

getMultilevelCacheHandler

public MultilevelCacheHandler getMultilevelCacheHandler()

doGetAgeMarker

public String doGetAgeMarker(StringTokenizer tok)

Returns the number of marked days from a specified daycount (?)