Clover

Clover Coverage Report

Coverage timestamp: Fri May 9 2008 10:54:27 EST

FRAMES NO FRAMES SHOW HELP

../../../../img/srcFileCovDistChart9.png

37% of files have more coverage

Statistics for file IndexModifier.java:
Stmts:	115	LOC:	513	Total cmp:	41	Stmts/Method:	4.42
Branches:	30	NCLOC:	222	Cmp density:	0.36	Methods/Class:	26
Methods:	26			Avg method cmp:	1.58
Classes:	1

Statistics for file IndexModifier.java:
Stmts:	115	LOC:	513	Total cmp:	41	Stmts/Method:	4.42
Branches:	30	NCLOC:	222	Cmp density:	0.36	Methods/Class:	26
Methods:	26			Avg method cmp:	1.58
Classes:	1

Expand All

IndexModifier

Line # 86

Total Statements 115

Complexity 41

TOTAL Coverage 90.1%

0.9005848

Show Tests (3) Select All Deselect All
Highlight	Test Contribution	Test	Result
	0.86549705	org.apache.lucene.index.TestIndexModifier.testIndex org.apache.lucene.index.TestIndexModifier.testIndex	1 PASS
	0.4093567	org.apache.lucene.index.TestIndexModifier.testIndexWithThreads org.apache.lucene.index.TestIndexModifier.testIndexWithThreads	1 PASS
	0.33333334	org.apache.lucene.index.TestIndexModifier.testExtendedIndex org.apache.lucene.index.TestIndexModifier.testExtendedIndex	1 PASS

Collapse All

package org.apache.lucene.index;

/**

* Licensed under the Apache License, Version 2.0 (the "License");

* you may not use this file except in compliance with the License.

* You may obtain a copy of the License at

* http://www.apache.org/licenses/LICENSE-2.0

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

import org.apache.lucene.analysis.Analyzer;

import org.apache.lucene.document.Document;

import org.apache.lucene.store.Directory;

import org.apache.lucene.store.FSDirectory;

import java.io.File;

import java.io.IOException;

import java.io.PrintStream;

/**

* A class to modify an index, i.e. to delete and add documents. This

* class hides {@link IndexReader} and {@link IndexWriter} so that you

* do not need to care about implementation details such as that adding

* documents is done via IndexWriter and deletion is done via IndexReader.

* Note that you cannot create more than one <code>IndexModifier</code> object

* on the same directory at the same time.

* Example usage:

<tr>

<code>

Analyzer analyzer = new StandardAnalyzer();

// create an index in /tmp/index, overwriting an existing one:

IndexModifier indexModifier = new IndexModifier("/tmp/index", analyzer, true);

Document doc = new Document();

doc.add(new Field("id", "1", Field.Store.YES, Field.Index.UN_TOKENIZED));

doc.add(new Field("body", "a simple test", Field.Store.YES, Field.Index.TOKENIZED));

indexModifier.addDocument(doc);

int deleted = indexModifier.delete(new Term("id", "1"));

System.out.println("Deleted " + deleted + " document");

indexModifier.flush();

System.out.println(indexModifier.docCount() + " docs in index");

indexModifier.close();</code>

</td>

</tr>

</table>

</div>

* Not all methods of IndexReader and IndexWriter are offered by this

* class. If you need access to additional methods, either use those classes

* directly or implement your own class that extends <code>IndexModifier</code>.

* Although an instance of this class can be used from more than one

* thread, you will not get the best performance. You might want to use

* IndexReader and IndexWriter directly for that (but you will need to

* care about synchronization yourself then).

* While you can freely mix calls to add() and delete() using this class,

* you should batch you calls for best performance. For example, if you

* want to update 20 documents, you should first delete all those documents,

* then add all the new documents.

* @author Daniel Naber

public class IndexModifier {

protected IndexWriter indexWriter = null;

protected IndexReader indexReader = null;

protected Directory directory = null;

protected Analyzer analyzer = null;

protected boolean open = false;

// Lucene defaults:

protected PrintStream infoStream = null;

protected boolean useCompoundFile = true;

protected int maxBufferedDocs = IndexWriter.DEFAULT_MAX_BUFFERED_DOCS;

protected int maxFieldLength = IndexWriter.DEFAULT_MAX_FIELD_LENGTH;

100

protected int mergeFactor = IndexWriter.DEFAULT_MERGE_FACTOR;

101

102

/**

103

* Open an index with write access.

104

105

* @param directory the index directory

106

* @param analyzer the analyzer to use for adding new documents

107

* @param create <code>true</code> to create the index or overwrite the existing one;

108

* <code>false</code> to append to the existing index

109

110

public IndexModifier(Directory directory, Analyzer analyzer, boolean create) throws IOException {

111

init(directory, analyzer, create);

}

/**

* Open an index with write access.

116

117

* @param dirName the index directory

118

* @param analyzer the analyzer to use for adding new documents

119

* @param create <code>true</code> to create the index or overwrite the existing one;

120

* <code>false</code> to append to the existing index

121

122

public IndexModifier(String dirName, Analyzer analyzer, boolean create) throws IOException {

123

Directory dir = FSDirectory.getDirectory(dirName, create);

124

init(dir, analyzer, create);

}

/**

* Open an index with write access.

129

130

* @param file the index directory

131

* @param analyzer the analyzer to use for adding new documents

132

* @param create <code>true</code> to create the index or overwrite the existing one;

133

* <code>false</code> to append to the existing index

134

135

public IndexModifier(File file, Analyzer analyzer, boolean create) throws IOException {

136

Directory dir = FSDirectory.getDirectory(file, create);

137

init(dir, analyzer, create);

}

/**

* Initialize an IndexWriter.

142

* @throws IOException

143