com.sapportals.wcm.service.crawler
Class AbstractListResultReceiver

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

java.lang.Object
  |
  +--com.sapportals.wcm.service.crawler.AbstractListResultReceiver

All Implemented Interfaces:

ICrawlerListResultReceiver, ICrawlerResultReceiver

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

public abstract class AbstractListResultReceiver

extends java.lang.Object

implements ICrawlerListResultReceiver

A base class for implementing list result receivers.

Copyright 2004 SAP AG

Field Summary

protected ICrawler

m_Crawler Deprecated. The crawler for this result receiver, as passed from onCrawlStart().

Fields inherited from interface com.sapportals.wcm.service.crawler.ICrawlerListResultReceiver

INFINITE_SIZE

Constructor Summary

AbstractListResultReceiver()
Deprecated. Construct.
The default constructor has to be provided for scheduled crawlers.

Method Summary

abstract IResourceContext	getCrawlerContext() Deprecated. Called by the crawler to get a context to use for accessing the resources during the crawl.
abstract java.lang.String	getCrawlerName(java.util.Locale locale) Deprecated. Called to get an descriptive name for the crawler.
int	getCrawlerResultSize() Deprecated. Get the maximum result size for this crawl.
WcmException	onCrawlException(java.lang.Exception exception, IResource resource) Deprecated. Called by the crawler when an exception occured during the crawl.
abstract void	onCrawlResult(IResourceList resourceList) Deprecated. Inform the receiver about the crawling result.
boolean	onCrawlStart(ICrawler crawler) Deprecated. Called by the crawler to signal the start of a crawl.
boolean	onCrawlStop() Deprecated. Called by the crawler to signal the end of a crawl.

Methods inherited from class java.lang.Object

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

Field Detail

m_Crawler

protected ICrawler m_Crawler

Deprecated.

The crawler for this result receiver, as passed from onCrawlStart().

Constructor Detail

AbstractListResultReceiver

public AbstractListResultReceiver()

Deprecated.

Construct.
The default constructor has to be provided for scheduled crawlers.

Method Detail

onCrawlResult

public abstract void onCrawlResult(IResourceList resourceList)

Deprecated.

Inform the receiver about the crawling result. This method is called before onCrawlStop().

Specified by:

onCrawlResult in interface ICrawlerListResultReceiver

Parameters:

an - IResourceList with the found resources. The list contains at most x resources, where x is the value from getCrawlerResultSize().

getCrawlerName

public abstract java.lang.String getCrawlerName(java.util.Locale locale)

Deprecated.

Called to get an descriptive name for the crawler.

Specified by:

getCrawlerName in interface ICrawlerResultReceiver

Returns:

a String with the crawlers name.

getCrawlerContext

public abstract IResourceContext getCrawlerContext()

Deprecated.

Called by the crawler to get a context to use for accessing the resources during the crawl. This is the first call to the result receiver.

Specified by:

getCrawlerContext in interface ICrawlerResultReceiver

Returns:

a IResourceContext with the context to use or null if the context cannot be retrieved. A null will stop the crawler!

onCrawlException

public WcmException onCrawlException(java.lang.Exception exception,
                                     IResource resource)

Deprecated.

Called by the crawler when an exception occured during the crawl. This method can be callend any time between onCrawlStart and onCrawlStop.
The default implementation ignores any exceptions

Specified by:

onCrawlException in interface ICrawlerResultReceiver

Parameters:

exception - a Exception with the original exception.

resource - the IResource which caused the exception, if available, or null.

Returns:

a WcmException with the exception to throw (will stop the crawl or null if the exception should be ignored.

onCrawlStart

public boolean onCrawlStart(ICrawler crawler)

Deprecated.

Called by the crawler to signal the start of a crawl. This is the second call to the result receiver, and the first for a crawl.
The default implementation stores the crawler to this.m_Crawler.

Specified by:

onCrawlStart in interface ICrawlerResultReceiver

Parameters:

crawler - the ICrawler which performs the crawl.

Returns:

a boolean true if the crawl should be performed, false if the result receiver want's to stop this crawl.

onCrawlStop

public boolean onCrawlStop()

Deprecated.

Called by the crawler to signal the end of a crawl. This is the last call to the result receiver for a crawl.
The default implementation resets this.m_Crawler to null.

Specified by:

onCrawlStop in interface ICrawlerResultReceiver

Returns:

a boolean true if the crawled resources should be discarded, false if the delta list should be kept.

getCrawlerResultSize

public int getCrawlerResultSize()

Deprecated.

Get the maximum result size for this crawl. This method is called once after getCrawlerContext().
The default implementations collects a list with an INFINITE_SIZE.

Specified by:

getCrawlerResultSize in interface ICrawlerListResultReceiver

Returns:

an int with the maximum result size. A result size less then 1 will stop the crawler.