Doug Cutting wrote:

Erik Hatcher wrote:

Well, one issue you didn't consider is changing a public method signature. I will make this change, but leave the Hashtable signature method there. I suppose we could change the signature to use a Map instead, but I believe there are some issues with doing something like this if you do not recompile your own source code against a new Lucene JAR.... so I will simply provide another signature too.


This would no longer compile with the change Kevin proposes.

To make things back-compatible we must:

1. Keep but deprectate StopFilter(Hashtable) constructor;
2. Keep but deprecate StopFilter.makeStopTable(String[]);
3. Add a new constructor: StopFilter(HashMap);
4. Add a new method: StopFilter.makeStopMap(String[]);

Does that make sense?

This patch and attachment take care of this problem...

It does make this class more complex than it needs to be... but 1/2 of the methods are deprecated.

Kevin

--

Please reply using PGP:

http://peerfear.org/pubkey.asc

NewsMonster - http://www.newsmonster.org/
Kevin A. Burton, Location - San Francisco, CA, Cell - 415.595.9965
AIM/YIM - sfburtonator, Web - http://peerfear.org/
GPG fingerprint: 5FB2 F3E2 760E 70A8 6174 D393 E84D 8D04 99F1 4412
IRC - freenode.net #infoanarchy | #p2p-hackers | #newsmonster

package org.apache.lucene.analysis;

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache Lucene" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact [EMAIL PROTECTED]
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Apache Lucene", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

import java.io.IOException;
import java.util.*;

/** Removes stop words from a token stream. */

public final class StopFilter extends TokenFilter {

  //Note: this could migrate to using a HashSet
  private HashMap map;

  /** Constructs a filter which removes words from the input
    TokenStream that are named in the array of words. */
  public StopFilter(TokenStream in, String[] stopWords) {
    super(in);
    map = makeStopMap(stopWords);
  }

  /** Constructs a filter which removes words from the input
    TokenStream that are named in the HashMap. */
  public StopFilter(TokenStream in, HashMap stopMap) {
    super(in);
    map = stopMap;
  }

  /**
   * @deprecated Use HashMap instead.
   */
  public StopFilter(TokenStream in, Hashtable stopTable) {
    super(in);
    map = new HashMap();

    Enumeration keys = stopTable.keys();
    while ( keys.hasMoreElements() ) {
        Object key = keys.nextElement();
        map.put( key, stopTable.get( key ) );
    } 

  }

  /** Builds a HashMap from an array of stop words, appropriate for passing
    into the StopFilter constructor.  This permits this table construction to
    be cached once when an Analyzer is constructed. */
  public static final HashMap makeStopMap(String[] stopWords) {
      HashMap stopMap = new HashMap(stopWords.length);

      for (int i = 0; i < stopWords.length; i++)
          stopMap.put(stopWords[i], stopWords[i]);

      return stopMap;
  }

  /**
   * 
   * @deprecated Use makeStopMap instead.
   * @see #makeStopMap
   */
  public static final Hashtable makeStopTable(String[] stopWords) {
    Hashtable stopTable = new Hashtable(stopWords.length);
    for (int i = 0; i < stopWords.length; i++)
      stopTable.put(stopWords[i], stopWords[i]);
    return stopTable;
  }
    
  /** Returns the next input Token whose termText() is not a stop word. */
  public final Token next() throws IOException {
    // return the first non-stop word found
    for (Token token = input.next(); token != null; token = input.next())
      if (map.get(token.termText) == null)
        return token;
    // reached EOS -- return null
    return null;
  }
}
--- StopFilter.orig     2004-03-09 10:48:25.061757372 -0800
+++ StopFilter.java     2004-03-09 10:56:25.581970732 -0800
@@ -55,43 +55,73 @@
  */
 
 import java.io.IOException;
-import java.util.Hashtable;
+import java.util.*;
 
 /** Removes stop words from a token stream. */
 
 public final class StopFilter extends TokenFilter {
 
-  private Hashtable table;
+  //Note: this could migrate to using a HashSet
+  private HashMap map;
 
   /** Constructs a filter which removes words from the input
     TokenStream that are named in the array of words. */
   public StopFilter(TokenStream in, String[] stopWords) {
     super(in);
-    table = makeStopTable(stopWords);
+    map = makeStopMap(stopWords);
   }
 
   /** Constructs a filter which removes words from the input
-    TokenStream that are named in the Hashtable. */
+    TokenStream that are named in the HashMap. */
+  public StopFilter(TokenStream in, HashMap stopMap) {
+    super(in);
+    map = stopMap;
+  }
+
+  /**
+   * @deprecated Use HashMap instead.
+   */
   public StopFilter(TokenStream in, Hashtable stopTable) {
     super(in);
-    table = stopTable;
+    map = new HashMap();
+
+    Enumeration keys = stopTable.keys();
+    while ( keys.hasMoreElements() ) {
+        Object key = keys.nextElement();
+        map.put( key, stopTable.get( key ) );
+    } 
+
   }
-  
-  /** Builds a Hashtable from an array of stop words, appropriate for passing
+
+  /** Builds a HashMap from an array of stop words, appropriate for passing
     into the StopFilter constructor.  This permits this table construction to
     be cached once when an Analyzer is constructed. */
+  public static final HashMap makeStopMap(String[] stopWords) {
+      HashMap stopMap = new HashMap(stopWords.length);
+
+      for (int i = 0; i < stopWords.length; i++)
+          stopMap.put(stopWords[i], stopWords[i]);
+
+      return stopMap;
+  }
+
+  /**
+   * 
+   * @deprecated Use makeStopMap instead.
+   * @see #makeStopMap
+   */
   public static final Hashtable makeStopTable(String[] stopWords) {
     Hashtable stopTable = new Hashtable(stopWords.length);
     for (int i = 0; i < stopWords.length; i++)
       stopTable.put(stopWords[i], stopWords[i]);
     return stopTable;
   }
-
+    
   /** Returns the next input Token whose termText() is not a stop word. */
   public final Token next() throws IOException {
     // return the first non-stop word found
     for (Token token = input.next(); token != null; token = input.next())
-      if (table.get(token.termText) == null)
+      if (map.get(token.termText) == null)
        return token;
     // reached EOS -- return null
     return null;
begin:vcard
fn:Kevin Burton
n:Burton;Kevin
email;internet:[EMAIL PROTECTED]
x-mozilla-html:TRUE
version:2.1
end:vcard

Attachment: signature.asc
Description: OpenPGP digital signature

Reply via email to