com.sapportals.wcm.service.crawler
Interface ICrawlerPushedResultReceiver

[contained in: com.sap.km.cm.service.base.par - km.shared.service.crawler_api.jar]

All Superinterfaces:

ICrawlerResultReceiver

All Known Subinterfaces:

ICrawlerPushedDeltaResultReceiver

All Known Implementing Classes:

AbstractPushedResultReceiver

Deprecated. as of NW04. The crawler service was replaced by the xcrawler service com.sapportals.wcm.service.xcrawler

public interface ICrawlerPushedResultReceiver

extends ICrawlerResultReceiver

A result receiver which handles found resources one by one. Note: The receivers must implement a default constructor to have them created by the crawler service after a system (re)start.

Copyright 2004 SAP AG

Field Summary

static int	RESULT_CANCEL Deprecated. result code CANCEL to tell the crawler that crawling should be canceled.
static int	RESULT_ERROR_DELETE Deprecated. result code ERROR_DELETE to tell the crawler that crawling should continue, but the currently crawled resource should be deleted and will be crawled again next time as a new resource (for delta).
static int	RESULT_ERROR_EXCLUDE Deprecated. result code ERROR_EXCLUDE to tell the crawler that crawling should continue, but the currently crawled resource should be marked as unread and should not be crawled again next time (for delta).
static int	RESULT_ERROR_RETRY Deprecated. result code ERROR_RETRY to tell the crawler that crawling should continue, but the currently crawled resource should be marked as unread and has to be crawled again next time (for delta).
static int	RESULT_IGNORED Deprecated. result code ERROR_IGNORED to tell the crawler that crawling should continue, but the currently crawled resource was ignored this time (for delta, will be recrawled but not reported as deleted).
static int	RESULT_OK Deprecated. result code OK to tell the crawler that crawling should continue normaly.

Method Summary

boolean	onCrawlDown(IResource resource) Deprecated. Inform the receiver about the descending in the hierarchy.
int	onCrawlNext(IResource resource) Deprecated. Inform the receiver about the next visited resource inside a colleciton.
void	onCrawlUp(IResource resource) Deprecated. Inform the receiver about the ascending in the hierarchy.

Methods inherited from interface com.sapportals.wcm.service.crawler.ICrawlerResultReceiver

getCrawlerContext, getCrawlerName, onCrawlException, onCrawlStart, onCrawlStop

Field Detail

RESULT_OK

public static final int RESULT_OK

Deprecated.

result code OK to tell the crawler that crawling should continue normaly.

RESULT_ERROR_RETRY

public static final int RESULT_ERROR_RETRY

Deprecated.

result code ERROR_RETRY to tell the crawler that crawling should continue, but the currently crawled resource should be marked as unread and has to be crawled again next time (for delta).

RESULT_ERROR_EXCLUDE

public static final int RESULT_ERROR_EXCLUDE

Deprecated.

result code ERROR_EXCLUDE to tell the crawler that crawling should continue, but the currently crawled resource should be marked as unread and should not be crawled again next time (for delta).

RESULT_ERROR_DELETE

public static final int RESULT_ERROR_DELETE

Deprecated.

result code ERROR_DELETE to tell the crawler that crawling should continue, but the currently crawled resource should be deleted and will be crawled again next time as a new resource (for delta).

RESULT_CANCEL

public static final int RESULT_CANCEL

Deprecated.

result code CANCEL to tell the crawler that crawling should be canceled.

RESULT_IGNORED

public static final int RESULT_IGNORED

Deprecated.

result code ERROR_IGNORED to tell the crawler that crawling should continue, but the currently crawled resource was ignored this time (for delta, will be recrawled but not reported as deleted).

Method Detail

onCrawlDown

public boolean onCrawlDown(IResource resource)
                    throws WcmException

Deprecated.

Inform the receiver about the descending in the hierarchy. This method is called between the calls to getCrawlerContext() and onCrawlStop(). Furthermore, this method is called after the onCrawlNext() for this collection.

Parameters:

an - IResource with the resource to descend into. This may be a collection (if HIERARCHICAL_ON is set as the hierarchical crawl mode) or may be a resource (if HIERARCHICAL_OFF is used).

Returns:

a boolean true if the crawler should descent in the hierarchy, false if this collection's hierarchy should not be crawled.

onCrawlUp

public void onCrawlUp(IResource resource)
               throws WcmException

Deprecated.

Inform the receiver about the ascending in the hierarchy. This method is called between the calls to getCrawlerContext() and onCrawlStop(). Furthermore, this method is called at last after the onCrawlNext() for this collection.

Parameters:

an - IResource with the resource to ascend from. This may be a collection (if HIERARCHICAL_ON is set as the hierarchical crawl mode) or may be a resource (if HIERARCHICAL_OFF is used).

onCrawlNext

public int onCrawlNext(IResource resource)
                throws WcmException

Deprecated.

Inform the receiver about the next visited resource inside a colleciton. This method is called between the calls to getCrawlerContext() and onCrawlStop().

Parameters:

a - IResource with the visited resource.

Returns:

an int with a result code (see RESULT_...).