Package org.opencms.search

Class CmsLuceneIndexWriter

java.lang.Object

org.opencms.search.CmsLuceneIndexWriter

All Implemented Interfaces:

I_CmsIndexWriter

public class CmsLuceneIndexWriter
extends java.lang.Object
implements I_CmsIndexWriter

Delegates indexing to a standard Lucene IndexWriter.

Since:

8.0.2

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.apache.commons.logging.Log	LOG	The log object for this class.

Constructor Summary

Constructors

Constructor	Description
CmsLuceneIndexWriter(org.apache.lucene.index.IndexWriter indexWriter)	Creates a new index writer based on the provided standard Lucene IndexWriter.
CmsLuceneIndexWriter(org.apache.lucene.index.IndexWriter indexWriter, CmsSearchIndex index)	Creates a new index writer based on the provided standard Lucene IndexWriter for the provided OpenCms search index instance.

Method Summary

Modifier and Type	Method	Description
void	close()	Close this IndexWriter.
void	commit()	Commit all previous operations.
void	deleteDocument(CmsPublishedResource resource)	Delete a document from the index.
void	optimize()	Optimizes the index.
void	updateDocument(java.lang.String rootPath, I_CmsSearchDocument document)	Update a document in the index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

The log object for this class.

Constructor Detail

CmsLuceneIndexWriter

public CmsLuceneIndexWriter(org.apache.lucene.index.IndexWriter indexWriter)

Creates a new index writer based on the provided standard Lucene IndexWriter.

Parameters:

indexWriter - the standard Lucene IndexWriter to use as delegate

CmsLuceneIndexWriter

public CmsLuceneIndexWriter(org.apache.lucene.index.IndexWriter indexWriter,
                            CmsSearchIndex index)

Creates a new index writer based on the provided standard Lucene IndexWriter for the provided OpenCms search index instance.

The OpenCms search instance is currently used only for improved logging of the index operations.

Parameters:

indexWriter - the standard Lucene IndexWriter to use as delegate

index - the OpenCms search index instance this writer to supposed to write to

Method Detail

close

public void close()
           throws java.io.IOException

Description copied from interface: I_CmsIndexWriter

Close this IndexWriter.

Specified by:

close in interface I_CmsIndexWriter

Throws:

java.io.IOException - thrown if the close action fails.

See Also:

I_CmsIndexWriter.close()

commit

public void commit()
            throws java.io.IOException

Description copied from interface: I_CmsIndexWriter

Commit all previous operations.

Specified by:

commit in interface I_CmsIndexWriter

Throws:

java.io.IOException - thrown if the commit action fails.

See Also:

I_CmsIndexWriter.commit()

deleteDocument

public void deleteDocument(CmsPublishedResource resource)
                    throws java.io.IOException

Description copied from interface: I_CmsIndexWriter

Delete a document from the index.

Specified by:

deleteDocument in interface I_CmsIndexWriter

Parameters:

resource - the resource to delete

Throws:

java.io.IOException - in case something goes wrong

See Also:

I_CmsIndexWriter.deleteDocument(org.opencms.db.CmsPublishedResource)

optimize

public void optimize()
              throws java.io.IOException

Description copied from interface: I_CmsIndexWriter

Optimizes the index.

Please note that as of Lucene 3.5, the direct use of optimize is discouraged as Lucene apparently is now able to manage the file structure so efficiently that frequent optimizations are not longer required.

Specified by:

optimize in interface I_CmsIndexWriter

Throws:

java.io.IOException - thrown if the optimization fails.

See Also:

As optimize is deprecated with Lucene 3.5, this implementation actually calls .

updateDocument

public void updateDocument(java.lang.String rootPath,
                           I_CmsSearchDocument document)
                    throws java.io.IOException

Description copied from interface: I_CmsIndexWriter

Update a document in the index.

Specified by:

updateDocument in interface I_CmsIndexWriter

Parameters:

rootPath - the root path of the document to update

document - the document to update

Throws:

java.io.IOException - in case something goes wrong

See Also:

I_CmsIndexWriter.updateDocument(java.lang.String, org.opencms.search.I_CmsSearchDocument)