source: main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/GSParams.java@ 25653

Last change on this file since 25653 was 25653, checked in by sjm84, 12 years ago

Added a param that allows the skipping of ajax loads (used by the javascript)
  • Property svn:keywords set to Author Date Id Revision
File size: 6.1 KB
Line 
1/*
2 * GSParams.java
3 * Copyright (C) 2008 New Zealand Digital Library, http://www.nzdl.org
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19package org.greenstone.gsdl3.util;
20
21import java.util.HashMap;
22
23/** keeps track of the interface parameters, and their defaults */
24public class GSParams
25{
26
27 // cgi parameter names
28 public static final String ACTION = "a"; // the major type of action- eg query or browse or process
29 public static final String SUBACTION = "sa"; // subtype of action if we want different processing than the default
30 public static final String REQUEST_TYPE = "rt"; // whether the request is just to display the service form, or to actually do a request to the service
31 public static final String RESPONSE_ONLY = "ro"; // if == 1 do the request and pass back the response xml - no page formatting
32 public static final String OUTPUT = "o"; // if processing is to be done, what type of output - html/xml/other??
33 public static final String SERVICE = "s"; // the name of the service
34
35 public static final String CLUSTER = "c"; // these two are the same
36 public static final String COLLECTION = "c";
37 public static final String COLLECTION_TYPE = "ct"; // collection type - mg, mgpp, lucene etc
38
39 public static final String LANGUAGE = "l";
40 public static final String DOCUMENT = "d";
41 public static final String DOCUMENT_TYPE = "dt";
42 public static final String START_PAGE = "startPage";
43 public static final String HREF = "href"; // url. might be an external url, or a relative one that needs translating
44 public static final String RELATIVE_LINK = "rl"; // whether the href url is relative to the collection or not.
45 public static final String EXTERNAL_LINK_TYPE = "el"; // for an external link, go direct to the page or frame it in the collection
46 public static final String PROCESS_ID = "pid"; // if a request wasn't completed, this identifies the request - used when asking for a status update
47
48 public static final String HTTPHEADERFIELDS = "hhf";
49
50 // internal configure args
51 public static final String SYSTEM_SUBSET = "ss";
52 public static final String SYSTEM_CLUSTER = "sc";
53 public static final String SYSTEM_MODULE_NAME = "sn";
54 public static final String SYSTEM_MODULE_TYPE = "st";
55
56 // used for filtering out a piece of the final page
57 public static final String EXCERPT_ID = "excerptid";
58 public static final String EXCERPT_TAG = "excerpttag";
59
60 public static final String INLINE_TEMPLATE = "ilt";
61 public static final String DISPLAY_METADATA = "dmd";
62 public static final String FILE_LOCATION = "fl";
63 public static final String DOC_EDIT = "docEdit";
64 public static final String AJAX_LOAD_BYPASS = "alb";
65
66 //Administration
67 public static final String PASSWORD = "password";
68 public static final String S_PASSWORD = "s1.password";
69 public static final String S_NEW_PASSWORD = "s1.newPassword";
70 public static final String S_OLD_PASSWORD = "s1.oldPassword";
71
72 // some standard arg values
73 public static final String SYSTEM_ACTION = "s";
74
75 public static final String EXTERNAL_LINK_TYPE_DIRECT = "direct";
76 public static final String EXTERNAL_LINK_TYPE_FRAMED = "frame";
77
78 protected HashMap<String, Param> param_map = null;
79
80 public GSParams()
81 {
82 this.param_map = new HashMap<String, Param>(30);
83
84 // add in all the standard params
85 addParameter(ACTION, false);
86 addParameter(SUBACTION, false);
87 addParameter(REQUEST_TYPE, false);
88 addParameter(RESPONSE_ONLY, false);
89 addParameter(CLUSTER, false); // we don't want to save cluster/collection
90 addParameter(LANGUAGE, true);
91 addParameter(DOCUMENT, true);
92 addParameter(DOCUMENT_TYPE, true);
93 addParameter(START_PAGE, true);
94 // should the following two just be in doc action??
95 addParameter(HREF, false);
96 addParameter(RELATIVE_LINK, false);
97 addParameter(OUTPUT, false);
98 addParameter(SERVICE, false);
99 addParameter(PROCESS_ID, true);
100 addParameter(SYSTEM_SUBSET, false);
101 addParameter(SYSTEM_CLUSTER, false);
102 addParameter(SYSTEM_MODULE_NAME, false);
103 addParameter(SYSTEM_MODULE_TYPE, false);
104 addParameter(INLINE_TEMPLATE, false);
105 addParameter(DISPLAY_METADATA, false);
106 addParameter(AJAX_LOAD_BYPASS, false);
107 addParameter(DOC_EDIT, false);
108 addParameter(PASSWORD, false);
109 addParameter(S_PASSWORD, false);
110 addParameter(S_NEW_PASSWORD, false);
111 addParameter(S_OLD_PASSWORD, false);
112
113 addParameter(COLLECTION_TYPE, true);
114 addParameter(EXTERNAL_LINK_TYPE, false);
115 // filtering args must be specified each time
116 addParameter(EXCERPT_ID, false);
117 addParameter(EXCERPT_TAG, false);
118 }
119
120 public boolean addParameter(String name, boolean save)
121 {
122 return addParameter(name, "", save);
123 }
124
125 public boolean addParameter(String name, String default_value, boolean save)
126 {
127 if (this.param_map.containsKey(name))
128 {
129 // already there so could not add
130 return false;
131 }
132
133 this.param_map.put(name, new Param(default_value, save));
134 return true;
135 }
136
137 public boolean setParamDefault(String name, String default_value)
138 {
139 Param p = this.param_map.get(name);
140 if (p == null)
141 return false;
142 p.default_value = default_value;
143 return true;
144 }
145
146 public boolean shouldSave(String name)
147 {
148 // p. is used to store previous settings
149 if (name.startsWith("p."))
150 return false;
151 Param p = this.param_map.get(name);
152 if (p == null)
153 return true; // if things are not in here, always save.
154 return p.save;
155 }
156
157 private class Param
158 {
159
160 public String default_value = null;
161 public boolean save = true;
162
163 public Param(String default_value, boolean save)
164 {
165 this.default_value = default_value;
166 this.save = save;
167 }
168 }
169}
Note: See TracBrowser for help on using the repository browser.