websphinx
Class CrawlEvent

java.lang.Object
  |
  +--websphinx.CrawlEvent

public class CrawlEvent

extends java.lang.Object

Crawling event. CrawlEvents are broadcast when the crawler starts, stops, or clears its state.

Field Summary

static int	CLEARED Crawler's state was cleared.
static int	PAUSED Crawler was paused.
static int	STARTED Crawler started.
static int	STOPPED Crawler ran out of links to crawl
static int	TIMED_OUT Crawler timeout expired.

Constructor Summary

CrawlEvent(websphinx.Crawler crawler, int id)
Make a CrawlEvent.

Method Summary

websphinx.Crawler	getCrawler() Get crawler that generated the event
int	getID() Get event id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STARTED

public static final int STARTED

Crawler started.

See Also:

Constant Field Values

STOPPED

public static final int STOPPED

Crawler ran out of links to crawl

See Also:

Constant Field Values

CLEARED

public static final int CLEARED

Crawler's state was cleared.

See Also:

Constant Field Values

TIMED_OUT

public static final int TIMED_OUT

Crawler timeout expired.

See Also:

Constant Field Values

PAUSED

public static final int PAUSED

Crawler was paused.

See Also:

Constant Field Values

Constructor Detail

CrawlEvent

public CrawlEvent(websphinx.Crawler crawler,
                  int id)

Make a CrawlEvent.

Parameters:

crawler - Crawler that generated this event

id - event id (one of STARTED, STOPPED, etc.)

Method Detail

getCrawler

public websphinx.Crawler getCrawler()

Get crawler that generated the event

Returns:

crawler

getID

public int getID()

Get event id.

Returns:

one of STARTED, STOPPED, CLEARED, TIMED_OUT, or PAUSED.