- Timestamp:
- 02/25/13 20:04:38 (11 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
SRUServer/trunk/src/main/java/eu/clarin/sru/server/SRURequest.java
r2246 r2623 1 1 /** 2 * This software is copyright (c) 2011 by2 * This software is copyright (c) 2011-2013 by 3 3 * - Institut fuer Deutsche Sprache (http://www.ids-mannheim.de) 4 4 * This is free software. You can redistribute it … … 32 32 * Get the <em>operation</em> parameter of this request. Available for 33 33 * <em>explain</em>, <em>searchRetrieve</em> and <em>scan</em> requests. 34 * 34 * 35 35 * @return the operation 36 36 * @see SRUOperation … … 42 42 * Get the <em>version</em> parameter of this request. Available for 43 43 * <em>explain</em>, <em>searchRetrieve</em> and <em>scan</em> requests. 44 * 44 * 45 45 * @return the version 46 46 * @see SRUVersion … … 51 51 /** 52 52 * Check if this request is of a specific version. 53 * 53 * 54 54 * @param version 55 55 * the version to check … … 65 65 * Check if version of this request is at least <em>min</em> and at most 66 66 * <em>max</em>. 67 * 67 * 68 68 * @param min 69 69 * the minimum version … … 83 83 * Get the <em>recordPacking</em> parameter of this request. Only available 84 84 * for <em>explain</em> and <em>searchRetrieve</em> requests. 85 * 85 * 86 86 * @return the record packing method 87 87 * @see SRURecordPacking … … 93 93 * Get the <em>query</em> parameter of this request. Only available for 94 94 * <em>searchRetrieve</em> requests. 95 * 95 * 96 96 * @return the parsed query or <code>null</code> if not a 97 97 * <em>searchRetrieve</em> request … … 103 103 * Get the <em>startRecord</em> parameter of this request. Only available 104 104 * for <em>searchRetrieve</em> requests. 105 * 105 * 106 106 * @return the number of the start record or <code>-1</code> if no value was 107 107 * supplied for this request … … 114 114 * for <em>searchRetrieve</em> requests. If no value was supplied with the 115 115 * request, the server will automatically set a default value. 116 * 116 * 117 117 * @return the maximum number of records 118 118 */ … … 123 123 * Get the <em>recordSchema</em> parameter of this request. Only available 124 124 * for <em>searchRetrieve</em> requests. 125 * 125 * 126 126 * @return the record schema name or <code>null</code> if no value was 127 127 * supplied for this request … … 135 135 * parameter of this request. Only available for <em>searchRetrieve</em> 136 136 * requests. 137 * 137 * 138 138 * @return the record schema identifier or <code>null</code> if no 139 139 * <em>recordSchema</em> parameter was supplied for this request … … 146 146 * Get the <em>recordXPath</em> parameter of this request. Only available 147 147 * for <em>searchRetrieve</em> requests and version 1.1 requests. 148 * 148 * 149 149 * @return the record XPath or <code>null</code> of no value was supplied 150 150 * for this request … … 156 156 * Get the <em>resultSetTTL</em> parameter of this request. Only available 157 157 * for <em>searchRetrieve</em> requests. 158 * 158 * 159 159 * @return the result set TTL or <code>-1</code> if no value was supplied 160 160 * for this request … … 166 166 * Get the <em>sortKeys</em> parameter of this request. Only available for 167 167 * <em>searchRetrieve</em> requests and version 1.1 requests. 168 * 168 * 169 169 * @return the record XPath or <code>null</code> of no value was supplied 170 170 * for this request … … 176 176 * Get the <em>scanClause</em> parameter of this request. Only available for 177 177 * <em>scan</em> requests. 178 * 178 * 179 179 * @return the parsed scan clause or <code>null</code> if not a 180 180 * <em>scan</em> request … … 186 186 * Get the <em>responsePosition</em> parameter of this request. Only 187 187 * available for <em>scan</em> requests. 188 * 188 * 189 189 * @return the response position or <code>-1</code> if no value was supplied 190 190 * for this request … … 196 196 * Get the <em>maximumTerms</em> parameter of this request. Available for 197 197 * any type of request. 198 * 198 * 199 199 * @return the maximum number of terms or <code>-1</code> if no value was 200 200 * supplied for this request … … 206 206 * Get the <em>stylesheet</em> parameter of this request. Available for 207 207 * <em>explain</em>, <em>searchRetrieve</em> and <em>scan</em> requests. 208 * 208 * 209 209 * @return the stylesheet or <code>null</code> if no value was supplied for 210 210 * this request … … 216 216 * Get the protocol schema which was used of this request. Available for 217 217 * <em>explain</em>, <em>searchRetrieve</em> and <em>scan</em> requests. 218 * 218 * 219 219 * @return the protocol scheme 220 220 */ … … 225 225 * Get the names of extra parameters of this request. Available for 226 226 * <em>explain</em>, <em>searchRetrieve</em> and <em>scan</em> requests. 227 * 227 * 228 228 * @return a possibly empty list of parameter names 229 229 */ … … 234 234 * Get the value of an extra parameter of this request. Available for 235 235 * <em>explain</em>, <em>searchRetrieve</em> and <em>scan</em> requests. 236 * 236 * 237 237 * @param name 238 238 * name of the extra parameter. Must be prefixed with … … 250 250 /** 251 251 * Get the raw client request information from the servlet container. 252 * 252 * 253 253 * @return the servlet request 254 254 */
Note: See TracChangeset
for help on using the changeset viewer.