|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.index.IndexWriter
An IndexWriter creates and maintains an index. The third argument to the constructor determines whether a new index is created, or whether an existing index is opened for the addition of new documents. In either case, documents are added with the addDocument method. When finished adding documents, close should be called. If an index will not have more documents added for a while and optimal search performance is desired, then the optimize method should be called before the index is closed.
Field Summary | |
static String |
COMMIT_LOCK_NAME
|
static long |
COMMIT_LOCK_TIMEOUT
|
PrintStream |
infoStream
If non-null, information about merges will be printed to this. |
int |
maxFieldLength
The maximum number of terms that will be indexed for a single field in a document. |
int |
maxMergeDocs
Determines the largest number of documents ever merged by addDocument(). |
int |
mergeFactor
Determines how often segment indices are merged by addDocument(). |
int |
minMergeDocs
Determines the minimal number of documents required before the buffered in-memory documents are merging and a new Segment is created. |
static String |
WRITE_LOCK_NAME
|
static long |
WRITE_LOCK_TIMEOUT
|
Constructor Summary | |
IndexWriter(Directory d,
Analyzer a,
boolean create)
Constructs an IndexWriter for the index in d . |
|
IndexWriter(File path,
Analyzer a,
boolean create)
Constructs an IndexWriter for the index in path . |
|
IndexWriter(String path,
Analyzer a,
boolean create)
Constructs an IndexWriter for the index in path . |
Method Summary | |
void |
addDocument(Document doc)
Adds a document to this index. |
void |
addDocument(Document doc,
Analyzer analyzer)
Adds a document to this index, using the provided analyzer instead of the value of getAnalyzer() . |
void |
addIndexes(Directory[] dirs)
Merges all segments from an array of indexes into this index. |
void |
addIndexes(IndexReader[] readers)
Merges the provided indexes into this index. |
void |
close()
Flushes all changes to an index, closes all associated files, and closes the directory that the index is stored in. |
int |
docCount()
Returns the number of documents currently in this index. |
protected void |
finalize()
Release the write lock, if needed. |
Analyzer |
getAnalyzer()
Returns the analyzer used by this index. |
Similarity |
getSimilarity()
Expert: Return the Similarity implementation used by this IndexWriter. |
boolean |
getUseCompoundFile()
Setting to turn on usage of a compound file. |
void |
optimize()
Merges all segments together into a single segment, optimizing an index for search. |
void |
setSimilarity(Similarity similarity)
Expert: Set the Similarity implementation used by this IndexWriter. |
void |
setUseCompoundFile(boolean value)
Setting to turn on usage of a compound file. |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static long WRITE_LOCK_TIMEOUT
public static long COMMIT_LOCK_TIMEOUT
public static final String WRITE_LOCK_NAME
public static final String COMMIT_LOCK_NAME
public int maxFieldLength
public int mergeFactor
This must never be less than 2. The default value is 10.
public int minMergeDocs
RAMDirectory
,
large value gives faster indexing. At the same time, mergeFactor limits
the number of files open in a FSDirectory.
The default value is 10.
public int maxMergeDocs
The default value is Integer.MAX_VALUE
.
public PrintStream infoStream
Constructor Detail |
public IndexWriter(String path, Analyzer a, boolean create) throws IOException
path
. Text will
be analyzed with a
. If create
is true, then a
new, empty index will be created in path
, replacing the index
already there, if any.
public IndexWriter(File path, Analyzer a, boolean create) throws IOException
path
. Text will
be analyzed with a
. If create
is true, then a
new, empty index will be created in path
, replacing the index
already there, if any.
public IndexWriter(Directory d, Analyzer a, boolean create) throws IOException
d
. Text will be
analyzed with a
. If create
is true, then a new,
empty index will be created in d
, replacing the index already
there, if any.
Method Detail |
public boolean getUseCompoundFile()
public void setUseCompoundFile(boolean value)
public void setSimilarity(Similarity similarity)
Similarity.setDefault(Similarity)
public Similarity getSimilarity()
This defaults to the current value of Similarity.getDefault()
.
public void close() throws IOException
IOException
protected void finalize() throws IOException
IOException
public Analyzer getAnalyzer()
public int docCount()
public void addDocument(Document doc) throws IOException
maxFieldLength
terms for a given field, the remainder are
discarded.
IOException
public void addDocument(Document doc, Analyzer analyzer) throws IOException
getAnalyzer()
. If the document contains more than
maxFieldLength
terms for a given field, the remainder are
discarded.
IOException
public void optimize() throws IOException
IOException
public void addIndexes(Directory[] dirs) throws IOException
This may be used to parallelize batch indexing. A large document collection can be broken into sub-collections. Each sub-collection can be indexed in parallel, on a different thread, process or machine. The complete index can then be created by merging sub-collection indexes with this method.
After this completes, the index is optimized.
IOException
public void addIndexes(IndexReader[] readers) throws IOException
After this completes, the index is optimized.
IOException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |