org.mmbase.module
Interface ProcessorInterface

All Known Implementing Classes:
ProcessorModule

public interface ProcessorInterface


Method Summary
 boolean cacheCheck(scanpage sp, java.lang.String cmd)
          Do a cache check (304) for this request
 java.util.Vector getList(scanpage sp, StringTagger tagger, java.lang.String value)
          Generate a list of values from a command to the processor
 MMObjectBuilder getListBuilder(java.lang.String command, java.util.Map params)
          Returns a virtual builder used to create node lists from the results returned by getList().
 java.util.Vector getNodeList(java.lang.Object context, java.lang.String command, java.util.Map params)
          Generate a list of values from a command to the processor.
 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 command)
          Replace a command by a string
 java.lang.String replace(scanpage sp, StringTagger command)
          Replace a command by a string
 

Method Detail

getListBuilder

public MMObjectBuilder getListBuilder(java.lang.String command,
                                      java.util.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.
Parameters:
command - the LIST command for which to retrieve the builder
params - contains the attributes for the list

getNodeList

public java.util.Vector getNodeList(java.lang.Object context,
                                    java.lang.String command,
                                    java.util.Map params)
                             throws ParseException
Generate a list of values from a command to the processor. The values are grouped into nodes.
Parameters:
context - the context of the page or calling application (currently, this should be a scanpage object)
command - the list command to execute.
params - contains the attributes for the list
Returns:
a Vector that contains the list values contained in MMObjectNode objects

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
Parameters:
sp - the page context
tagger - contains the attributes for the list
command - the list command to execute.

process

public boolean process(scanpage sp,
                       java.util.Hashtable cmds,
                       java.util.Hashtable vars)
Execute the commands provided in the form values

replace

public java.lang.String replace(scanpage sp,
                                java.lang.String command)
Replace a command by a string

replace

public java.lang.String replace(scanpage sp,
                                StringTagger command)
Replace a command by a string

cacheCheck

public boolean cacheCheck(scanpage sp,
                          java.lang.String cmd)
Do a cache check (304) for this request


MMBase 2002