Lucene - IndexWriter

void addDocument(Document doc)

将文档添加到此索引。

void addDocument(Document doc, Analyzer analyzer)

使用提供的分析器而不是 getAnalyzer() 的值将文档添加到此索引。

void addDocuments(Collectiondocs)

以原子方式添加一组文档，这些文档具有按顺序分配的文档 ID，这样外部读取器将看到所有文档或一个文档也不看。

void addDocuments(Collectiondocs, Analyzer analyzer)

以原子方式添加一组文档，使用提供的分析器进行分析，并按顺序分配文档 ID，这样外部读取器将看到所有文档或一个文档也不看。

void addIndexes(Directory... dirs)

将索引数组中的所有段添加到此索引。

void addIndexes(IndexReader... readers)

将提供的索引合并到此索引中。

void addIndexesNoOptimize(Directory... dirs)

已弃用。请改用 addIndexes(Directory...)。

void close()

将所有更改提交到索引并关闭所有关联的文件。

void close(boolean waitForMerges)

关闭索引，是否等待当前正在运行的合并完成。

void commit()

将所有挂起的更改（添加和删除的文档、段合并、添加的索引等）提交到索引，并同步所有引用的索引文件，以便读取器看到更改，并且索引更新将在操作系统或机器崩溃或电源故障后仍然存在。

void commit(Map<String,String> commitUserData)

提交所有更改到索引，指定 commitUserData Map (String -> String)。

void deleteAll()

删除索引中的所有文档。

void deleteDocuments(Query... queries)

删除与任何提供的查询匹配的文档。

void deleteDocuments(Query query)

删除与提供的查询匹配的文档。

void deleteDocuments(Term... terms)

删除包含任何术语的文档。

void deleteDocuments(Term term)

删除包含术语的文档。

void deleteUnusedFiles()

专家：删除不再使用的索引文件。

protected void doAfterFlush()

一个挂钩，供扩展类在将挂起的添加和删除的文档刷新到 Directory 之后但在更改提交之前（写入新的 segments_N 文件）执行操作。

protected void doBeforeFlush()

一个挂钩，供扩展类在将挂起的添加和删除的文档刷新到 Directory 之前执行操作。

protected void ensureOpen()

protected void ensureOpen(boolean includePendingClose)

在内部用于在关闭此 IndexWriter 时抛出 AlreadyClosedException。

void expungeDeletes()

已弃用。

void expungeDeletes(boolean doWait)

已弃用。

protected void flush(boolean triggerMerge, boolean applyAllDeletes)

将所有内存中缓冲的更新（添加和删除）刷新到 Directory。

protected void flush(boolean triggerMerge, boolean flushDocStores, boolean flushDeletes)

注意：现在忽略 flushDocStores（硬编码为 true）；此方法仅出于向后兼容性而存在。

void forceMerge(int maxNumSegments)

这是一个强制合并策略，用于合并段，直到段数 <= maxNumSegments。

void forceMerge(int maxNumSegments, boolean doWait)

与 forceMerge(int) 一样，除了您可以指定调用是否应阻塞直到所有合并完成。

void forceMergeDeletes()

强制合并所有包含已删除文档的段。

void forceMergeDeletes(boolean doWait)

与 forceMergeDeletes() 一样，除了您可以指定调用是否应阻塞直到操作完成。

Analyzer getAnalyzer()

返回此索引使用的分析器。

IndexWriterConfig getConfig()

返回私有的 IndexWriterConfig，它是从传递给 IndexWriter(Directory, IndexWriterConfig) 的 IndexWriterConfig 克隆而来的。

static PrintStream getDefaultInfoStream()

返回新实例化的 IndexWriter 的当前默认 infoStream。

static long getDefaultWriteLockTimeout()

已弃用。请改用 IndexWriterConfig.getDefaultWriteLockTimeout()。

Directory getDirectory()

返回此索引使用的 Directory。

PrintStream getInfoStream()

返回此写入器当前使用的 infoStream。

int getMaxBufferedDeleteTerms()

