Package | Description |
---|---|
org.apache.lucene.index |
Code to maintain and access indices.
|
org.apache.lucene.search |
Code to search indices.
|
Modifier and Type | Method and Description |
---|---|
void |
IndexWriter.addDocument(Document doc)
Adds a document to this index.
|
void |
IndexModifier.addDocument(Document doc)
Deprecated.
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 |
IndexModifier.addDocument(Document doc,
Analyzer docAnalyzer)
Deprecated.
Adds a document to this index, using the provided analyzer instead of the
one specific in the constructor.
|
void |
IndexWriter.addIndexes(Directory[] dirs)
Deprecated.
Use
IndexWriter.addIndexesNoOptimize(org.apache.lucene.store.Directory[]) instead,
then separately call IndexWriter.optimize() afterwards if
you need to. |
void |
IndexWriter.addIndexes(IndexReader[] readers)
Merges the provided indexes into this index.
|
void |
IndexWriter.addIndexesNoOptimize(Directory[] dirs)
Merges all segments from an array of indexes into this
index.
|
IndexReader |
SegmentReader.clone(boolean openReadOnly) |
IndexReader |
IndexReader.clone(boolean openReadOnly)
Clones the IndexReader and optionally changes readOnly.
|
void |
IndexWriter.close()
Commits all changes to an index and closes all
associated files.
|
void |
IndexModifier.close()
Deprecated.
Close this index, writing all pending changes to disk.
|
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, optimizations, 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 commitUserData)
Commits all changes to the index, specifying a
commitUserData Map (String -> String).
|
protected void |
IndexModifier.createIndexReader()
Deprecated.
Close the IndexWriter and open an IndexReader.
|
protected void |
IndexModifier.createIndexWriter()
Deprecated.
Close the IndexReader and open an IndexWriter.
|
void |
IndexReader.deleteDocument(int docNum)
Deletes the document numbered
docNum . |
void |
IndexModifier.deleteDocument(int docNum)
Deprecated.
Deletes the document numbered
docNum . |
void |
IndexWriter.deleteDocuments(Query query)
Deletes the document(s) matching the provided query.
|
void |
IndexWriter.deleteDocuments(Query[] queries)
Deletes the document(s) matching any of the provided queries.
|
int |
IndexReader.deleteDocuments(Term term)
Deletes all documents that have a given
term indexed. |
void |
IndexWriter.deleteDocuments(Term term)
Deletes the document(s) containing
term . |
int |
IndexModifier.deleteDocuments(Term term)
Deprecated.
Deletes all documents containing
term . |
void |
IndexWriter.deleteDocuments(Term[] terms)
Deletes the document(s) containing any of the
terms.
|
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. |
Document |
SegmentReader.document(int n,
FieldSelector fieldSelector) |
abstract Document |
IndexReader.document(int n,
FieldSelector fieldSelector)
Get the
Document at the n
th position. |
Document |
FilterIndexReader.document(int n,
FieldSelector fieldSelector) |
Document |
MultiReader.document(int n,
FieldSelector fieldSelector) |
Document |
ParallelReader.document(int n,
FieldSelector fieldSelector) |
protected abstract void |
IndexReader.doDelete(int docNum)
Implements deletion of the document numbered
docNum . |
protected void |
FilterIndexReader.doDelete(int n) |
protected void |
MultiReader.doDelete(int n) |
protected void |
ParallelReader.doDelete(int n) |
protected IndexReader |
MultiReader.doReopen(boolean doClone)
If clone is true then we clone each of the subreaders
|
protected IndexReader |
ParallelReader.doReopen(boolean doClone) |
protected abstract void |
IndexReader.doSetNorm(int doc,
String field,
byte value)
Implements setNorm in subclass.
|
protected void |
FilterIndexReader.doSetNorm(int d,
String f,
byte b) |
protected void |
MultiReader.doSetNorm(int n,
String field,
byte value) |
protected void |
ParallelReader.doSetNorm(int n,
String field,
byte value) |
protected abstract void |
IndexReader.doUndeleteAll()
Implements actual undeleteAll() in subclass.
|
protected void |
FilterIndexReader.doUndeleteAll() |
protected void |
MultiReader.doUndeleteAll() |
protected void |
ParallelReader.doUndeleteAll() |
void |
IndexWriter.expungeDeletes()
Expunges all deletes from the index.
|
void |
IndexWriter.expungeDeletes(boolean doWait)
Just like
IndexWriter.expungeDeletes() , except you can
specify whether the call should block until the
operation completes. |
abstract MergePolicy.MergeSpecification |
MergePolicy.findMerges(SegmentInfos segmentInfos)
Determine what set of merge operations are now necessary on the index.
|
abstract MergePolicy.MergeSpecification |
MergePolicy.findMergesForOptimize(SegmentInfos segmentInfos,
int maxSegmentCount,
Set segmentsToOptimize)
Determine what set of merge operations is necessary in order to optimize
the index.
|
abstract MergePolicy.MergeSpecification |
MergePolicy.findMergesToExpungeDeletes(SegmentInfos segmentInfos)
Determine what set of merge operations is necessary in order to expunge all
deletes from the index.
|
MergePolicy.MergeSpecification |
LogMergePolicy.findMergesToExpungeDeletes(SegmentInfos segmentInfos)
Finds merges necessary to expunge all deletes from the
index.
|
void |
IndexWriter.flush()
Deprecated.
please call
IndexWriter.commit() ) instead |
void |
IndexModifier.flush()
Deprecated.
Make sure all changes are written to disk.
|
protected void |
IndexWriter.flush(boolean triggerMerge,
boolean flushDocStores,
boolean flushDeletes)
Flush all in-memory buffered udpates (adds and deletes)
to the Directory.
|
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 SegmentReader |
SegmentReader.get(SegmentInfo si)
Deprecated.
|
static Map |
IndexReader.getCommitUserData(Directory directory)
Reads commitUserData, previously passed to
IndexWriter.commit(Map) , from current index
segments file. |
static long |
IndexReader.getCurrentVersion(Directory directory)
Reads version number from segments files.
|
static long |
IndexReader.getCurrentVersion(File directory)
Deprecated.
Use
IndexReader.getCurrentVersion(Directory) instead.
This method will be removed in the 3.0 release. |
static long |
IndexReader.getCurrentVersion(String directory)
Deprecated.
Use
IndexReader.getCurrentVersion(Directory) instead.
This method will be removed in the 3.0 release. |
PrintStream |
IndexModifier.getInfoStream()
Deprecated.
|
int |
IndexModifier.getMaxBufferedDocs()
Deprecated.
|
int |
IndexModifier.getMaxFieldLength()
Deprecated.
|
int |
IndexModifier.getMergeFactor()
Deprecated.
|
boolean |
IndexModifier.getUseCompoundFile()
Deprecated.
|
protected void |
IndexModifier.init(Directory directory,
Analyzer analyzer,
boolean create)
Deprecated.
Initialize an IndexWriter.
|
boolean |
IndexReader.isCurrent()
Check whether any new changes have occurred to the
index since this reader was opened.
|
boolean |
FilterIndexReader.isCurrent() |
boolean |
MultiReader.isCurrent()
Checks recursively if all subreaders are up to date.
|
boolean |
ParallelReader.isCurrent()
Checks recursively if all subreaders are up to date.
|
static long |
IndexReader.lastModified(Directory directory2)
Returns the time the index in the named directory was last modified.
|
static long |
IndexReader.lastModified(File fileDirectory)
Deprecated.
Use
IndexReader.lastModified(Directory) instead.
This method will be removed in the 3.0 release. |
static long |
IndexReader.lastModified(String directory)
Deprecated.
Use
IndexReader.lastModified(Directory) instead.
This method will be removed in the 3.0 release. |
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 |
ConcurrentMergeScheduler.merge(IndexWriter writer) |
void |
SerialMergeScheduler.merge(IndexWriter writer)
Just do the merges in sequence.
|
static IndexReader |
IndexReader.open(Directory directory)
Deprecated.
Use
IndexReader.open(Directory, boolean) instead
This method will be removed in the 3.0 release. |
static IndexReader |
IndexReader.open(Directory directory,
boolean readOnly)
Returns an IndexReader reading the index in the given
Directory.
|
static IndexReader |
IndexReader.open(Directory directory,
IndexDeletionPolicy deletionPolicy)
Deprecated.
Use
IndexReader.open(Directory, IndexDeletionPolicy, boolean) instead.
This method will be removed in the 3.0 release. |
static IndexReader |
IndexReader.open(Directory directory,
IndexDeletionPolicy deletionPolicy,
boolean readOnly)
Expert: returns an IndexReader reading the index in
the given Directory, with a custom
IndexDeletionPolicy . |
static IndexReader |
IndexReader.open(Directory directory,
IndexDeletionPolicy deletionPolicy,
boolean readOnly,
int termInfosIndexDivisor)
Expert: returns an IndexReader reading the index in
the given Directory, with a custom
IndexDeletionPolicy . |
static IndexReader |
IndexReader.open(File path)
Deprecated.
Use
IndexReader.open(Directory, boolean) instead.
This method will be removed in the 3.0 release. |
static IndexReader |
IndexReader.open(File path,
boolean readOnly)
Deprecated.
Use
IndexReader.open(Directory, boolean) instead.
This method will be removed in the 3.0 release. |
static IndexReader |
IndexReader.open(IndexCommit commit)
Deprecated.
Use
IndexReader.open(IndexCommit, boolean) instead.
This method will be removed in the 3.0 release. |
static IndexReader |
IndexReader.open(IndexCommit commit,
boolean readOnly)
Expert: returns an IndexReader reading the index in the given
IndexCommit . |
static IndexReader |
IndexReader.open(IndexCommit commit,
IndexDeletionPolicy deletionPolicy)
Deprecated.
Use
IndexReader.open(IndexCommit, IndexDeletionPolicy, boolean) instead.
This method will be removed in the 3.0 release. |
static IndexReader |
IndexReader.open(IndexCommit commit,
IndexDeletionPolicy deletionPolicy,
boolean readOnly)
Expert: returns an IndexReader reading the index in
the given Directory, using a specific commit and with
a custom
IndexDeletionPolicy . |
static IndexReader |
IndexReader.open(IndexCommit commit,
IndexDeletionPolicy deletionPolicy,
boolean readOnly,
int termInfosIndexDivisor)
Expert: returns an IndexReader reading the index in
the given Directory, using a specific commit and with
a custom
IndexDeletionPolicy . |
static IndexReader |
IndexReader.open(String path)
Deprecated.
Use
IndexReader.open(Directory, boolean) instead.
This method will be removed in the 3.0 release. |
static IndexReader |
IndexReader.open(String path,
boolean readOnly)
Deprecated.
Use
IndexReader.open(Directory, boolean) instead.
This method will be removed in the 3.0 release. |
void |
IndexWriter.optimize()
Requests an "optimize" operation on an index, priming the index
for the fastest available search.
|
void |
IndexModifier.optimize()
Deprecated.
Merges all segments together into a single segment, optimizing an index
for search.
|
void |
IndexWriter.optimize(boolean doWait)
Just like
IndexWriter.optimize() , except you can specify
whether the call should block until the optimize
completes. |
void |
IndexWriter.optimize(int maxNumSegments)
Optimize the index down to <= maxNumSegments.
|
void |
IndexWriter.optimize(int maxNumSegments,
boolean doWait)
Just like
IndexWriter.optimize(int) , except you can
specify whether the call should block until the
optimize completes. |
void |
IndexWriter.prepareCommit()
Expert: prepare for commit.
|
void |
IndexWriter.prepareCommit(Map 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 Map |
SegmentInfos.readCurrentUserData(Directory directory)
Returns userData from latest segments file
|
static long |
SegmentInfos.readCurrentVersion(Directory directory)
Current version number from segments file.
|
IndexReader |
IndexReader.reopen()
Refreshes an IndexReader if the index has changed since this instance
was (re)opened.
|
IndexReader |
MultiReader.reopen()
Tries to reopen the subreaders.
|
IndexReader |
ParallelReader.reopen()
Tries to reopen the subreaders.
|
IndexReader |
IndexReader.reopen(boolean openReadOnly)
Just like
IndexReader.reopen() , except you can change the
readOnly of the original reader. |
IndexReader |
IndexReader.reopen(IndexCommit commit)
Expert: reopen this reader on a specific commit point.
|
Object |
SegmentInfos.FindSegmentsFile.run() |
Object |
SegmentInfos.FindSegmentsFile.run(IndexCommit commit) |
void |
IndexWriter.setMergeScheduler(MergeScheduler mergeScheduler)
Expert: set the merge scheduler used by this writer.
|
void |
IndexReader.setNorm(int doc,
String field,
byte value)
Expert: Resets the normalization factor for the named field of the named
document.
|
void |
IndexReader.setNorm(int doc,
String field,
float value)
Expert: Resets the normalization factor for the named field of the named
document.
|
void |
IndexReader.undeleteAll()
Undeletes all documents currently marked as deleted in this index.
|
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. |
Constructor and Description |
---|
IndexModifier(Directory directory,
Analyzer analyzer,
boolean create)
Deprecated.
Open an index with write access.
|
IndexModifier(File file,
Analyzer analyzer,
boolean create)
Deprecated.
Open an index with write access.
|
IndexModifier(String dirName,
Analyzer analyzer,
boolean create)
Deprecated.
Open an index with write access.
|
IndexWriter(Directory d,
Analyzer a)
Deprecated.
This constructor will be removed in the 3.0 release.
Use
IndexWriter.IndexWriter(Directory,Analyzer,MaxFieldLength)
instead, and call IndexWriter.commit() when needed. |
IndexWriter(Directory d,
Analyzer a,
boolean create)
Deprecated.
This constructor will be removed in the 3.0
release, and call
IndexWriter.commit() when needed.
Use IndexWriter.IndexWriter(Directory,Analyzer,boolean,MaxFieldLength) instead. |
IndexWriter(Directory d,
Analyzer a,
boolean create,
IndexDeletionPolicy deletionPolicy,
IndexWriter.MaxFieldLength mfl)
Expert: constructs an IndexWriter with a custom
IndexDeletionPolicy , for the index in d . |
IndexWriter(Directory d,
Analyzer a,
boolean create,
IndexWriter.MaxFieldLength mfl)
Constructs an IndexWriter for the index in
d . |
IndexWriter(Directory d,
Analyzer a,
IndexDeletionPolicy deletionPolicy,
IndexWriter.MaxFieldLength mfl)
Expert: constructs an IndexWriter with a custom
IndexDeletionPolicy , for the index in d ,
first creating it if it does not already exist. |
IndexWriter(Directory d,
Analyzer a,
IndexDeletionPolicy deletionPolicy,
IndexWriter.MaxFieldLength mfl,
IndexCommit commit)
Expert: constructs an IndexWriter on specific commit
point, with a custom
IndexDeletionPolicy , for
the index in d . |
IndexWriter(Directory d,
Analyzer a,
IndexWriter.MaxFieldLength mfl)
Constructs an IndexWriter for the index in
d , first creating it if it does not
already exist. |
IndexWriter(Directory d,
boolean autoCommit,
Analyzer a)
Deprecated.
This constructor will be removed in the 3.0 release.
Use
IndexWriter.IndexWriter(Directory,Analyzer,MaxFieldLength)
instead, and call IndexWriter.commit() when needed. |
IndexWriter(Directory d,
boolean autoCommit,
Analyzer a,
boolean create)
Deprecated.
This constructor will be removed in the 3.0 release.
Use
IndexWriter.IndexWriter(Directory,Analyzer,boolean,MaxFieldLength)
instead, and call IndexWriter.commit() when needed. |
IndexWriter(Directory d,
boolean autoCommit,
Analyzer a,
boolean create,
IndexDeletionPolicy deletionPolicy)
Deprecated.
This constructor will be removed in the 3.0 release.
Use
IndexWriter.IndexWriter(Directory,Analyzer,boolean,IndexDeletionPolicy,MaxFieldLength)
instead, and call IndexWriter.commit() when needed. |
IndexWriter(Directory d,
boolean autoCommit,
Analyzer a,
IndexDeletionPolicy deletionPolicy)
Deprecated.
This constructor will be removed in the 3.0 release.
Use
IndexWriter.IndexWriter(Directory,Analyzer,IndexDeletionPolicy,MaxFieldLength)
instead, and call IndexWriter.commit() when needed. |
IndexWriter(File path,
Analyzer a)
Deprecated.
This constructor will be removed in the 3.0 release.
Use
IndexWriter.IndexWriter(Directory,Analyzer,MaxFieldLength)
instead, and call IndexWriter.commit() when needed. |
IndexWriter(File path,
Analyzer a,
boolean create)
Deprecated.
This constructor will be removed in the 3.0 release.
Use
IndexWriter.IndexWriter(Directory,Analyzer,boolean,MaxFieldLength)
instead, and call IndexWriter.commit() when needed. |
IndexWriter(File path,
Analyzer a,
boolean create,
IndexWriter.MaxFieldLength mfl)
|
IndexWriter(File path,
Analyzer a,
IndexWriter.MaxFieldLength mfl)
Deprecated.
|
IndexWriter(String path,
Analyzer a)
Deprecated.
This constructor will be removed in the 3.0
release, and call
IndexWriter.commit() when needed.
Use IndexWriter.IndexWriter(Directory,Analyzer,MaxFieldLength) instead. |
IndexWriter(String path,
Analyzer a,
boolean create)
Deprecated.
This constructor will be removed in the 3.0 release.
Use
IndexWriter.IndexWriter(Directory,Analyzer,boolean,MaxFieldLength)
instead, and call IndexWriter.commit() when needed. |
IndexWriter(String path,
Analyzer a,
boolean create,
IndexWriter.MaxFieldLength mfl)
|
IndexWriter(String path,
Analyzer a,
IndexWriter.MaxFieldLength mfl)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
abstract Document |
Searcher.doc(int i) |
Document |
Searchable.doc(int i)
Returns the stored fields of document
i . |
Document |
Hits.doc(int n)
Deprecated.
Returns the stored fields of the nth document in this set.
|
Document |
IndexSearcher.doc(int i) |
Document |
MultiSearcher.doc(int n) |
Document |
Searchable.doc(int n,
FieldSelector fieldSelector)
Get the
Document at the n th position. |
Document |
IndexSearcher.doc(int i,
FieldSelector fieldSelector) |
Document |
MultiSearcher.doc(int n,
FieldSelector fieldSelector) |
String |
Hit.get(String name)
Deprecated.
Returns the string value of the field with the given name if any exist in
this document, or null.
|
float |
Hit.getBoost()
Deprecated.
Returns the boost factor for this hit on any field of the underlying document.
|
Document |
Hit.getDocument()
Deprecated.
Returns document for this hit.
|
Constructor and Description |
---|
IndexSearcher(Directory directory)
Deprecated.
Use
IndexSearcher.IndexSearcher(Directory, boolean) instead |
IndexSearcher(Directory path,
boolean readOnly)
Creates a searcher searching the index in the named
directory.
|
IndexSearcher(String path)
Deprecated.
Use
IndexSearcher.IndexSearcher(Directory, boolean) instead |
IndexSearcher(String path,
boolean readOnly)
Deprecated.
Use
IndexSearcher.IndexSearcher(Directory, boolean) instead |
Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.