You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by sh...@apache.org on 2011/11/03 08:42:10 UTC

svn commit: r1196983 - in /lucene/dev/branches/branch_3x/lucene/contrib: CHANGES.txt facet/src/java/org/apache/lucene/facet/taxonomy/directory/DirectoryTaxonomyWriter.java facet/src/test/org/apache/lucene/facet/taxonomy/directory/TestIndexClose.java

Author: shaie
Date: Thu Nov  3 07:42:10 2011
New Revision: 1196983

URL: http://svn.apache.org/viewvc?rev=1196983&view=rev
Log:
LUCENE-3556: make DirectoryTaxonomyWriter's indexWriter private

Modified:
    lucene/dev/branches/branch_3x/lucene/contrib/CHANGES.txt
    lucene/dev/branches/branch_3x/lucene/contrib/facet/src/java/org/apache/lucene/facet/taxonomy/directory/DirectoryTaxonomyWriter.java
    lucene/dev/branches/branch_3x/lucene/contrib/facet/src/test/org/apache/lucene/facet/taxonomy/directory/TestIndexClose.java

Modified: lucene/dev/branches/branch_3x/lucene/contrib/CHANGES.txt
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/lucene/contrib/CHANGES.txt?rev=1196983&r1=1196982&r2=1196983&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/lucene/contrib/CHANGES.txt (original)
+++ lucene/dev/branches/branch_3x/lucene/contrib/CHANGES.txt Thu Nov  3 07:42:10 2011
@@ -13,7 +13,10 @@ Changes in backwards compatibility polic
  * LUCENE-3508: Changed some method signatures in decompounding TokenFilters
    to make them no longer use the Token class.  (Uwe Schindler)
 
- * LUCENE-3552: Renamed LuceneTaxonomyReader/Writer to DirectoryTR/TW (Shai Erera)
+ * LUCENE-3552: Renamed LuceneTaxonomyReader/Writer to DirectoryTR/TW. (Shai Erera)
+
+ * LUCENE-3556: DirectoryTaxonomyWriter's indexWriter is now private and 
+   openIndexWriter() now returns an IndexWriter. (Shai Erera)
 
 New Features
 

Modified: lucene/dev/branches/branch_3x/lucene/contrib/facet/src/java/org/apache/lucene/facet/taxonomy/directory/DirectoryTaxonomyWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/lucene/contrib/facet/src/java/org/apache/lucene/facet/taxonomy/directory/DirectoryTaxonomyWriter.java?rev=1196983&r1=1196982&r2=1196983&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/lucene/contrib/facet/src/java/org/apache/lucene/facet/taxonomy/directory/DirectoryTaxonomyWriter.java (original)
+++ lucene/dev/branches/branch_3x/lucene/contrib/facet/src/java/org/apache/lucene/facet/taxonomy/directory/DirectoryTaxonomyWriter.java Thu Nov  3 07:42:10 2011
@@ -72,14 +72,13 @@ import org.apache.lucene.facet.taxonomy.
  * algorithm used.
  * <p>
  * This class offers some hooks for extending classes to control the
