KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > mckoi > util > SearchResults


1 /**
2  * com.mckoi.util.SearchResults 29 Mar 1998
3  *
4  * Mckoi SQL Database ( http://www.mckoi.com/database )
5  * Copyright (C) 2000, 2001, 2002 Diehl and Associates, Inc.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * Version 2 as published by the Free Software Foundation.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License Version 2 for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * Version 2 along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19  *
20  * Change Log:
21  *
22  *
23  */
24
25 package com.mckoi.util;
26
27 /**
28  * This object stores the result of a given search. It provides information
29  * object where in the set the found elements are, and the number of elements
30  * in the set that match the search criteria.
31  * <p>
32  * @author Tobias Downer
33  */
34
35 public final class SearchResults {
36
37   /**
38    * The index in the array of the found elements.
39    */
40   int found_index;
41
42   /**
43    * The number of elements in the array that match the given search criteria.
44    */
45   int found_count;
46
47   /**
48    * The Constructor.
49    */
50   public SearchResults() {
51   }
52
53   /**
54    * Functions for querying information in the results.
55    */
56   public int getCount() {
57     return found_count;
58   }
59
60   public int getIndex() {
61     return found_index;
62   }
63
64 }
65
Popular Tags