已弃用。请改用 IndexWriterConfig.getMaxBufferedDeleteTerms()。

int getMaxBufferedDocs()

已弃用。请改用 IndexWriterConfig.getMaxBufferedDocs()。

int getMaxFieldLength()

已弃用。请使用 LimitTokenCountAnalyzer 来限制标记的数量。

int getMaxMergeDocs()

已弃用。请直接使用 LogMergePolicy.getMaxMergeDocs()。

IndexWriter.IndexReaderWarmer getMergedSegmentWarmer()

已弃用。请改用 IndexWriterConfig.getMergedSegmentWarmer()。

int getMergeFactor()

已弃用。请直接使用 LogMergePolicy.getMergeFactor()。

MergePolicy getMergePolicy()

已弃用。请改用 IndexWriterConfig.getMergePolicy()。

MergeScheduler getMergeScheduler()

已弃用。请改用 IndexWriterConfig.getMergeScheduler()

Collection<SegmentInfo> getMergingSegments()

专家：供 MergePolicy 使用，以避免为正在合并的段选择合并。

MergePolicy.OneMerge getNextMerge()

专家：MergeScheduler 调用此方法来检索 MergePolicy 请求的下一个合并。

PayloadProcessorProvider getPayloadProcessorProvider()

返回在段合并期间用于处理有效负载的 PayloadProcessorProvider。

double getRAMBufferSizeMB()

已弃用。请改用 IndexWriterConfig.getRAMBufferSizeMB()。

IndexReader getReader()

已弃用。请改用 IndexReader.open(IndexWriter,boolean)。

IndexReader getReader(int termInfosIndexDivisor)

已弃用。请改用 IndexReader.open(IndexWriter,boolean)。此外，此方法无法保证读取器（及其子读取器）将使用 termInfosIndexDivisor 设置打开，因为其中一些读取器可能已经根据 IndexWriterConfig.setReaderTermsIndexDivisor(int) 打开。您应该通过 IndexWriterConfig.setReaderTermsIndexDivisor(int) 设置所需的 termInfosIndexDivisor 并使用 getReader()。

int getReaderTermsIndexDivisor()

已弃用。请改用 IndexWriterConfig.getReaderTermsIndexDivisor()。

Similarity getSimilarity()

已弃用。请改用 IndexWriterConfig.getSimilarity()。

int getTermIndexInterval()

已弃用。请使用 IndexWriterConfig.getTermIndexInterval()。

boolean getUseCompoundFile()

已弃用。请使用 LogMergePolicy.getUseCompoundFile()。

long getWriteLockTimeout()

已弃用。请改用 IndexWriterConfig.getWriteLockTimeout()

boolean hasDeletions()

static boolean isLocked(Directory directory)

如果命名目录中的索引当前已锁定，则返回 true。

int maxDoc()

返回此索引中的文档总数，包括尚未刷新的文档（仍在 RAM 缓冲区中），不计删除。

void maybeMerge()

专家：询问 mergePolicy 是否现在需要任何合并，如果需要，则运行请求的合并，然后迭代（再次测试是否需要合并），直到 mergePolicy 不再返回任何合并。

void merge(MergePolicy.OneMerge merge)

合并指示的段，用单个段替换它们。

void message(String message)

将消息打印到 infoStream（如果非空），前面带有此写入器的标识信息和正在调用的线程。

int numDeletedDocs(SegmentInfo info)

获取池化读取器的已删除文档数。

int numDocs()

返回此索引中的文档总数，包括尚未刷新的文档（仍在 RAM 缓冲区中），以及包括已删除的文档。

int numRamDocs()

专家：返回当前在 RAM 中缓冲的文档数。

void optimize()

已弃用。

void optimize(boolean doWait)

已弃用。

void optimize(int maxNumSegments)

已弃用。

void prepareCommit()

专家：准备提交。

void prepareCommit(Map<String,String> commitUserData)

专家：准备提交，指定 commitUserData Map (String -> String)。

long ramSizeInBytes()

专家：返回当前缓存在内存中的所有索引文件的总大小。

