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

Last change on this file since 31870 was 31870, checked in by kjdon, 7 years ago

added ed, ec, noText into the params
  • Property svn:keywords set to Author Date Id Revision
File size: 7.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 servlet 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 UN = "un"; // username for authenticated-ping
36 public static final String PW = "pw"; // pwd for authenticated-ping
37
38 public static final String CLUSTER = "c"; // these two are the same
39 public static final String COLLECTION = "c";
40 public static final String COLLECTION_TYPE = "ct"; // collection type - mg, mgpp, lucene etc
41
42 public static final String LANGUAGE = "l";
43 public static final String DOCUMENT = "d";
44 public static final String DOCUMENT_TYPE = "dt";
45 public static final String START_PAGE = "startPage";
46 public static final String S_START_PAGE = "s1.startPage";
47 public static final String HREF = "href"; // url. might be an external url, or a relative one that needs translating
48 public static final String RELATIVE_LINK = "rl"; // whether the href url is relative to the collection or not.
49 public static final String EXTERNAL_LINK_TYPE = "el"; // for an external link, go direct to the page or frame it in the collection
50 public static final String PROCESS_ID = "pid"; // if a request wasn't completed, this identifies the request - used when asking for a status update
51
52 public static final String HTTP_HEADER_FIELDS = "hhf";
53 public static final String QUICK_SEARCH = "qs";
54
55 // internal configure args
56 public static final String SYSTEM_SUBSET = "ss";
57 public static final String SYSTEM_CLUSTER = "sc";
58 public static final String SYSTEM_MODULE_NAME = "sn";
59 public static final String SYSTEM_MODULE_TYPE = "st";
60
61 // used for filtering out a piece of the final page
62 public static final String EXCERPT_ID = "excerptid";
63 public static final String EXCERPT_TAG = "excerpttag";
64
65 public static final String INLINE_TEMPLATE = "ilt";
66 public static final String DISPLAY_METADATA = "dmd";
67 public static final String FILE_LOCATION = "fl";
68 public static final String DOC_EDIT = "docEdit";
69 public static final String AJAX_LOAD_BYPASS = "alb";
70
71 // document display args
72 public static final String EXPAND_DOCUMENT = "ed";
73 public static final String EXPAND_CONTENTS = "ec";
74 public static final String NO_TEXT = "noText";
75 //Administration
76 public static final String PASSWORD = "password";
77 public static final String S_PASSWORD = "s1.password";
78 public static final String S_NEW_PASSWORD = "s1.newPassword";
79 public static final String S_OLD_PASSWORD = "s1.oldPassword";
80
81 //Facets
82 public static final String S_FACETS = "s1.facets";
83 public static final String S_FACETS_QUERIES = "s1.facetQueries";
84
85 // some standard arg values
86 public static final String SYSTEM_ACTION = "s";
87
88 // rss feeds
89 public static final String RSS_ACTION = "rss";
90
91 public static final String EXTERNAL_LINK_TYPE_DIRECT = "direct";
92 public static final String EXTERNAL_LINK_TYPE_FRAMED = "frame";
93
94 public static final String DEBUG = "debug";
95
96 protected HashMap<String, Param> param_map = null;
97
98 public GSParams()
99 {
100 this.param_map = new HashMap<String, Param>(30);
101
102 // add in all the standard params
103 addParameter(ACTION, false);
104 addParameter(SUBACTION, false);
105 addParameter(REQUEST_TYPE, false);
106 addParameter(RESPONSE_ONLY, false);
107 addParameter(CLUSTER, false); // we don't want to save cluster/collection
108 addParameter(LANGUAGE, true);
109 addParameter(DOCUMENT, true);
110 addParameter(DOCUMENT_TYPE, false);
111 addParameter(QUICK_SEARCH, false);
112 addParameter(START_PAGE, false);
113 addParameter(S_START_PAGE, false);
114 // should the following two just be in doc action??
115 addParameter(HREF, false);
116 addParameter(RELATIVE_LINK, false);
117 addParameter(OUTPUT, false);
118 addParameter(SERVICE, false);
119 addParameter(PROCESS_ID, true);
120 addParameter(SYSTEM_SUBSET, false);
121 addParameter(SYSTEM_CLUSTER, false);
122 addParameter(SYSTEM_MODULE_NAME, false);
123 addParameter(SYSTEM_MODULE_TYPE, false);
124 addParameter(INLINE_TEMPLATE, false);
125 addParameter(DISPLAY_METADATA, false);
126 addParameter(AJAX_LOAD_BYPASS, false);
127 addParameter(EXPAND_DOCUMENT, false);
128 addParameter(EXPAND_CONTENTS, false);
129 addParameter(NO_TEXT, false);
130 addParameter(DOC_EDIT, false);
131 addParameter(PASSWORD, false);
132 addParameter(S_PASSWORD, false);
133 addParameter(S_NEW_PASSWORD, false);
134 addParameter(S_OLD_PASSWORD, false);
135
136 addParameter(S_FACETS, false);
137 addParameter(S_FACETS_QUERIES, false);
138
139 addParameter(COLLECTION_TYPE, true);
140 addParameter(EXTERNAL_LINK_TYPE, false);
141 // filtering args must be specified each time
142 addParameter(EXCERPT_ID, false);
143 addParameter(EXCERPT_TAG, false);
144
145 addParameter(DEBUG, true);
146 }
147
148 public boolean addParameter(String name, boolean save)
149 {
150 return addParameter(name, "", save);
151 }
152
153 public boolean addParameter(String name, String default_value, boolean save)
154 {
155 if (this.param_map.containsKey(name))
156 {
157 // already there so could not add
158 return false;
159 }
160
161 this.param_map.put(name, new Param(default_value, save));
162 return true;
163 }
164
165 public boolean setParamDefault(String name, String default_value)
166 {
167 Param p = this.param_map.get(name);
168 if (p == null)
169 return false;
170 p.default_value = default_value;
171 return true;
172 }
173
174 public boolean shouldSave(String name)
175 {
176 // p. is used to store previous settings
177 if (name.startsWith("p.") || name.startsWith("md___"))
178 return false;
179 Param p = this.param_map.get(name);
180 if (p == null)
181 return true; // if things are not in here, always save.
182 return p.save;
183 }
184
185 private class Param
186 {
187
188 public String default_value = null;
189 public boolean save = true;
190
191 public Param(String default_value, boolean save)
192 {
193 this.default_value = default_value;
194 this.save = save;
195 }
196 }
197}
Note: See TracBrowser for help on using the repository browser.