KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > dspace > search > QueryResults


1 /*
2  * QueryResults.java
3  *
4  * Version: $Revision: 1.6 $
5  *
6  * Date: $Date: 2005/04/20 14:23:22 $
7  *
8  * Copyright (c) 2002-2005, Hewlett-Packard Company and Massachusetts
9  * Institute of Technology. All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions are
13  * met:
14  *
15  * - Redistributions of source code must retain the above copyright
16  * notice, this list of conditions and the following disclaimer.
17  *
18  * - Redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution.
21  *
22  * - Neither the name of the Hewlett-Packard Company nor the name of the
23  * Massachusetts Institute of Technology nor the names of their
24  * contributors may be used to endorse or promote products derived from
25  * this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
32  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
33  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
34  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
35  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
36  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
37  * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
38  * DAMAGE.
39  */
40 package org.dspace.search;
41
42 import java.util.List JavaDoc;
43
44 /**
45  * Contains the results of a query. Use access methods to examine and retrieve
46  * the results.
47  */
48 public class QueryResults
49 {
50     private int hitCount; // total hits returned by search engine
51
52     private int start; // offset of query 'page'
53
54     private int pageSize; // max number of hits returned
55
56     private List JavaDoc hitHandles; // handles of content (items, collections,
57 // communities)
58
59     private List JavaDoc hitTypes; // Integers from Constants defng types of
60 // corresponding handles
61
62     private String JavaDoc errorMsg; //error string, if there is one
63
64     /** set total number of hits found by search engine, not number in hitHandles */
65     public void setHitCount(int newCount)
66     {
67         hitCount = newCount;
68     }
69
70     /**
71      * get total number of hits found by search engine, not just number of
72      * returned results
73      */
74     public int getHitCount()
75     {
76         return hitCount;
77     }
78
79     /** set start of 'page' of results */
80     public void setStart(int newStart)
81     {
82         start = newStart;
83     }
84
85     /** get start of 'page' of results */
86     public int getStart()
87     {
88         return start;
89     }
90
91     /** set length of 'page' of results */
92     public void setPageSize(int newSize)
93     {
94         pageSize = newSize;
95     }
96
97     /** get length of 'page' of results */
98     public int getPageSize()
99     {
100         return pageSize;
101     }
102
103     /** set the List of handles corresponding to hits */
104     public void setHitHandles(List JavaDoc myHits)
105     {
106         hitHandles = myHits;
107     }
108
109     /** get the List of handles corresponding to hits */
110     public List JavaDoc getHitHandles()
111     {
112         return hitHandles;
113     }
114
115     /** set the List of types corresponding to handles */
116     public void setHitTypes(List JavaDoc newTypes)
117     {
118         hitTypes = newTypes;
119     }
120
121     /** get the List of types corresponding to handles */
122     public List JavaDoc getHitTypes()
123     {
124         return hitTypes;
125     }
126
127     /** set error message */
128     public void setErrorMsg(String JavaDoc msg)
129     {
130         errorMsg = msg;
131     }
132
133     /** get error message */
134     public String JavaDoc getErrorMsg()
135     {
136         return errorMsg;
137     }
138 }
139
Popular Tags