Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.2)

E21908-02

oracle.ecsf
Interface Crawler


public interface Crawler

A crawler is repsonsible for creating crawlables from an accessible URL.

Once it retrieves a document, it passes the document to the indexer. In most cases, a crawlable document would contain a list of URLs that forms a crawlable topology. Each crawler is responsible for retrieve one document at a time. The URLs are handed to other crawlers to repeat this crawling process. So the topology is not crawled by one crawler, but a bunch of them.

The crawling process will stop once all URLs are crawled.

In AppSearch, an implemenation of this interface will be basically a wrap on top of search engine crawling functionality.


Method Summary
 void indexDocuments(SearchContext ctx, Indexer indexer)
          Indexes crawled documents with a provided indexer.
 void setSearchableObject(SearchableObject searchableObject)
          Sets searchable object to crawl.
 void start(SearchContext ctx, boolean incremental)
          Starts the crawler.
 

Method Detail

start

void start(SearchContext ctx,
           boolean incremental)
Starts the crawler.

Parameters:
ctx - the runtime context.
incremental - indicates whether this is a incremental crawl request or not.

setSearchableObject

void setSearchableObject(SearchableObject searchableObject)
Sets searchable object to crawl.

Parameters:
searchableObject -

indexDocuments

void indexDocuments(SearchContext ctx,
                    Indexer indexer)
Indexes crawled documents with a provided indexer. This allows the crawler pluggin different indexer.

Parameters:
ctx - the calling context.
indexer - the implemenation used for indexing documents.

Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.2)

E21908-02

Copyright © 2011 Oracle. All rights reserved.