IndexerIF (Ontopia)

All Known Implementing Classes:

LuceneIndexer
```
public interface IndexerIF
```
INTERNAL: Represents a search engine indexer. Instances of this class are able to index documents and generate an index which can be used for searching those documents.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`close()`	INTERNAL: Closes the indexer.
`void`	`delete()`	INTERNAL: Deletes the index.
`void`	`delete(String field, String value)`	INTERNAL: Removes all documents with the specified field value from the index.
`void`	`flush()`	INTERNAL: Flushes all changes done to the index.
`void`	`index(DocumentIF document)`	INTERNAL: Indexes the specified document.

- Method Detail
  - index
```
void index(DocumentIF document)
    throws IOException
```
    INTERNAL: Indexes the specified document. This includes tokenizing, indexing and storing the document fields.
    
    Throws:
    
    IOException
  - delete
```
void delete(String field,
            String value)
     throws IOException
```
    INTERNAL: Removes all documents with the specified field value from the index. This method should generally be, but is not limited to, used to delete documents by their identity field.
    
    Throws:
    
    IOException
  - flush
```
void flush()
    throws IOException
```
    INTERNAL: Flushes all changes done to the index. A flushing operation can include actions like persisting changes and optimizing the index.
    
    Throws:
    
    IOException
  - delete
```
void delete()
     throws IOException
```
    INTERNAL: Deletes the index. The indexer is closed after this method returns. Note that some indexers might not support this operation.
    
    Throws:
    
    IOException
    
    Since:
    
    1.3
  - close
```
void close()
    throws IOException
```
    INTERNAL: Closes the indexer. After the indexer has been closed it cannot (generally) be reopened.
    
    Throws:
    
    IOException