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 Indexer


public interface Indexer

The indexer is responsible for indexing a document. It bridges between an index engine and indexable documents.

A search engine should implement this interface with its internal index mechanism.


Method Summary
 void close(SearchContext searchContext)
          Closes the indexer.
 void createIndex(SearchContext searchContext)
          Creates an index store.
 void deleteIndex(SearchContext searchContext)
          Deletes the index store permanently
 void indexDocument(SearchContext searchContext, IndexableDocument document)
          Indexs a document.
 void setSearchableObject(SearchableObject searchableObject)
          Sets Searchable Object for this indexer
 

Method Detail

indexDocument

void indexDocument(SearchContext searchContext,
                   IndexableDocument document)
                   throws IndexingException
Indexs a document.

Parameters:
searchContext - crawl time context.
document - to be indexed.
Throws:
IndexingException

setSearchableObject

void setSearchableObject(SearchableObject searchableObject)
                         throws IndexingException
Sets Searchable Object for this indexer

Parameters:
searchableObject -
Throws:
IndexingException

close

void close(SearchContext searchContext)
           throws IndexingException
Closes the indexer. Clean up call after indexing.

Throws:
IndexingException

createIndex

void createIndex(SearchContext searchContext)
                 throws IndexingException
Creates an index store.

Throws:
IndexingException

deleteIndex

void deleteIndex(SearchContext searchContext)
Deletes the index store permanently

Parameters:
searchContext -

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.