KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > raptus > owxv3 > modules > searcher > SearchResultObject


1 /*
2  * eAdmin/OWX
3  * Copyright (C) 1996-2003 OWX-Project Team <owx-team@gmx.net>
4  */

5
6 package com.raptus.owxv3.modules.searcher;
7
8
9 import com.raptus.owxv3.api.*;
10
11 import java.util.Locale JavaDoc;
12 import java.util.Vector JavaDoc;
13 /**
14  * Contains
15  *
16  * <hr>
17  * <table width="100%" border="0">
18  * <tr>
19  * <td width="24%"><b>Filename</b></td><td width="76%">SearchResultObject.java</td>
20  * </tr>
21  * <tr>
22  * <td width="24%"><b>Author</b></td><td width="76%">REEA</td>
23  * </tr>
24  * <tr>
25  * <td width="24%"><b>Date</b></td><td width="76%">12th of October 2001</td>
26  * </tr>
27  * </table>
28  * <hr>
29  * <table width="100%" border="0">
30  * <tr>
31  * <td width="24%"><b>Date / Author</b></td><td width="76%"><b>Changes</b></td>
32  * </tr>
33  * <tr>
34  * <td colspan="2"> This class respresents a SearchResult Object. It implements the SearchResult interface.</td>
35  * </tr>
36  * </table>
37  * <hr>
38  */

39 public class SearchResultObject implements SearchResult
40 {
41     /**
42      *Path to jsp viewer that will render this search result
43      */

44     protected String JavaDoc viewer=null;
45
46     /**
47      *The key of the represented object (should be a unique id ex. from database)
48      */

49     protected int key=0;
50
51     
52
53     /**
54      *The URL wich should be placed to reach the Object described by this Search Result Object.
55      */

56
57     protected String JavaDoc url=null;
58
59     /**
60      *A Search ResultObject is Locale dependent.
61      */

62     protected Locale JavaDoc locale=null;
63
64     /**
65      *A Search ResultObject belongs to a vmodule
66      */

67     protected String JavaDoc vmodule=null;
68     
69     /**
70      *
71      */

72     protected boolean loadFiles=false;
73     /**
74      *
75      */

76     protected boolean loadPictures=false;
77     
78     /**
79      *
80      */

81     protected boolean loadURLs=false;
82
83
84     public void setViewer(String JavaDoc v) { viewer=v; }
85     public String JavaDoc getViewer() { return viewer; }
86
87     public void setLocale(Locale JavaDoc l) { locale=l; }
88     public Locale JavaDoc getLocale() { return locale; }
89
90     public void setVModule(String JavaDoc vmid) { vmodule=vmid; }
91     public String JavaDoc getVModule() { return vmodule; }
92
93     public void setKey(int k) { key=k; }
94
95     public void setURL(String JavaDoc u) {url=u; }
96
97     public void setLoadFiles(boolean b)
98     {
99         loadFiles=b;
100     }
101     public boolean getLoadFiles()
102     {
103         return loadFiles;
104     }
105     
106     public void setLoadPictures(boolean b)
107     {
108         loadPictures=b;
109     }
110     
111     public boolean getLoadPictures()
112     {
113         return loadPictures;
114     }
115
116     public void setLoadURLs(boolean b)
117     {
118         loadURLs=b;
119     }
120
121     public boolean getLoadURLs()
122     {
123         return loadURLs;
124     }
125
126
127 /**
128  *Methods from interface SearchResult
129  */

130
131     public int getKey() { return key; }
132
133     public String JavaDoc getURL()
134     {
135         if(key!=0)
136         {
137             /**
138              *An url may contain the the word $key this will be replaced by the actual key of this Object
139              */

140             int i=url.indexOf(SearchConstants.KEY_IDENTIFIER);
141             if(i==-1) return url;
142             String JavaDoc s=url.substring(0,i);
143             return s+Integer.toString(key)+url.substring(i+SearchConstants.KEY_IDENTIFIER.length());
144         }
145         return url;
146     }
147
148     /**
149      *Method should be overwritten by superClasses
150      */

151     public String JavaDoc getField(String JavaDoc fieldname)
152     {
153         return "";
154     }
155     
156     /**
157      *Method should be overwritten by superClasses
158      *@return Vector of GResTitledFile objects
159      */

160     public Vector JavaDoc getFiles()
161     {
162         return null;
163     }
164     
165     /**
166      *Method should be overwritten by superClasses
167      *@return Vector of GResTitledFile objects
168      */

169     public Vector JavaDoc getPictures()
170     {
171         return null;
172     }
173     
174     /**
175      *Method should be overwritten by superClasses
176      *@return Vector of GResTitledURL objects
177      */

178     
179     public Vector JavaDoc getLinks()
180     {
181         return null;
182     }
183     
184 }
185
Popular Tags