oracle.ecsf
Interface SearchEngine

public interface SearchEngine

Abstraction for a search engine. All the search engine plug-in must implment this interface. The implemenation serves as a factory or container for search related entities such as indexer, searcher, and crawler.

Each searchable object can be associated with particular search engine. This allows multiple search engines to be used in AppSearch.

Method Summary

IndexableDocument	createIndexableDocument(SearchableObject searchableObject) Creates a new indexable document instance.
Administrator	getAdministrator(SearchContext ctx) Retruns admin class for admin API
Crawler	getCrawler(SearchContext ctx) Returns a crawler implemenation
java.lang.String	getDescription(SearchContext ctx) Returns human readable description for this search engine
Indexer	getIndexer(SearchContext ctx) Returns an indexer implemenation
Searcher	getSearcher(SearchContext ctx) Returns a searcher that can be used to query into its index store.

Method Detail

getDescription

java.lang.String getDescription(SearchContext ctx)

Returns human readable description for this search engine

Parameters:

ctx - runtime context.

Returns:

a desicrtion for this search engine.

getSearcher

Searcher getSearcher(SearchContext ctx)

Returns a searcher that can be used to query into its index store.

Returns:

Searcher an implementation for this search engine.

getCrawler

Crawler getCrawler(SearchContext ctx)

Returns a crawler implemenation

Parameters:

ctx - runtime context for a crawl job

Returns:

Crawler an implementation of this search engine.

getIndexer

Indexer getIndexer(SearchContext ctx)

Returns an indexer implemenation

Parameters:

ctx - runtime context for a crawl job

Returns:

Indexer an implementation of this search engine.

getAdministrator

Administrator getAdministrator(SearchContext ctx)

Retruns admin class for admin API

Parameters:

ctx - runtime context for a crawl job

Returns:

Admin object.

createIndexableDocument

IndexableDocument createIndexableDocument(SearchableObject searchableObject)

Creates a new indexable document instance.

Parameters:

searchableObject - meta data for creating this instance.

Returns:

instance of IndexableDocument, implemented for this search engine.