01: /*
02: * WebSphinx web-crawling toolkit
03: *
04: * Copyright (c) 1998-2002 Carnegie Mellon University. All rights
05: * reserved.
06: *
07: * Redistribution and use in source and binary forms, with or without
08: * modification, are permitted provided that the following conditions
09: * are met:
10: *
11: * 1. Redistributions of source code must retain the above copyright
12: * notice, this list of conditions and the following disclaimer.
13: *
14: * 2. Redistributions in binary form must reproduce the above copyright
15: * notice, this list of conditions and the following disclaimer in
16: * the documentation and/or other materials provided with the
17: * distribution.
18: *
19: * THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND
20: * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21: * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY
23: * NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30: *
31: */
32:
33: package websphinx;
34:
35: /**
36: * Crawling event. CrawlEvents are broadcast when the
37: * crawler starts, stops, or clears its state.
38: */
39: public class CrawlEvent {
40: private Crawler crawler;
41: private int id;
42:
43: /**
44: * Crawler started.
45: */
46: public static final int STARTED = 0;
47:
48: /**
49: * Crawler ran out of links to crawl
50: */
51: public static final int STOPPED = 1;
52:
53: /**
54: * Crawler's state was cleared.
55: */
56: public static final int CLEARED = 2;
57:
58: /**
59: * Crawler timeout expired.
60: */
61: public static final int TIMED_OUT = 3;
62:
63: /**
64: * Crawler was paused.
65: */
66: public static final int PAUSED = 4;
67:
68: /**
69: * Make a CrawlEvent.
70: * @param crawler Crawler that generated this event
71: * @param id event id (one of STARTED, STOPPED, etc.)
72: */
73: public CrawlEvent(Crawler crawler, int id) {
74: this .crawler = crawler;
75: this .id = id;
76: }
77:
78: /**
79: * Get crawler that generated the event
80: * @return crawler
81: */
82: public Crawler getCrawler() {
83: return crawler;
84: }
85:
86: /**
87: * Get event id.
88: * @return one of STARTED, STOPPED, CLEARED, TIMED_OUT,
89: * or PAUSED.
90: */
91: public int getID() {
92: return id;
93: }
94:
95: }
|