org.opencms.search
Interface I_CmsIndexWriter

All Known Implementing Classes:

CmsLuceneIndexWriter

public interface I_CmsIndexWriter

Abstracts the index writer implementation for the most important index manipulation operations.

Since:

8.0.2

Method Summary

void	close() Close this IndexWriter.
void	commit() Commit all previous operations.
void	deleteDocuments(String rootPath) Delete a document from the index.
void	optimize() Optimizes the index.
void	updateDocument(String rootPath, org.apache.lucene.document.Document document) Update a document in the index.

Method Detail

close

void close()
           throws IOException

Close this IndexWriter.

Throws:

IOException

commit

void commit()
            throws IOException

Commit all previous operations.

Throws:

IOException

deleteDocuments

void deleteDocuments(String rootPath)
                     throws IOException

Delete a document from the index.

Parameters:

rootPath - the root path of the document to delete

Throws:

IOException - in case something goes wrong

optimize

void optimize()
              throws IOException

Optimizes the index.

Throws:

IOException

updateDocument

void updateDocument(String rootPath,
                    org.apache.lucene.document.Document document)
                    throws IOException

Update a document in the index.

Parameters:

rootPath - the root path of the document to update

document - the document to update

Throws:

IOException - in case something goes wrong