org.opencms.search

类 CmsLuceneIndexWriter

java.lang.Object

org.opencms.search.CmsLuceneIndexWriter

所有已实现的接口:

I_CmsIndexWriter

public class CmsLuceneIndexWriter
extends java.lang.Object
implements I_CmsIndexWriter

Delegates indexing to a standard Lucene IndexWriter.

从以下版本开始:

8.0.2

字段概要

字段

限定符和类型	字段和说明
protected static org.apache.commons.logging.Log	LOG The log object for this class.

构造器概要

构造器

构造器和说明
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.

方法概要

方法

限定符和类型	方法和说明
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.

从类继承的方法 java.lang.Object

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

字段详细资料

LOG

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

The log object for this class.

构造器详细资料

CmsLuceneIndexWriter

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

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

参数:

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.

参数:

indexWriter - the standard Lucene IndexWriter to use as delegate

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

方法详细资料

close

public void close()
           throws java.io.IOException

从接口复制的说明: I_CmsIndexWriter

Close this IndexWriter.

指定者:

close 在接口中 I_CmsIndexWriter

抛出:

java.io.IOException

另请参阅:

I_CmsIndexWriter.close()

commit

public void commit()
            throws java.io.IOException

从接口复制的说明: I_CmsIndexWriter

Commit all previous operations.

指定者:

commit 在接口中 I_CmsIndexWriter

抛出:

java.io.IOException

另请参阅:

I_CmsIndexWriter.commit()

deleteDocument

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

从接口复制的说明: I_CmsIndexWriter

Delete a document from the index.

指定者:

deleteDocument 在接口中 I_CmsIndexWriter

参数:

resource - the resource to delete

抛出:

java.io.IOException - in case something goes wrong

另请参阅:

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

optimize

public void optimize()
              throws java.io.IOException

从接口复制的说明: 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.

指定者:

optimize 在接口中 I_CmsIndexWriter

抛出:

java.io.IOException

另请参阅:

As optimize is deprecated with Lucene 3.5, this implementation actually calls {@link IndexWriter#forceMerge(int)}.

updateDocument

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

从接口复制的说明: I_CmsIndexWriter

Update a document in the index.

指定者:

updateDocument 在接口中 I_CmsIndexWriter

参数:

rootPath - the root path of the document to update

document - the document to update

抛出:

java.io.IOException - in case something goes wrong

另请参阅:

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