Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-289 - added IndexReader.deleteDocument/.deleteDocuments and deprecated .delete(int)/.delete(Term). 

CHANGES.txt already mentions deprecated methods sufficiently, so nothing further to note for this change.



git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@354917 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Erik Hatcher 2005-12-08 00:22:00 +00:00
parent ad9e9bceb4
commit 331748b8c3
1 changed files with 33 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
src/java/org/apache/lucene/index/IndexReader.java
View File

@ -477,7 +477,20 @@ public abstract class IndexReader {
}
}
}
/** Deletes the document numbered <code>docNum</code>. Once a document is
* deleted it will not appear in TermDocs or TermPostitions enumerations.
* Attempts to read its field with the {@link #document}
* method will result in an error. The presence of this document may still be
* reflected in the {@link #docFreq} statistic, though
* this will be corrected eventually as the index is further modified.
*
* @deprecated Use {@link #deleteDocument(int docNum)} instead.
*/
public final synchronized void delete(int docNum) throws IOException {
deleteDocument(docNum);
}
/** Deletes the document numbered <code>docNum</code>. Once a document is
* deleted it will not appear in TermDocs or TermPostitions enumerations.
* Attempts to read its field with the {@link #document}
@ -485,18 +498,34 @@ public abstract class IndexReader {
* reflected in the {@link #docFreq} statistic, though
* this will be corrected eventually as the index is further modified.
*/
public final synchronized void delete(int docNum) throws IOException {
public final synchronized void deleteDocument(int docNum) throws IOException {
if(directoryOwner)
aquireWriteLock();
doDelete(docNum);
hasChanges = true;
}
/** Implements deletion of the document numbered <code>docNum</code>.
* Applications should call {@link #delete(int)} or {@link #delete(Term)}.
*/
protected abstract void doDelete(int docNum) throws IOException;
/** Deletes all documents containing <code>term</code>.
* This is useful if one uses a document field to hold a unique ID string for
* the document. Then to delete such a document, one merely constructs a
* term with the appropriate field and the unique ID string as its text and
* passes it to this method.
* See {@link #delete(int)} for information about when this deletion will
* become effective.
* @return the number of documents deleted
*
* @deprecated Use {@link #deleteDocuments(Term term)} instead.
*/
public final int delete(Term term) throws IOException {
return deleteDocuments(term);
}
/** Deletes all documents containing <code>term</code>.
* This is useful if one uses a document field to hold a unique ID string for
* the document. Then to delete such a document, one merely constructs a
@ -506,13 +535,13 @@ public abstract class IndexReader {
* become effective.
* @return the number of documents deleted
*/
public final int delete(Term term) throws IOException {
public final int deleteDocuments(Term term) throws IOException {
TermDocs docs = termDocs(term);
if (docs == null) return 0;
int n = 0;
try {
while (docs.next()) {
delete(docs.doc());
deleteDocument(docs.doc());
n++;
}
} finally {