org.mmbase.module.gui.html
Class HtmlBase

java.lang.Object
  |
  +--org.mmbase.module.Module
        |
        +--org.mmbase.module.ProcessorModule
              |
              +--org.mmbase.module.gui.html.HtmlBase

All Implemented Interfaces:

ProcessorInterface

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: HtmlBase.java,v 1.44.2.1 2003/02/21 09:33:35 vpro Exp $

Author:

Daniel Ockeloen

Constructor Summary

HtmlBase()

Method Summary

java.util.Vector	doBuilder(scanpage sp, StringTagger tagger, java.util.StringTokenizer tok)
java.lang.String	doBuilderReplace(scanpage sp, java.util.StringTokenizer tok)
java.lang.String	doGetRelationCount(scanpage sp, java.util.StringTokenizer tok)
java.lang.String	doGetRelationValue(scanpage sp, java.util.StringTokenizer tok)
java.util.Vector	doMultiLevel(scanpage sp, StringTagger tagger)
java.util.Vector	doObjects(scanpage sp, StringTagger tagger) show Objects
java.lang.String	doObjects(StringTagger tagger)
java.util.Vector	doRelations_replace(scanpage sp, java.util.StringTokenizer tok) show Relations
java.util.Vector	doRelations(scanpage sp, StringTagger tagger) show Relations
java.lang.String	doSetRelationValue(scanpage sp, java.util.StringTokenizer tok)
java.util.Vector	getList(scanpage sp, StringTagger tagger, java.lang.String value) Generate a list of values from a command to the processor
MultilevelCacheHandler	getMultilevelCacheHandler()
sessionInfo	getPageSession(scanpage sp) Deprecated. always returns null, do not use.
java.lang.String	getSearchAge(java.util.StringTokenizer tok)
java.util.Hashtable	getSearchHash(java.util.Vector se, java.lang.String mapper)
java.lang.String	getWhereList(java.util.Vector se, java.lang.String mapper)
void	init() Initializes the module.
java.lang.String	isBuilderActive(java.util.StringTokenizer tok) Returns whether a builder is active.
void	maintainance() maintainance call called by the admin module every x seconds.
boolean	process(scanpage sp, java.util.Hashtable cmds, java.util.Hashtable vars) Execute the commands provided in the form values
java.lang.String	replace(scanpage sp, java.lang.String cmds) Handle a $MOD command
void	stop()

Methods inherited from class org.mmbase.module.ProcessorModule

cacheCheck, getListBuilder, getNodeList, onload, reload, replace, shutdown, unload

Methods inherited from class org.mmbase.module.Module

getClassName, getInitParameter, getInitParameters, getMaintainer, getMimeType, getMimeTypeFile, getModule, getModule, getModuleInfo, getModules, getName, getProperties, getProperty, getVersion, hasStarted, loadModulesFromDisk, setClassName, setInitParameter, setMaintainer, setName, setVersion, shutdownModules, startModule, startModules, state

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlBase

public HtmlBase()

Method Detail

init

public void init()

Description copied from class: Module

Initializes the module. Init can 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

getList

public java.util.Vector getList(scanpage sp,
                                StringTagger tagger,
                                java.lang.String value)
                         throws ParseException

Generate a list of values from a command to the processor

Overrides:

getList in class ProcessorModule

Following copied from class: org.mmbase.module.ProcessorModule

Parameters:

sp - the page context

params - contains the attributes for the list

command - the list command to execute.

doObjects

public java.util.Vector doObjects(scanpage sp,
                                  StringTagger tagger)

show Objects

doRelations

public java.util.Vector doRelations(scanpage sp,
                                    StringTagger tagger)

show Relations

doGetRelationValue

public java.lang.String doGetRelationValue(scanpage sp,
                                           java.util.StringTokenizer tok)

doGetRelationCount

public java.lang.String doGetRelationCount(scanpage sp,
                                           java.util.StringTokenizer tok)

doSetRelationValue

public java.lang.String doSetRelationValue(scanpage sp,
                                           java.util.StringTokenizer tok)

doRelations_replace

public java.util.Vector doRelations_replace(scanpage sp,
                                            java.util.StringTokenizer tok)

show Relations

process

public boolean process(scanpage sp,
                       java.util.Hashtable cmds,
                       java.util.Hashtable vars)

Execute the commands provided in the form values

Overrides:

process in class ProcessorModule

replace

public java.lang.String replace(scanpage sp,
                                java.lang.String cmds)

Handle a $MOD command

Overrides:

replace in class ProcessorModule

maintainance

public void maintainance()

Description copied from class: Module

maintainance call called by the admin module every x seconds.

Overrides:

maintainance in class Module

getSearchHash

public java.util.Hashtable getSearchHash(java.util.Vector se,
                                         java.lang.String mapper)

getWhereList

public java.lang.String getWhereList(java.util.Vector se,
                                     java.lang.String mapper)

doMultiLevel

public java.util.Vector doMultiLevel(scanpage sp,
                                     StringTagger tagger)
                              throws MultiLevelParseException

doBuilderReplace

public java.lang.String doBuilderReplace(scanpage sp,
                                         java.util.StringTokenizer tok)

isBuilderActive

public java.lang.String isBuilderActive(java.util.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 java.util.Vector doBuilder(scanpage sp,
                                  StringTagger tagger,
                                  java.util.StringTokenizer tok)
                           throws ParseException

getPageSession

public sessionInfo getPageSession(scanpage sp)

Deprecated. always returns null, do not use.

stop

public void stop()

doObjects

public java.lang.String doObjects(StringTagger tagger)

getSearchAge

public java.lang.String getSearchAge(java.util.StringTokenizer tok)

getMultilevelCacheHandler

public MultilevelCacheHandler getMultilevelCacheHandler()