Package | Description |
---|---|
org.apache.lucene.index |
Code to maintain and access indices.
|
org.apache.lucene.search |
Code to search indices.
|
Modifier and Type | Class and Description |
---|---|
class |
IndexFormatTooNewException
This exception is thrown when Lucene detects
an index that is newer than this Lucene version.
|
class |
IndexFormatTooOldException
This exception is thrown when Lucene detects
an index that is too old for this Lucene version
|
Modifier and Type | Method and Description |
---|---|
void |
IndexWriter.addDocument(Document doc)
Adds a document to this index.
|
void |
IndexWriter.addDocument(Document doc,
Analyzer analyzer)
Adds a document to this index, using the provided analyzer instead of the
value of
IndexWriter.getAnalyzer() . |
void |
IndexWriter.addDocuments(Collection<Document> docs)
Atomically adds a block of documents with sequentially
assigned document IDs, such that an external reader
will see all or none of the documents.
|
void |
IndexWriter.addDocuments(Collection<Document> docs,
Analyzer analyzer)
Atomically adds a block of documents, analyzed using the
provided analyzer, with sequentially assigned document
IDs, such that an external reader will see all or none
of the documents.
|
void |
IndexWriter.addIndexes(Directory... dirs)
Adds all segments from an array of indexes into this index.
|
void |
IndexWriter.addIndexes(IndexReader... readers)
Merges the provided indexes into this index.
|
void |
IndexWriter.addIndexesNoOptimize(Directory... dirs)
Deprecated.
use
IndexWriter.addIndexes(Directory...) instead |
IndexReader |
IndexReader.clone(boolean openReadOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexReader.clone() instead. |
IndexReader |
SegmentReader.clone(boolean openReadOnly)
Deprecated.
|
IndexReader |
MultiReader.clone(boolean openReadOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
MultiReader.clone() instead. |
IndexReader |
ParallelReader.clone(boolean openReadOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
ParallelReader.clone() instead. |
void |
IndexWriter.close()
Commits all changes to an index and closes all
associated files.
|
abstract void |
MergeScheduler.close()
Close this MergeScheduler.
|
void |
PersistentSnapshotDeletionPolicy.close()
Closes the index which writes the snapshots to the directory.
|
void |
IndexWriter.close(boolean waitForMerges)
Closes the index with or without waiting for currently
running merges to finish.
|
void |
IndexWriter.commit()
Commits all pending changes (added & deleted
documents, segment merges, added
indexes, etc.) to the index, and syncs all referenced
index files, such that a reader will see the changes
and the index updates will survive an OS or machine
crash or power loss.
|
void |
IndexWriter.commit(Map<String,String> commitUserData)
Commits all changes to the index, specifying a
commitUserData Map (String -> String).
|
void |
IndexReader.deleteDocument(int docNum)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexWriter.deleteDocuments(Term) instead |
void |
IndexWriter.deleteDocuments(Query... queries)
Deletes the document(s) matching any of the provided queries.
|
void |
IndexWriter.deleteDocuments(Query query)
Deletes the document(s) matching the provided query.
|
void |
IndexWriter.deleteDocuments(Term... terms)
Deletes the document(s) containing any of the
terms.
|
int |
IndexReader.deleteDocuments(Term term)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexWriter.deleteDocuments(Term) instead |
void |
IndexWriter.deleteDocuments(Term term)
Deletes the document(s) containing
term . |
protected abstract Object |
SegmentInfos.FindSegmentsFile.doBody(String segmentFileName)
Subclass must implement this.
|
Document |
IndexReader.document(int n)
Returns the stored fields of the
n th
Document in this index. |
abstract Document |
IndexReader.document(int n,
FieldSelector fieldSelector)
Get the
Document at the n
th position. |
Document |
SegmentReader.document(int n,
FieldSelector fieldSelector) |
Document |
MultiReader.document(int n,
FieldSelector fieldSelector) |
Document |
FilterIndexReader.document(int n,
FieldSelector fieldSelector) |
Document |
ParallelReader.document(int n,
FieldSelector fieldSelector) |
protected abstract void |
IndexReader.doDelete(int docNum)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexWriter.deleteDocuments(Term) instead |
protected void |
MultiReader.doDelete(int n)
Deprecated.
|
protected void |
FilterIndexReader.doDelete(int n)
Deprecated.
|
protected void |
ParallelReader.doDelete(int n)
Deprecated.
|
protected IndexReader |
IndexReader.doOpenIfChanged()
If the index has changed since it was opened, open and return a new reader;
else, return
null . |
protected IndexReader |
SegmentReader.doOpenIfChanged() |
protected IndexReader |
MultiReader.doOpenIfChanged() |
protected IndexReader |
ParallelReader.doOpenIfChanged() |
protected IndexReader |
IndexReader.doOpenIfChanged(boolean openReadOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexReader.doOpenIfChanged() instead |
protected IndexReader |
SegmentReader.doOpenIfChanged(boolean openReadOnly)
Deprecated.
|
protected IndexReader |
MultiReader.doOpenIfChanged(boolean openReadOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
MultiReader.doOpenIfChanged() instead. |
protected IndexReader |
ParallelReader.doOpenIfChanged(boolean openReadOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
ParallelReader.doOpenIfChanged() instead. |
protected IndexReader |
IndexReader.doOpenIfChanged(IndexCommit commit)
If the index has changed since it was opened, open and return a new reader;
else, return
null . |
protected IndexReader |
IndexReader.doOpenIfChanged(IndexWriter writer,
boolean applyAllDeletes)
If the index has changed since it was opened, open and return a new reader;
else, return
null . |
protected abstract void |
IndexReader.doSetNorm(int doc,
String field,
byte value)
Deprecated.
Write support will be removed in Lucene 4.0.
There will be no replacement for this method.
|
protected void |
MultiReader.doSetNorm(int n,
String field,
byte value)
Deprecated.
|
protected void |
FilterIndexReader.doSetNorm(int d,
String f,
byte b)
Deprecated.
|
protected void |
ParallelReader.doSetNorm(int n,
String field,
byte value)
Deprecated.
|
protected abstract void |
IndexReader.doUndeleteAll()
Deprecated.
Write support will be removed in Lucene 4.0.
There will be no replacement for this method.
|
protected void |
MultiReader.doUndeleteAll()
Deprecated.
|
protected void |
FilterIndexReader.doUndeleteAll()
Deprecated.
|
protected void |
ParallelReader.doUndeleteAll()
Deprecated.
|
void |
IndexWriter.expungeDeletes()
Deprecated.
|
void |
IndexWriter.expungeDeletes(boolean doWait)
Deprecated.
|
MergePolicy.MergeSpecification |
TieredMergePolicy.findForcedDeletesMerges(SegmentInfos infos) |
MergePolicy.MergeSpecification |
LogMergePolicy.findForcedDeletesMerges(SegmentInfos segmentInfos)
Finds merges necessary to force-merge all deletes from the
index.
|
abstract MergePolicy.MergeSpecification |
MergePolicy.findForcedDeletesMerges(SegmentInfos segmentInfos)
Determine what set of merge operations is necessary in order to expunge all
deletes from the index.
|
MergePolicy.MergeSpecification |
UpgradeIndexMergePolicy.findForcedDeletesMerges(SegmentInfos segmentInfos) |
MergePolicy.MergeSpecification |
NoMergePolicy.findForcedDeletesMerges(SegmentInfos segmentInfos) |
abstract MergePolicy.MergeSpecification |
MergePolicy.findForcedMerges(SegmentInfos segmentInfos,
int maxSegmentCount,
Map<SegmentInfo,Boolean> segmentsToMerge)
Determine what set of merge operations is necessary in
order to merge to <= the specified segment count.
|
MergePolicy.MergeSpecification |
UpgradeIndexMergePolicy.findForcedMerges(SegmentInfos segmentInfos,
int maxSegmentCount,
Map<SegmentInfo,Boolean> segmentsToMerge) |
MergePolicy.MergeSpecification |
NoMergePolicy.findForcedMerges(SegmentInfos segmentInfos,
int maxSegmentCount,
Map<SegmentInfo,Boolean> segmentsToMerge) |
abstract MergePolicy.MergeSpecification |
MergePolicy.findMerges(SegmentInfos segmentInfos)
Determine what set of merge operations are now necessary on the index.
|
MergePolicy.MergeSpecification |
UpgradeIndexMergePolicy.findMerges(SegmentInfos segmentInfos) |
MergePolicy.MergeSpecification |
NoMergePolicy.findMerges(SegmentInfos segmentInfos) |
protected void |
IndexWriter.flush(boolean triggerMerge,
boolean applyAllDeletes)
Flush all in-memory buffered updates (adds and deletes)
to the Directory.
|
protected void |
IndexWriter.flush(boolean triggerMerge,
boolean flushDocStores,
boolean flushDeletes)
NOTE: flushDocStores is ignored now (hardwired to
true); this method is only here for backwards
compatibility
|
void |
IndexWriter.forceMerge(int maxNumSegments)
Forces merge policy to merge segments until there's <=
maxNumSegments.
|
void |
IndexWriter.forceMerge(int maxNumSegments,
boolean doWait)
Just like
IndexWriter.forceMerge(int) , except you can
specify whether the call should block until
all merging completes. |
void |
IndexWriter.forceMergeDeletes()
Forces merging of all segments that have deleted
documents.
|
void |
IndexWriter.forceMergeDeletes(boolean doWait)
Just like
IndexWriter.forceMergeDeletes() , except you can
specify whether the call should block until the
operation completes. |
static SegmentReader |
SegmentReader.get(boolean readOnly,
Directory dir,
SegmentInfo si,
int readBufferSize,
boolean doOpenStores,
int termInfosIndexDivisor) |
static SegmentReader |
SegmentReader.get(boolean readOnly,
SegmentInfo si,
int termInfosIndexDivisor) |
static Map<String,String> |
IndexReader.getCommitUserData(Directory directory)
Deprecated.
Call
IndexReader.getIndexCommit() on an open IndexReader, and then call
IndexCommit.getUserData() . |
static long |
IndexReader.getCurrentVersion(Directory directory)
Deprecated.
Use
IndexReader.getVersion() on an opened IndexReader. |
boolean |
IndexReader.isCurrent()
Check whether any new changes have occurred to the
index since this reader was opened.
|
boolean |
MultiReader.isCurrent()
Checks recursively if all subreaders are up to date.
|
boolean |
FilterIndexReader.isCurrent() |
boolean |
ParallelReader.isCurrent()
Checks recursively if all subreaders are up to date.
|
static long |
IndexReader.lastModified(Directory directory2)
Deprecated.
If you need to track commit time of
an index, you can store it in the commit data (see
IndexWriter.commit(Map) |
void |
IndexWriter.maybeMerge()
Expert: asks the mergePolicy whether any merges are
necessary now and if so, runs the requested merges and
then iterate (test again if merges are needed) until no
more merges are returned by the mergePolicy.
|
void |
NoMergeScheduler.merge(IndexWriter writer) |
abstract void |
MergeScheduler.merge(IndexWriter writer)
Run the merges provided by
IndexWriter.getNextMerge() . |
void |
SerialMergeScheduler.merge(IndexWriter writer)
Just do the merges in sequence.
|
void |
IndexWriter.merge(MergePolicy.OneMerge merge)
Merges the indicated segments, replacing them in the stack with a
single segment.
|
static IndexReader |
IndexReader.open(Directory directory)
Returns a IndexReader reading the index in the given
Directory, with readOnly=true.
|
static IndexReader |
IndexReader.open(Directory directory,
boolean readOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexReader.open(Directory) instead |
static IndexReader |
IndexReader.open(Directory directory,
IndexDeletionPolicy deletionPolicy,
boolean readOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexReader.open(Directory) instead |
static IndexReader |
IndexReader.open(Directory directory,
IndexDeletionPolicy deletionPolicy,
boolean readOnly,
int termInfosIndexDivisor)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexReader.open(Directory,int) instead |
static IndexReader |
IndexReader.open(Directory directory,
int termInfosIndexDivisor)
Expert: Returns a IndexReader reading the index in the given
Director and given termInfosIndexDivisor
|
static IndexReader |
IndexReader.open(IndexCommit commit)
Expert: returns an IndexReader reading the index in the given
IndexCommit . |
static IndexReader |
IndexReader.open(IndexCommit commit,
boolean readOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexReader.open(IndexCommit) instead |
static IndexReader |
IndexReader.open(IndexCommit commit,
IndexDeletionPolicy deletionPolicy,
boolean readOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexReader.open(IndexCommit) instead |
static IndexReader |
IndexReader.open(IndexCommit commit,
IndexDeletionPolicy deletionPolicy,
boolean readOnly,
int termInfosIndexDivisor)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexReader.open(IndexCommit,int) instead |
static IndexReader |
IndexReader.open(IndexCommit commit,
int termInfosIndexDivisor)
Expert: returns an IndexReader reading the index in the given
IndexCommit and termInfosIndexDivisor. |
static IndexReader |
IndexReader.open(IndexWriter writer,
boolean applyAllDeletes)
Open a near real time IndexReader from the
IndexWriter . |
void |
IndexWriter.optimize()
Deprecated.
|
void |
IndexWriter.optimize(boolean doWait)
Deprecated.
|
void |
IndexWriter.optimize(int maxNumSegments)
Deprecated.
|
void |
IndexWriter.prepareCommit()
Expert: prepare for commit.
|
void |
IndexWriter.prepareCommit(Map<String,String> commitUserData)
Expert: prepare for commit, specifying
commitUserData Map (String -> String).
|
void |
SegmentInfos.read(Directory directory)
This version of read uses the retry logic (for lock-less
commits) to find the right segments file to load.
|
void |
SegmentInfos.read(Directory directory,
String segmentFileName)
Read a particular segmentFileName.
|
static long |
SegmentInfos.readCurrentVersion(Directory directory)
Deprecated.
Load the SegmentInfos and then call
SegmentInfos.getVersion() . |
IndexReader |
IndexReader.reopen()
Deprecated.
Use
IndexReader.openIfChanged(IndexReader) instead |
IndexReader |
IndexReader.reopen(boolean openReadOnly)
Deprecated.
Write support will be removed in Lucene 4.0.
Use
IndexReader.openIfChanged(IndexReader) instead |
IndexReader |
IndexReader.reopen(IndexCommit commit)
Deprecated.
|
IndexReader |
IndexReader.reopen(IndexWriter writer,
boolean applyAllDeletes)
Deprecated.
|
Object |
SegmentInfos.FindSegmentsFile.run() |
Object |
SegmentInfos.FindSegmentsFile.run(IndexCommit commit) |
void |
IndexWriter.setMergeScheduler(MergeScheduler mergeScheduler)
Deprecated.
|
void |
IndexReader.setNorm(int doc,
String field,
byte value)
Deprecated.
Write support will be removed in Lucene 4.0.
There will be no replacement for this method.
|
void |
IndexReader.setNorm(int doc,
String field,
float value)
Deprecated.
Write support will be removed in Lucene 4.0.
There will be no replacement for this method.
|
void |
IndexReader.undeleteAll()
Deprecated.
Write support will be removed in Lucene 4.0.
There will be no replacement for this method.
|
void |
IndexWriter.updateDocument(Term term,
Document doc)
Updates a document by first deleting the document(s)
containing
term and then adding the new
document. |
void |
IndexWriter.updateDocument(Term term,
Document doc,
Analyzer analyzer)
Updates a document by first deleting the document(s)
containing
term and then adding the new
document. |
void |
IndexWriter.updateDocuments(Term delTerm,
Collection<Document> docs)
Atomically deletes documents matching the provided
delTerm and adds a block of documents with sequentially
assigned document IDs, such that an external reader
will see all or none of the documents.
|
void |
IndexWriter.updateDocuments(Term delTerm,
Collection<Document> docs,
Analyzer analyzer)
Atomically deletes documents matching the provided
delTerm and adds a block of documents, analyzed using
the provided analyzer, with sequentially
assigned document IDs, such that an external reader
will see all or none of the documents.
|
Modifier and Type | Method and Description |
---|---|
long |
NRTManager.TrackingIndexWriter.addIndexes(Directory... dirs) |
long |
NRTManager.TrackingIndexWriter.addIndexes(IndexReader... readers) |
Document |
MultiSearcher.doc(int n)
Deprecated.
|
Document |
Searchable.doc(int i)
Deprecated.
Returns the stored fields of document
i . |
abstract Document |
Searcher.doc(int i)
Deprecated.
|
Document |
IndexSearcher.doc(int docID) |
Document |
MultiSearcher.doc(int n,
FieldSelector fieldSelector)
Deprecated.
|
Document |
Searchable.doc(int n,
FieldSelector fieldSelector)
Deprecated.
Get the
Document at the n th position. |
abstract Document |
Searcher.doc(int docid,
FieldSelector fieldSelector)
Deprecated.
|
Document |
IndexSearcher.doc(int docID,
FieldSelector fieldSelector) |
Constructor and Description |
---|
IndexSearcher(Directory path)
Deprecated.
use
IndexSearcher.IndexSearcher(IndexReader) instead. |
IndexSearcher(Directory path,
boolean readOnly)
Deprecated.
Use
IndexSearcher.IndexSearcher(IndexReader) instead. |