org.eclipse.smila.connectivity.framework
Interface Crawler

All Known Subinterfaces:

CompoundCrawler

All Known Implementing Classes:

AbstractCompoundCrawler, AbstractCrawler, FileSystemCrawler, JdbcCrawler, WebCrawler, ZipCompoundCrawler

public interface Crawler

The Interface Crawler.

Method Summary

void	close() Ends crawl, allowing the Crawler implementation to close any open resources.
CrawlerPerformanceCounterHelper<? extends ConnectivityPerformanceAgent>	getCounterHelper()
java.lang.String	getCrawlerId() Returns the ID of this Crawler.
DataReference[]	getNext() Returns an array of DataReference objects.
void	initialize(DataSourceConnectionConfig config) Initialize.

Method Detail

getCrawlerId

java.lang.String getCrawlerId()
                              throws CrawlerException

Returns the ID of this Crawler.

Returns:

a String containing the ID of this Crawler

Throws:

CrawlerException - if any error occurs

getNext

DataReference[] getNext()
                        throws CrawlerException,
                               CrawlerCriticalException

Returns an array of DataReference objects. The size of the returned array may vary from call to call. The maximum size of the array is determined by configuration or by the implementation class.

Returns:

an array of DataReference objects or null, if no more DataReference exist

Throws:

CrawlerException - if any error occurs

CrawlerCriticalException - the crawler critical exception

initialize

void initialize(DataSourceConnectionConfig config)
                throws CrawlerException,
                       CrawlerCriticalException

Initialize.

Parameters:

config - the DataSourceConnectionConfig

Throws:

CrawlerException - the crawler exception

CrawlerCriticalException - the crawler critical exception

close

void close()
           throws CrawlerException

Ends crawl, allowing the Crawler implementation to close any open resources.

Throws:

CrawlerException - if any error occurs

getCounterHelper

CrawlerPerformanceCounterHelper<? extends ConnectivityPerformanceAgent> getCounterHelper()

Returns:

helper for crawler counters.