1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.index;
20
21 import java.util.List;
22
23 import org.apache.lucene.search.Query;
24 import org.apache.maven.index.context.IndexingContext;
25
26 /**
27 * Pageable search request. Adds "start" point, to skip wanted number of records, to implement paging. Use "count" of
28 * AbstractSearchRequest to set page size.
29 *
30 * @author cstamas
31 */
32 public class AbstractSearchPageableRequest extends AbstractSearchRequest {
33 /**
34 * The number of hit we want to skip from result set. Defaults to 0.
35 */
36 private int start;
37
38 public AbstractSearchPageableRequest(Query query) {
39 super(query, null);
40
41 this.start = 0;
42 }
43
44 public AbstractSearchPageableRequest(Query query, List<IndexingContext> contexts) {
45 super(query, contexts);
46
47 this.start = 0;
48 }
49
50 /**
51 * Returns the "start" of wanted results calculated from result set window. Simply, the count of documents to skip.
52 *
53 * @return
54 */
55 public int getStart() {
56 return start;
57 }
58
59 /**
60 * Sets the "start" of wanted results calculated from result set window. Simply, the count of documents to skip.
61 *
62 * @param start
63 */
64 public void setStart(int start) {
65 if (start < 0) {
66 throw new IllegalArgumentException("Start cannot be less than 0!");
67 }
68
69 this.start = start;
70 }
71 }