KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mmbase > module > ProcessorInterface


1 /*
2
3 This software is OSI Certified Open Source Software.
4 OSI Certified is a certification mark of the Open Source Initiative.
5
6 The license (Mozilla version 1.0) can be read at the MMBase site.
7 See http://www.MMBase.org/license
8
9 */

10 package org.mmbase.module;
11
12 import java.util.*;
13 import org.mmbase.module.core.*;
14 import org.mmbase.util.*;
15
16 /**
17  * @javadoc
18  * @deprecated
19  */

20 public interface ProcessorInterface {
21
22     /**
23      * Used to create node lists from the results returned by {@link #getList}.
24      * The default method does not associate the builder with a cloud (mmbase module),
25      * so processormodules that need this association need to override this method.
26      * Note that different lists may return different builders.
27      * @param command the LIST command for which to retrieve the builder
28      * @param params contains the attributes for the list
29      */

30     public MMObjectBuilder getListBuilder(String JavaDoc command, Map params);
31
32     /**
33      * Generate a list of values from a command to the processor.
34      * The values are grouped into nodes.
35      * @param context the context of the page or calling application (currently, this should be a PageInfo object)
36      * @param command the list command to execute.
37      * @param params contains the attributes for the list
38      * @return a <code>Vector</code> that contains the list values contained in MMObjectNode objects
39      */

40     public Vector getNodeList(Object JavaDoc context, String JavaDoc command, Map params);
41
42     /**
43      * Generate a list of values from a command to the processor.
44      * @param context the page context
45      * @param tagger contains the attributes for the list
46      * @param command the list command to execute.
47      */

48     public Vector getList(PageInfo context, StringTagger tagger, String JavaDoc command);
49
50     /**
51      * Execute the commands provided in the form values.
52      * @param context the page context
53      * @param cmds contains the list of commands to run
54      * @param vars contains the attributes for the process
55      */

56     public boolean process(PageInfo context, Hashtable cmds, Hashtable vars);
57
58     /**
59      * Replace a command by a string.
60      * @param context the page context
61      * @param command the command to execute.
62      */

63     public String JavaDoc replace (PageInfo context, String JavaDoc command);
64
65     /**
66      * Replace a command by a string.
67      * @param context the page context
68      * @param command the command to execute
69      */

70     public String JavaDoc replace (PageInfo context, StringTagger command);
71
72     /**
73      * Do a cache check (304) for this request.
74      * @param context the page context
75      * @param command the command to execute.
76      */

77     public boolean cacheCheck(PageInfo context, String JavaDoc command);
78 }
79
80
Popular Tags