[2107] | 1 | /*
|
---|
| 2 | * NzdlQuery.java
|
---|
| 3 | * Copyright (C) 2001 New Zealand Digital Library Project
|
---|
| 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 | */
|
---|
[2055] | 19 |
|
---|
[2107] | 20 | //the package we're in
|
---|
[2098] | 21 | package org.nzdl.gsdl.service;
|
---|
[2055] | 22 |
|
---|
[2159] | 23 | import java.util.HashMap;
|
---|
| 24 | import java.util.Map;
|
---|
| 25 | import java.util.Set;
|
---|
| 26 | import java.util.Collection;
|
---|
| 27 |
|
---|
[2098] | 28 | import org.nzdl.gsdl.util.NzdlConstants;
|
---|
[2055] | 29 |
|
---|
[2107] | 30 | /**
|
---|
| 31 | * NzdlQuery is an object that holds the options for a query and is
|
---|
| 32 | * easily configured by the user.
|
---|
| 33 | *
|
---|
| 34 | * @author Stuart Yeates ([email protected])
|
---|
| 35 | * @author Aziz Mahoui ([email protected])
|
---|
| 36 | * @author Gordon Paynter ([email protected])
|
---|
[2163] | 37 | * @author Brett Sheeran ([email protected]) (comments)
|
---|
[2107] | 38 | * @version $Revision: 2163 $
|
---|
| 39 | */
|
---|
| 40 |
|
---|
[2055] | 41 | public class NzdlQuery extends java.lang.Object {
|
---|
| 42 |
|
---|
[2107] | 43 |
|
---|
[2055] | 44 | private Map m_Options = null;
|
---|
| 45 |
|
---|
[2107] | 46 | /**
|
---|
| 47 | * Creates an instance of NzdlQuery with an empty query string.
|
---|
[2108] | 48 | * This can then be used as a constructor parameter when creating a
|
---|
| 49 | * {@link NzdlRequest NzdlRequest} object for servicing by a
|
---|
| 50 | * {@link NzdlService NzdlService} object.
|
---|
| 51 | * Default values for a NzdlQuery object are: maxDocs 200, startResults= 1,
|
---|
| 52 | * endResults= 10, queryType= "ranked", caseFolding= true, stemming= false,
|
---|
| 53 | * queryTerm= "".
|
---|
[2107] | 54 | */
|
---|
[2055] | 55 | public NzdlQuery() {
|
---|
| 56 | m_Options = new HashMap();
|
---|
| 57 | setQueryTerm ( NzdlConstants.DEFAULT_QUERY_TERM );
|
---|
| 58 | setQueryType ( NzdlConstants.DEFAULT_QUERY_TYPE );
|
---|
| 59 | setCaseFolding ( NzdlConstants.DEFAULT_CASE_FOLDING );
|
---|
| 60 | setStemming ( NzdlConstants.DEFAULT_STEMMING );
|
---|
| 61 | setStartResults( NzdlConstants.DEFAULT_START_RESULTS );
|
---|
| 62 | setEndResults ( NzdlConstants.DEFAULT_END_RESULTS );
|
---|
| 63 | setMaxDocs ( NzdlConstants.DEFAULT_MAX_DOCS );
|
---|
| 64 | }
|
---|
| 65 |
|
---|
[2107] | 66 | /**
|
---|
| 67 | * Creates an instance of NzdlQuery with a value for query string. Has the
|
---|
| 68 | * same default values as NzdlQuery(), with the exception of term which is
|
---|
| 69 | * loaded into the query string field.
|
---|
| 70 | * @param term the query string
|
---|
| 71 | */
|
---|
[2055] | 72 | public NzdlQuery( String _term ) {
|
---|
| 73 | m_Options = new HashMap();
|
---|
| 74 | setQueryTerm ( _term );
|
---|
| 75 | setQueryType ( NzdlConstants.DEFAULT_QUERY_TYPE );
|
---|
| 76 | setCaseFolding ( NzdlConstants.DEFAULT_CASE_FOLDING );
|
---|
| 77 | setStemming ( NzdlConstants.DEFAULT_STEMMING );
|
---|
| 78 | setStartResults( NzdlConstants.DEFAULT_START_RESULTS );
|
---|
| 79 | setEndResults ( NzdlConstants.DEFAULT_END_RESULTS );
|
---|
| 80 | setMaxDocs ( NzdlConstants.DEFAULT_MAX_DOCS );
|
---|
| 81 | }
|
---|
| 82 |
|
---|
[2107] | 83 | /**
|
---|
| 84 | * Sets the expression to be queried. Note: this can also be done using the
|
---|
| 85 | * constructor.
|
---|
| 86 | * @param term the query expression string
|
---|
| 87 | */
|
---|
[2055] | 88 | public void setQueryTerm(String _term) {
|
---|
| 89 | m_Options.put("Term", _term);
|
---|
| 90 | }
|
---|
| 91 |
|
---|
[2107] | 92 | /**
|
---|
| 93 | * Sets the query type as either "ranked" or "boolean". "ranked"
|
---|
| 94 | * orders results by suitability. "boolean" allows use of operators such as
|
---|
| 95 | * !, &, |. Default is "ranked"
|
---|
| 96 | * @param type "ranked" or "boolean"
|
---|
| 97 | */
|
---|
[2055] | 98 | public void setQueryType(String _type) {
|
---|
| 99 | m_Options.put("QueryType", _type);
|
---|
| 100 | }
|
---|
| 101 |
|
---|
[2107] | 102 | /**
|
---|
| 103 | * Sets query to ignore case. Default is true.
|
---|
| 104 | * @param case if false then sets query to be case sensitive. If true
|
---|
| 105 | * then sets query to be case insenstive.
|
---|
| 106 | */
|
---|
[2055] | 107 | public void setCaseFolding(String _case) {
|
---|
| 108 | m_Options.put("CaseFold", _case);
|
---|
| 109 | }
|
---|
| 110 |
|
---|
[2107] | 111 | /**
|
---|
[2108] | 112 | * Sets query to ignore word endings. Default is "false."
|
---|
| 113 | * @param stem if "true", sets query to strip endings such as "...ing",
|
---|
| 114 | * "...ed". If "false", sets query to only match whole words.
|
---|
[2107] | 115 | */
|
---|
[2055] | 116 | public void setStemming(String _stem) {
|
---|
| 117 | m_Options.put("Stem", _stem);
|
---|
| 118 | }
|
---|
| 119 |
|
---|
[2107] | 120 | /**
|
---|
| 121 | * Sets the maximum number of documents that can be found by a query.
|
---|
| 122 | * Default is 200.
|
---|
| 123 | * @param max The maximum permitted number of documents to be found
|
---|
| 124 | * by the query
|
---|
| 125 | */
|
---|
| 126 | public void setMaxDocs(int _max) {
|
---|
| 127 | m_Options.put("Maxdocs", new Integer(_max));
|
---|
| 128 | }
|
---|
| 129 |
|
---|
| 130 | /**
|
---|
| 131 | * Sets the start number of the result set. The result set is a subset
|
---|
| 132 | * of the maximum number of documents that will be found by the query.
|
---|
| 133 | * Default is 1.
|
---|
| 134 | * @param start the number of the first document, relative to the found
|
---|
| 135 | * documents
|
---|
| 136 | */
|
---|
[2055] | 137 | public void setStartResults(int _start) {
|
---|
| 138 | m_Options.put("StartResults", new Integer(_start));
|
---|
| 139 | }
|
---|
| 140 |
|
---|
[2107] | 141 | /**
|
---|
| 142 | * Sets the end number of the result set. The result set is a subset of the
|
---|
| 143 | * maximum number documents that could be found by that query.
|
---|
| 144 | * Default is 10.
|
---|
| 145 | * @param end the number of the last document relative to the found
|
---|
| 146 | * documents
|
---|
| 147 | */
|
---|
[2055] | 148 | public void setEndResults(int _end) {
|
---|
| 149 | m_Options.put("EndResults", new Integer(_end));
|
---|
| 150 | }
|
---|
| 151 |
|
---|
[2107] | 152 | /**
|
---|
| 153 | * Returns whether query is "ranked" or "boolean". "ranked" orders results by
|
---|
| 154 | * suitability. "boolean" allows use of operators such as !, &, |. Default is
|
---|
| 155 | * "ranked"
|
---|
| 156 | * @return Either "ranked" or "boolean"
|
---|
| 157 | */
|
---|
[2055] | 158 | public String getQueryType() {
|
---|
| 159 | return (String)m_Options.get("QueryType");
|
---|
| 160 | }
|
---|
| 161 |
|
---|
[2107] | 162 | /**
|
---|
| 163 | * Returns the query string expression.
|
---|
| 164 | * @return the query string
|
---|
| 165 | */
|
---|
[2055] | 166 | public String getQueryTerm() {
|
---|
| 167 | return (String)m_Options.get("Term");
|
---|
| 168 | }
|
---|
| 169 |
|
---|
[2107] | 170 | /**
|
---|
| 171 | * Returns "true" if query is case insenstive. Default is "true"
|
---|
| 172 | * @return "true" if query is case insenstive, "false" if the query is case
|
---|
| 173 | * senstive.
|
---|
| 174 | */
|
---|
[2055] | 175 | public String getCaseFolding() {
|
---|
| 176 | return (String)m_Options.get("CaseFold");
|
---|
| 177 | }
|
---|
| 178 |
|
---|
[2107] | 179 | /**
|
---|
| 180 | * Returns "true" if query ignores word endings. Default is "false".
|
---|
| 181 | * @return "true" if query strips endings such as "...ing" or "...ed" , false
|
---|
| 182 | * if query only matches whole words.
|
---|
| 183 | */
|
---|
[2055] | 184 | public String getStemming() {
|
---|
| 185 | return (String)m_Options.get("Stem");
|
---|
| 186 | }
|
---|
| 187 |
|
---|
[2107] | 188 | /**
|
---|
| 189 | * Returns the current setting for the maximum number of documents that
|
---|
| 190 | * may be found by a query. Default is 200.
|
---|
| 191 | * @return The maximum number of documents to be found
|
---|
| 192 | */
|
---|
| 193 | public int getMaxDocs() {
|
---|
| 194 | return ((Integer) m_Options.get("Maxdocs")).intValue();
|
---|
| 195 | }
|
---|
| 196 |
|
---|
| 197 | /**
|
---|
| 198 | * Returns the start number of the result set. The result set is a subset of
|
---|
| 199 | * the maximum number of documents that could be found by the query.
|
---|
| 200 | * Default is 1.
|
---|
| 201 | * @return The number of the first document relative to the documents that
|
---|
| 202 | * were found to match the query
|
---|
| 203 | */
|
---|
[2055] | 204 | public int getStartResults() {
|
---|
| 205 | return ((Integer) m_Options.get("StartResults")).intValue();
|
---|
| 206 | }
|
---|
| 207 |
|
---|
[2107] | 208 | /**
|
---|
| 209 | * Returns the end number of the result set. The result set is a subset of
|
---|
| 210 | * the maximum number documents that could be found by the query.
|
---|
| 211 | * Default is 10.
|
---|
| 212 | * @return The number of the last document relative to the documents that
|
---|
| 213 | * were found to match the query.
|
---|
| 214 | */
|
---|
[2055] | 215 | public int getEndResults() {
|
---|
| 216 | return ((Integer) m_Options.get("EndResults")).intValue();
|
---|
| 217 | }
|
---|
| 218 |
|
---|
[2107] | 219 | /**
|
---|
| 220 | * Returns the set of query terms.
|
---|
| 221 | * @return This set: "EndResults", "QueryType", "Term", "MaxDocs",
|
---|
| 222 | * "StartResults", "Stem", "CaseFold"
|
---|
| 223 | */
|
---|
[2055] | 224 | public Set queryKeySet() {
|
---|
| 225 | return m_Options.keySet();
|
---|
| 226 | }
|
---|
| 227 |
|
---|
[2107] | 228 | /**
|
---|
| 229 | * Returns a collection of the current query values.
|
---|
| 230 | * @return For a default query this collection: 10, "ranked", "", 200, 1
|
---|
| 231 | * , false, true
|
---|
| 232 | */
|
---|
[2055] | 233 | public Collection queryValues() {
|
---|
| 234 | return m_Options.values();
|
---|
| 235 | }
|
---|
| 236 |
|
---|
| 237 | }
|
---|
[2107] | 238 |
|
---|