void rollback()

关闭 IndexWriter，而不提交自上次提交（或者自打开以来，如果尚未调用 commit）以来发生的任何更改。

String segString()

String segString(Iterable<SegmentInfo> infos)

String segString(SegmentInfo info)

static void setDefaultInfoStream(PrintStream infoStream)

如果非空，这将是新实例化的 IndexWriter 使用的默认 infoStream。

static void setDefaultWriteLockTimeout(long writeLockTimeout)

已弃用。请改用 IndexWriterConfig.setDefaultWriteLockTimeout(long)。

void setInfoStream(PrintStream infoStream)

如果非空，则将有关合并、删除以及达到maxFieldLength时的消息打印到这里。

void setMaxBufferedDeleteTerms(int maxBufferedDeleteTerms)

已弃用。请改用IndexWriterConfig.setMaxBufferedDeleteTerms(int)。

void setMaxBufferedDocs(int maxBufferedDocs)

已弃用。请改用IndexWriterConfig.setMaxBufferedDocs(int)。

void setMaxFieldLength(int maxFieldLength)

已弃用。请改用LimitTokenCountAnalyzer。注意行为上的变化——分析器限制每个创建的标记流中的标记数量，而此设置限制要索引的标记总数。不过，只有在索引许多多值字段时，这才有关系。

void setMaxMergeDocs(int maxMergeDocs)

已弃用。请直接使用LogMergePolicy.setMaxMergeDocs(int)。

void setMergedSegmentWarmer(IndexWriter.IndexReaderWarmer warmer)

已弃用。请改用IndexWriterConfig.setMergedSegmentWarmer( org.apache.lucene.index.IndexWriter.IndexReaderWarmer )。

void setMergeFactor(int mergeFactor)

已弃用。请直接使用LogMergePolicy.setMergeFactor(int)。

void setMergePolicy(MergePolicy mp)

已弃用。请改用IndexWriterConfig.setMergePolicy(MergePolicy)。

void setMergeScheduler(MergeScheduler mergeScheduler)

已弃用。请改用IndexWriterConfig.setMergeScheduler(MergeScheduler)。

void setPayloadProcessorProvider(PayloadProcessorProvider pcp)

设置合并有效负载时使用的PayloadProcessorProvider。

void setRAMBufferSizeMB(double mb)

已弃用。请改用IndexWriterConfig.setRAMBufferSizeMB(double)。

void setReaderTermsIndexDivisor(int divisor)

已弃用。请改用IndexWriterConfig.setReaderTermsIndexDivisor(int)。

void setSimilarity(Similarity similarity)

已弃用。请改用IndexWriterConfig.setSimilarity(Similarity)。

void setTermIndexInterval(int interval)

已弃用。请使用IndexWriterConfig.setTermIndexInterval(int)。

void setUseCompoundFile(boolean value)

已弃用。请使用LogMergePolicy.setUseCompoundFile(boolean)。

void setWriteLockTimeout(long writeLockTimeout)

已弃用。请改用IndexWriterConfig.setWriteLockTimeout(long)。

static void unlock(Directory directory)

强制解锁指定目录中的索引。

void updateDocument(Term term, Document doc)

通过首先删除包含term的文档，然后添加新文档来更新文档。

void updateDocument(Term term, Document doc, Analyzer analyzer)

通过首先删除包含term的文档，然后添加新文档来更新文档。

void updateDocuments(Term delTerm, Collection<Document> docs)

原子地删除与提供的delTerm匹配的文档，并添加具有顺序分配的文档 ID 的文档块，以便外部读取器可以看到所有文档或任何文档。

void updateDocuments(Term delTerm, Collection<Document> docs, Analyzer analyzer)

原子地删除与提供的delTerm匹配的文档，并添加使用提供的分析器进行分析的文档块，这些文档具有顺序分配的文档 ID，以便外部读取器可以看到所有文档或任何文档。

boolean verbose()

如果启用了详细模式（即infoStream），则返回true。

void waitForMerges()

等待任何当前未完成的合并完成。