KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > contineo > documan > Document


1 /*
2  * Document.java
3  *
4  * Created on 16. August 2003, 22:36
5  */
6
7 package org.contineo.documan;
8
9 import java.util.ArrayList JavaDoc;
10 import java.util.Collection JavaDoc;
11
12 import org.apache.ojb.broker.util.collections.RemovalAwareCollection;
13 import org.contineo.admin.Menu;
14 /**
15  * This class represents documents.
16  * @author Michael Scholz
17  * @version 1.0
18  */
19 public class Document {
20     
21     public static final int DOC_CHECKED_IN = 0;
22     public static final int DOC_CHECKED_OUT = 1;
23
24     /**
25      * @uml.property name="docId"
26      */
27     private int docId;
28
29     /**
30      * @uml.property name="docName"
31      */
32     private String JavaDoc docName;
33
34     /**
35      * @uml.property name="docVersion"
36      */
37     private String JavaDoc docVersion;
38
39     /**
40      * @uml.property name="docDate"
41      */
42     private String JavaDoc docDate;
43
44     /**
45      * @uml.property name="docPublisher"
46      */
47     private String JavaDoc docPublisher;
48
49     /**
50      * Whether document is checked in or out;
51      * @see Document#DOC_CHECKED_IN
52      * @see Document#DOC_CHECKED_OUT
53      * @uml.property name="docStatus"
54      */
55     private int docStatus;
56
57     /**
58      * @uml.property name="menuId"
59      */
60     private int menuId;
61
62     /**
63      * @uml.property name="docType"
64      */
65     private String JavaDoc docType;
66
67     /**
68      * @uml.property name="checkoutUser"
69      */
70     private String JavaDoc checkoutUser;
71
72     /**
73      * @uml.property name="source"
74      */
75     private String JavaDoc source;
76
77     /**
78      * @uml.property name="sourceAuthor"
79      */
80     private String JavaDoc sourceAuthor;
81
82     /**
83      * @uml.property name="sourceDate"
84      */
85     private String JavaDoc sourceDate;
86
87     /**
88      * @uml.property name="sourceType"
89      */
90     private String JavaDoc sourceType;
91
92     /**
93      * @uml.property name="coverage"
94      */
95     private String JavaDoc coverage;
96
97     /**
98      * @uml.property name="language"
99      */
100     private String JavaDoc language;
101
102
103     /**
104      * @uml.property name="keywords"
105      * @uml.associationEnd
106      */
107     private RemovalAwareCollection keywords;
108
109     /**
110      * @uml.property name="versions"
111      * @uml.associationEnd
112      */
113     private Collection JavaDoc<Version> versions;
114
115     /**
116      *
117      * @uml.property name="menu"
118      * @uml.associationEnd
119      * @uml.property name="menu" multiplicity="(1 1)"
120      */
121     private Menu menu;
122
123     
124     /** Creates a new instance of Document */
125     public Document() {
126         docId = 0;
127         docName = "";
128         docVersion = "";
129         docDate = "";
130         docPublisher = "";
131         docStatus = DOC_CHECKED_IN;
132         menuId = 0;
133         docType = "";
134         checkoutUser = "";
135         source = "";
136         sourceAuthor = "";
137         sourceDate = "";
138         sourceType = "";
139         coverage = "";
140         language = "";
141         keywords = new RemovalAwareCollection();
142         versions = new ArrayList JavaDoc<Version>();
143         menu = new Menu();
144     }
145
146     /**
147      *
148      * @uml.property name="docId"
149      */
150     public int getDocId() {
151         return docId;
152     }
153
154     /**
155      *
156      * @uml.property name="docName"
157      */
158     public String JavaDoc getDocName() {
159         return docName;
160     }
161
162     /**
163      *
164      * @uml.property name="docVersion"
165      */
166     public String JavaDoc getDocVersion() {
167         return docVersion;
168     }
169
170     /**
171      *
172      * @uml.property name="docDate"
173      */
174     public String JavaDoc getDocDate() {
175         return docDate;
176     }
177
178     /**
179      *
180      * @uml.property name="docPublisher"
181      */
182     public String JavaDoc getDocPublisher() {
183         return docPublisher;
184     }
185
186     /**
187      * @see Document#docStatus
188      * @uml.property name="docStatus"
189      */
190     public int getDocStatus() {
191         return docStatus;
192     }
193
194     /**
195      *
196      * @uml.property name="menuId"
197      */
198     public int getMenuId() {
199         return menuId;
200     }
201
202     /**
203      *
204      * @uml.property name="docType"
205      */
206     public String JavaDoc getDocType() {
207         return docType;
208     }
209
210     /**
211      *
212      * @uml.property name="checkoutUser"
213      */
214     public String JavaDoc getCheckoutUser() {
215         return checkoutUser;
216     }
217
218     /**
219      *
220      * @uml.property name="source"
221      */
222     public String JavaDoc getSource() {
223         return source;
224     }
225
226     /**
227      *
228      * @uml.property name="sourceAuthor"
229      */
230     public String JavaDoc getSourceAuthor() {
231         return sourceAuthor;
232     }
233
234     /**
235      *
236      * @uml.property name="sourceDate"
237      */
238     public String JavaDoc getSourceDate() {
239         return sourceDate;
240     }
241
242     /**
243      *
244      * @uml.property name="sourceType"
245      */
246     public String JavaDoc getSourceType() {
247         return sourceType;
248     }
249
250     /**
251      *
252      * @uml.property name="coverage"
253      */
254     public String JavaDoc getCoverage() {
255         return coverage;
256     }
257
258     /**
259      *
260      * @uml.property name="language"
261      */
262     public String JavaDoc getLanguage() {
263         return language;
264     }
265
266
267     /**
268      *
269      * @uml.property name="keywords"
270      */
271     public Collection JavaDoc getKeywords() {
272         return keywords;
273     }
274
275     /**
276      *
277      * @uml.property name="versions"
278      */
279     public Collection JavaDoc<Version> getVersions() {
280         return versions;
281     }
282
283     /**
284      *
285      * @uml.property name="menu"
286      */
287     public Menu getMenu() {
288         return menu;
289     }
290
291     /**
292      *
293      * @uml.property name="docId"
294      */
295     public void setDocId(int id) {
296         docId = id;
297     }
298
299     /**
300      *
301      * @uml.property name="docName"
302      */
303     public void setDocName(String JavaDoc name) {
304         docName = name;
305     }
306
307     /**
308      *
309      * @uml.property name="docVersion"
310      */
311     public void setDocVersion(String JavaDoc version) {
312         docVersion = version;
313     }
314
315     /**
316      *
317      * @uml.property name="docDate"
318      */
319     public void setDocDate(String JavaDoc date) {
320         docDate = date;
321     }
322
323     /**
324      *
325      * @uml.property name="docPublisher"
326      */
327     public void setDocPublisher(String JavaDoc publisher) {
328         docPublisher = publisher;
329     }
330
331     /**
332      * @see Document#docStatus
333      * @uml.property name="docStatus"
334      */
335     public void setDocStatus(int status) {
336         docStatus = status;
337     }
338
339     /**
340      *
341      * @uml.property name="menuId"
342      */
343     public void setMenuId(int menuid) {
344         menuId = menuid;
345     }
346
347     /**
348      *
349      * @uml.property name="docType"
350      */
351     public void setDocType(String JavaDoc type) {
352         docType = type;
353     }
354
355     /**
356      *
357      * @uml.property name="checkoutUser"
358      */
359     public void setCheckoutUser(String JavaDoc user) {
360         checkoutUser = user;
361     }
362
363     /**
364      *
365      * @uml.property name="source"
366      */
367     public void setSource(String JavaDoc src) {
368         source = src;
369     }
370
371     /**
372      *
373      * @uml.property name="sourceAuthor"
374      */
375     public void setSourceAuthor(String JavaDoc author) {
376         sourceAuthor = author;
377     }
378
379     /**
380      *
381      * @uml.property name="sourceDate"
382      */
383     public void setSourceDate(String JavaDoc date) {
384         sourceDate = date;
385     }
386
387     /**
388      *
389      * @uml.property name="sourceType"
390      */
391     public void setSourceType(String JavaDoc type) {
392         sourceType = type;
393     }
394
395     /**
396      *
397      * @uml.property name="coverage"
398      */
399     public void setCoverage(String JavaDoc cover) {
400         coverage = cover;
401     }
402
403     /**
404      *
405      * @uml.property name="language"
406      */
407     public void setLanguage(String JavaDoc lang) {
408         language = lang;
409     }
410
411     public void clearKeywords()
412     {
413         keywords.clear();
414     }
415     /**
416      *
417      * @uml.property name="keywords"
418      */
419     public void setKeywords(Collection JavaDoc words) {
420         keywords.addAll(words);
421     }
422
423     /**
424      *
425      * @uml.property name="versions"
426      */
427     public void setVersions(Collection JavaDoc<Version> vers) {
428         versions = vers;
429     }
430
431     /**
432      *
433      * @uml.property name="menu"
434      */
435     public void setMenu(Menu m) {
436         menu = m;
437     }
438
439     
440     public void addKeyword(Keywords word) {
441         keywords.add(word);
442     }
443     
444     public void addVersion(Version vers) {
445         versions.add(vers);
446     }
447 }
448
Popular Tags