package com.tropo.lucene;


/* ====================================================================
 * 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 apache@apache.org.
 *
 * 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 org.apache.lucene.search.*;
import java.io.IOException;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.index.Term;
import org.apache.commons.codec.language.*;

/** Subclass of FilteredTermEnum for enumerating all terms that are similiar to the specified filter term.

 */
public final class DoubleMetaphoneTermEnum extends FilteredTermEnum {
    private int del_len;
    boolean endEnum = false;

    Term searchTerm = null;
    String field = "";
    String text = "";
    int textlen;
	final DoubleMetaphone m = new DoubleMetaphone();
	final String goal1;
	String goal2;
	
    public DoubleMetaphoneTermEnum(IndexReader reader, Term term) throws IOException {
        super(reader, term);
        searchTerm = term;
        field = searchTerm.field();
        text = searchTerm.text();
        textlen = text.length();
		
		goal1 = m.doubleMetaphone( text, true);
		goal2 = m.doubleMetaphone( text, false);
		if ( goal1.equals( goal2)) goal2 = null;

        setEnum(reader.terms(new Term(searchTerm.field(), "")));

		

    }
    
    /**
     The termCompare method in DoubleMetaphoneTermEnum uses ...
     */
    protected final boolean termCompare(Term term) {

        if (field == term.field()) {
			String s = term.text();
			String try1 = m.doubleMetaphone( s, true);
			String try2 = m.doubleMetaphone( s, false);

			if ( try1.equals( goal1)) return true;
			if ( try2.equals( goal1)) return true;
			if ( goal2 != null)
			{
				if ( try1.equals( goal2)) return true;
				if ( try2.equals( goal2)) return true;
			}
			return false;
        }
        endEnum = true;
        return false;
    }
    
    protected final float difference() {
        return (float) 1.0;
    }
    
    public final boolean endEnum() {
        return endEnum;
    }
    
	public void close() throws IOException {
		super.close();
		searchTerm = null;
		field = null;
		text = null;
	}
}