[16869] | 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 | */
|
---|
[4991] | 19 | package org.greenstone.gsdl3.util;
|
---|
| 20 |
|
---|
| 21 | import java.util.HashMap;
|
---|
| 22 |
|
---|
| 23 | /** keeps track of the interface parameters, and their defaults */
|
---|
[24861] | 24 | public class GSParams
|
---|
| 25 | {
|
---|
| 26 | public static final String ACTION = "a"; // the major type of action- eg query or browse or process
|
---|
| 27 | public static final String SUBACTION = "sa"; // subtype of action if we want different processing than the default
|
---|
| 28 | 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
|
---|
| 29 | public static final String RESPONSE_ONLY = "ro"; // if == 1 do the request and pass back the response xml - no page formatting
|
---|
| 30 | public static final String OUTPUT = "o"; // if processing is to be done, what type of output - html/xml/other??
|
---|
[24019] | 31 | public static final String HTTPHEADERFIELDS = "hhf";
|
---|
[24861] | 32 | public static final String SERVICE = "s"; // the name of the service
|
---|
| 33 | public static final String CLUSTER = "c"; // these two are the same
|
---|
| 34 | public static final String SYSTEM = "s";
|
---|
| 35 | public static final String CONFIGURE = "c";
|
---|
| 36 | public static final String COLLECTION = "c";
|
---|
| 37 | public static final String LANGUAGE = "l";
|
---|
| 38 | public static final String DOCUMENT = "d";
|
---|
| 39 | public static final String DOCUMENT_TYPE = "dt";
|
---|
| 40 | public static final String RESOURCE = "r";
|
---|
| 41 | public static final String PROCESS_ID = "pid"; // if a request wasn't completed, this identifies the request - used when asking for a status update
|
---|
| 42 | public static final String COLLECTION_TYPE = "ct";
|
---|
[4991] | 43 |
|
---|
[24861] | 44 | public static final String SIBLING = "sib"; // this should not be in here
|
---|
| 45 | // internal configure args
|
---|
| 46 | public static final String SYSTEM_SUBSET = "ss";
|
---|
| 47 | public static final String SYSTEM_CLUSTER = "sc";
|
---|
| 48 | public static final String SYSTEM_MODULE_NAME = "sn";
|
---|
| 49 | public static final String SYSTEM_MODULE_TYPE = "st";
|
---|
| 50 |
|
---|
| 51 | public static final String EXPAND_DOCUMENT = "ed";
|
---|
| 52 | public static final String EXPAND_CONTENTS = "ec";
|
---|
[23968] | 53 | public static final String REALISTIC_BOOK = "book";
|
---|
[23269] | 54 |
|
---|
[24861] | 55 | // used for filtering out a piece of the final page
|
---|
| 56 | public static final String EXCERPT_ID = "excerptid";
|
---|
| 57 | public static final String EXCERPT_TAG = "excerpttag";
|
---|
| 58 | protected HashMap param_map = null;
|
---|
[4991] | 59 |
|
---|
[24861] | 60 | public GSParams()
|
---|
| 61 | {
|
---|
| 62 | this.param_map = new HashMap(30);
|
---|
[23269] | 63 |
|
---|
[24861] | 64 | // add in all the standard params
|
---|
| 65 | addParameter(ACTION, false);
|
---|
| 66 | addParameter(SUBACTION, false);
|
---|
| 67 | addParameter(REQUEST_TYPE, false);
|
---|
| 68 | addParameter(RESPONSE_ONLY, false);
|
---|
| 69 | addParameter(CLUSTER, false); // we don't want to save collection
|
---|
| 70 | //addParameter(COLLECTION);
|
---|
| 71 | addParameter(LANGUAGE, true);
|
---|
| 72 | addParameter(DOCUMENT, true);
|
---|
| 73 | addParameter(RESOURCE, true);
|
---|
| 74 | addParameter(OUTPUT, false);
|
---|
| 75 | addParameter(SERVICE, false);
|
---|
| 76 | addParameter(PROCESS_ID, true);
|
---|
| 77 | addParameter(SYSTEM_SUBSET, false);
|
---|
| 78 | addParameter(SYSTEM_CLUSTER, false);
|
---|
| 79 | addParameter(SYSTEM_MODULE_NAME, false);
|
---|
| 80 | addParameter(SYSTEM_MODULE_TYPE, false);
|
---|
| 81 | addParameter(SIBLING, false);
|
---|
| 82 | addParameter(DOCUMENT_TYPE, true);
|
---|
| 83 | addParameter(EXPAND_DOCUMENT, false);
|
---|
| 84 | addParameter(EXPAND_CONTENTS, false);
|
---|
| 85 | addParameter(REALISTIC_BOOK, false);
|
---|
| 86 |
|
---|
| 87 | //addParameter();
|
---|
| 88 | // ugly hack so we don't save the extlink param
|
---|
| 89 | addParameter("s0.ext", false);
|
---|
| 90 | addParameter(COLLECTION_TYPE, true); // collection type - mg or mgpp
|
---|
| 91 |
|
---|
| 92 | // filtering args must be specified each time
|
---|
| 93 | addParameter(EXCERPT_ID, false);
|
---|
| 94 | addParameter(EXCERPT_TAG, false);
|
---|
[4991] | 95 | }
|
---|
| 96 |
|
---|
[24861] | 97 | public boolean addParameter(String name, boolean save)
|
---|
| 98 | {
|
---|
| 99 | return addParameter(name, "", save);
|
---|
| 100 | }
|
---|
[4991] | 101 |
|
---|
[24861] | 102 | public boolean addParameter(String name, String default_value, boolean save)
|
---|
| 103 | {
|
---|
| 104 | if (this.param_map.containsKey(name))
|
---|
| 105 | {
|
---|
| 106 | // already there so could not add
|
---|
| 107 | return false;
|
---|
| 108 | }
|
---|
[4991] | 109 |
|
---|
[24861] | 110 | this.param_map.put(name, new Param(default_value, save));
|
---|
| 111 | return true;
|
---|
[4991] | 112 | }
|
---|
[24861] | 113 |
|
---|
| 114 | public boolean setParamDefault(String name, String default_value)
|
---|
| 115 | {
|
---|
| 116 | Param p = (Param) this.param_map.get(name);
|
---|
| 117 | if (p == null)
|
---|
| 118 | return false;
|
---|
| 119 | p.default_value = default_value;
|
---|
| 120 | return true;
|
---|
| 121 | }
|
---|
| 122 |
|
---|
| 123 | public boolean shouldSave(String name)
|
---|
| 124 | {
|
---|
| 125 | if (name.startsWith("p."))
|
---|
| 126 | return false;
|
---|
| 127 | Param p = (Param) this.param_map.get(name);
|
---|
| 128 | if (p == null)
|
---|
| 129 | return true; // if things are not in here, always save.
|
---|
| 130 | return p.save;
|
---|
| 131 | }
|
---|
| 132 |
|
---|
| 133 | private class Param
|
---|
| 134 | {
|
---|
| 135 |
|
---|
| 136 | public String default_value = null;
|
---|
| 137 | public boolean save = true;
|
---|
| 138 |
|
---|
| 139 | public Param(String default_value, boolean save)
|
---|
| 140 | {
|
---|
| 141 | this.default_value = default_value;
|
---|
| 142 | this.save = save;
|
---|
| 143 | }
|
---|
| 144 | }
|
---|
[4991] | 145 | }
|
---|