- * {@link IndexWriter} instance that is used. See {@link #openIndexWriter} and
- * {@link #closeIndexWriter()} .
+ * {@link IndexWriter} instance that is used. See {@link #openIndexWriter}.
  * 
  * @lucene.experimental
  */
 public class DirectoryTaxonomyWriter implements TaxonomyWriter {
 
-  protected IndexWriter indexWriter;
+  private IndexWriter indexWriter;
   private int nextID;
   private char delimiter = Consts.DEFAULT_DELIMITER;
   private SinglePositionTokenStream parentStream = new SinglePositionTokenStream(Consts.PAYLOAD_PARENT);
@@ -167,7 +166,7 @@ public class DirectoryTaxonomyWriter imp
   throws CorruptIndexException, LockObtainFailedException,
   IOException {
 
-    openIndexWriter(directory, openMode);
+    indexWriter = openIndexWriter(directory, openMode);
     reader = null;
 
     parentStreamField = new Field(Consts.FIELD_PAYLOADS, parentStream);
@@ -208,8 +207,7 @@ public class DirectoryTaxonomyWriter imp
    * {@link org.apache.lucene.index.IndexDeletionPolicy}, different RAM size
    * etc.<br>
    * <b>NOTE:</b> the instance this method returns will be closed upon calling
-   * to {@link #close()}. If you wish to do something different, you should
-   * override {@link #closeIndexWriter()}.
+   * to {@link #close()}.
    * 
    * @param directory
    *          the {@link Directory} on top of which an {@link IndexWriter}
@@ -217,7 +215,7 @@ public class DirectoryTaxonomyWriter imp
    * @param openMode
    *          see {@link OpenMode}
    */
-  protected void openIndexWriter(Directory directory, OpenMode openMode)
+  protected IndexWriter openIndexWriter(Directory directory, OpenMode openMode)
       throws IOException {
     // Make sure we use a MergePolicy which merges segments in-order and thus
     // keeps the doc IDs ordered as well (this is crucial for the taxonomy
@@ -225,7 +223,7 @@ public class DirectoryTaxonomyWriter imp
     IndexWriterConfig config = new IndexWriterConfig(Version.LUCENE_30,
         new KeywordAnalyzer()).setOpenMode(openMode).setMergePolicy(
         new LogByteSizeMergePolicy());
-    indexWriter = new IndexWriter(directory, config);
+    return new IndexWriter(directory, config);
   }
 
   // Currently overridden by a unit test that verifies that every index we open
@@ -274,7 +272,11 @@ public class DirectoryTaxonomyWriter imp
    * {@link Directory}.
    */
   public synchronized void close() throws CorruptIndexException, IOException {
-    closeIndexWriter();
+    if (indexWriter != null) {
+      indexWriter.close();
+      indexWriter = null;
+    }
+
     closeResources();
   }
 
@@ -308,17 +310,6 @@ public class DirectoryTaxonomyWriter imp
   }
 
   /**
-   * A hook for extending classes to control closing the {@link IndexWriter}
-   * returned by {@link #openIndexWriter}.
-   */
-  protected void closeIndexWriter() throws CorruptIndexException, IOException {
-    if (indexWriter != null) {
-      indexWriter.close();
-      indexWriter = null;
-    }
-  }
-
-  /**
    * Look up the given category in the cache and/or the on-disk storage,
    * returning the category's ordinal, or a negative number in case the
    * category does not yet exist in the taxonomy.

Modified: lucene/dev/branches/branch_3x/lucene/contrib/facet/src/test/org/apache/lucene/facet/taxonomy/directory/TestIndexClose.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/lucene/contrib/facet/src/test/org/apache/lucene/facet/taxonomy/directory/TestIndexClose.java?rev=1196983&r1=1196982&r2=1196983&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/lucene/contrib/facet/src/test/org/apache/lucene/facet/taxonomy/directory/TestIndexClose.java (original)
+++ lucene/dev/branches/branch_3x/lucene/contrib/facet/src/test/org/apache/lucene/facet/taxonomy/directory/TestIndexClose.java Thu Nov  3 07:42:10 2011
@@ -130,8 +130,8 @@ public class TestIndexClose extends Luce
         return new InstrumentedIndexReader(super.openReader()); 
       }
       @Override
-      protected void openIndexWriter (Directory directory, OpenMode openMode) throws IOException {
-        indexWriter = new InstrumentedIndexWriter(directory,
+      protected IndexWriter openIndexWriter (Directory directory, OpenMode openMode) throws IOException {
+        return new InstrumentedIndexWriter(directory,
             newIndexWriterConfig(TEST_VERSION_CURRENT, new MockAnalyzer(random, MockTokenizer.KEYWORD, false))
                 .setOpenMode(openMode));
       }