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 |
IndexModifier.addDocument(Document doc)
Deprecated.
Adds a document to this index.
|
void |
IndexWriter.addDocument(Document doc)
Adds a document to this index.
|
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.addDocument(Document doc,
Analyzer analyzer)
Adds a document to this index, using the provided analyzer instead of the
value of
IndexWriter.getAnalyzer() . |
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.
|
void |
IndexModifier.close()
Deprecated.
Close this index, writing all pending changes to disk.
|
void |
IndexWriter.close()
Commits all changes to an index and closes all
associated files.
|
void |
IndexWriter.close(boolean waitForMerges)
Closes the index with or without waiting for currently
running merges to finish.
|
void |
IndexWriter.commit()
Commits all pending updates (added & deleted
documents) 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.
|
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. |
int |
IndexModifier.deleteDocuments(Term term)
Deprecated.
Deletes all documents containing
term . |
void |
IndexWriter.deleteDocuments(Term term)
Deletes the document(s) containing
term . |
void |
IndexWriter.deleteDocuments(Term[] terms)
Deletes the document(s) containing any of the
terms.
|
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 |
ParallelReader.document(int n,
FieldSelector fieldSelector) |
Document |
FilterIndexReader.document(int n,
FieldSelector fieldSelector) |
Document |
MultiReader.document(int n,
FieldSelector fieldSelector) |
protected abstract void |
IndexReader.doDelete(int docNum)
Implements deletion of the document numbered
docNum . |
protected void |
ParallelReader.doDelete(int n) |
protected void |
FilterIndexReader.doDelete(int n) |
protected void |
MultiReader.doDelete(int n) |
protected abstract void |
IndexReader.doSetNorm(int doc,
java.lang.String field,
byte value)
Implements setNorm in subclass.
|
protected void |
ParallelReader.doSetNorm(int n,
java.lang.String field,
byte value) |
protected void |
FilterIndexReader.doSetNorm(int d,
java.lang.String f,
byte b) |
protected void |
MultiReader.doSetNorm(int n,
java.lang.String field,
byte value) |
protected abstract void |
IndexReader.doUndeleteAll()
Implements actual undeleteAll() in subclass.
|
protected void |
ParallelReader.doUndeleteAll() |
protected void |
FilterIndexReader.doUndeleteAll() |
protected void |
MultiReader.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. |
MergePolicy.MergeSpecification |
LogMergePolicy.findMergesToExpungeDeletes(org.apache.lucene.index.SegmentInfos segmentInfos,
IndexWriter writer)
Finds merges necessary to expunge all deletes from the
index.
|
void |
IndexModifier.flush()
Deprecated.
Make sure all changes are written to disk.
|
void |
IndexWriter.flush()
Deprecated.
please call
IndexWriter.commit() ) instead |
protected void |
IndexWriter.flush(boolean triggerMerge,
boolean flushDocStores,
boolean flushDeletes)
Flush all in-memory buffered udpates (adds and deletes)
to the Directory.
|
static long |
IndexReader.getCurrentVersion(Directory directory)
Reads version number from segments files.
|
static long |
IndexReader.getCurrentVersion(java.io.File directory)
Reads version number from segments files.
|
static long |
IndexReader.getCurrentVersion(java.lang.String directory)
Reads version number from segments files.
|
java.io.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 this IndexReader is still using the
current (i.e., most recently committed) version of the
index.
|
boolean |
ParallelReader.isCurrent()
Checks recursively if all subreaders are up to date.
|
boolean |
FilterIndexReader.isCurrent() |
boolean |
MultiReader.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(java.io.File fileDirectory)
Returns the time the index in the named directory was last modified.
|
static long |
IndexReader.lastModified(java.lang.String directory)
Returns the time the index in the named directory was last modified.
|
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)
Returns a read/write IndexReader reading the index in
the given Directory.
|
static IndexReader |
IndexReader.open(Directory directory,
boolean readOnly)
Returns a read/write or read only IndexReader reading the index in the given Directory.
|
static IndexReader |
IndexReader.open(Directory directory,
IndexDeletionPolicy deletionPolicy)
Expert: returns a read/write IndexReader reading the index in the given
Directory, with a custom
IndexDeletionPolicy . |
static IndexReader |
IndexReader.open(Directory directory,
IndexDeletionPolicy deletionPolicy,
boolean readOnly)
Expert: returns a read/write or read only IndexReader reading the index in the given
Directory, with a custom
IndexDeletionPolicy . |
static IndexReader |
IndexReader.open(java.io.File path)
Returns a read/write IndexReader reading the index in an FSDirectory in the named
path.
|
static IndexReader |
IndexReader.open(IndexCommit commit)
Expert: returns a read/write IndexReader reading the index in the given
IndexCommit . |
static IndexReader |
IndexReader.open(IndexCommit commit,
IndexDeletionPolicy deletionPolicy)
Expert: returns a read/write 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)
Expert: returns a read/write or read only IndexReader reading the index in the given
Directory, using a specific commit and with a custom
IndexDeletionPolicy . |
static IndexReader |
IndexReader.open(java.lang.String path)
Returns a read/write IndexReader reading the index in an FSDirectory in the named
path.
|
void |
IndexModifier.optimize()
Deprecated.
Merges all segments together into a single segment, optimizing an index
for search.
|
void |
IndexWriter.optimize()
Requests an "optimize" operation on an index, priming the index
for the fastest available 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.
|
IndexReader |
IndexReader.reopen()
Refreshes an IndexReader if the index has changed since this instance
was (re)opened.
|
IndexReader |
ParallelReader.reopen()
Tries to reopen the subreaders.
|
IndexReader |
MultiReader.reopen()
Tries to reopen the subreaders.
|
void |
IndexWriter.setMergeScheduler(MergeScheduler mergeScheduler)
Expert: set the merge scheduler used by this writer.
|
void |
IndexReader.setNorm(int doc,
java.lang.String field,
byte value)
Expert: Resets the normalization factor for the named field of the named
document.
|
void |
IndexReader.setNorm(int doc,
java.lang.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(java.io.File file,
Analyzer analyzer,
boolean create)
Deprecated.
Open an index with write access.
|
IndexModifier(java.lang.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,
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(java.io.File path,
Analyzer a)
Deprecated.
This constructor will be removed in the 3.0 release.
Use
IndexWriter.IndexWriter(File,Analyzer,MaxFieldLength)
instead, and call IndexWriter.commit() when needed. |
IndexWriter(java.io.File path,
Analyzer a,
boolean create)
Deprecated.
This constructor will be removed in the 3.0 release.
Use
IndexWriter.IndexWriter(File,Analyzer,boolean,MaxFieldLength)
instead, and call IndexWriter.commit() when needed. |
IndexWriter(java.io.File path,
Analyzer a,
boolean create,
IndexWriter.MaxFieldLength mfl)
Constructs an IndexWriter for the index in
path . |
IndexWriter(java.io.File path,
Analyzer a,
IndexWriter.MaxFieldLength mfl)
Constructs an IndexWriter for the index in
path , first creating it if it does not
already exist. |
IndexWriter(java.lang.String path,
Analyzer a)
Deprecated.
This constructor will be removed in the 3.0
release, and call
IndexWriter.commit() when needed.
Use IndexWriter.IndexWriter(String,Analyzer,MaxFieldLength) instead. |
IndexWriter(java.lang.String path,
Analyzer a,
boolean create)
Deprecated.
This constructor will be removed in the 3.0 release.
Use
IndexWriter.IndexWriter(String,Analyzer,boolean,MaxFieldLength)
instead, and call IndexWriter.commit() when needed. |
IndexWriter(java.lang.String path,
Analyzer a,
boolean create,
IndexWriter.MaxFieldLength mfl)
Constructs an IndexWriter for the index in
path . |
IndexWriter(java.lang.String path,
Analyzer a,
IndexWriter.MaxFieldLength mfl)
Constructs an IndexWriter for the index in
path , first creating it if it does not
already exist. |
Modifier and Type | Method and Description |
---|---|
Document |
RemoteSearchable.doc(int i) |
abstract Document |
Searcher.doc(int i) |
Document |
MultiSearcher.doc(int n) |
Document |
IndexSearcher.doc(int i) |
Document |
Searchable.doc(int i)
Expert: 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 |
RemoteSearchable.doc(int i,
FieldSelector fieldSelector) |
Document |
MultiSearcher.doc(int n,
FieldSelector fieldSelector) |
Document |
IndexSearcher.doc(int i,
FieldSelector fieldSelector) |
Document |
Searchable.doc(int n,
FieldSelector fieldSelector)
Get the
Document at the n th position. |
java.lang.String |
Hit.get(java.lang.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)
Creates a searcher searching the index in the provided directory.
|
IndexSearcher(java.lang.String path)
Creates a searcher searching the index in the named directory.
|
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.