dummystoptermhandler.java

SimMetrics is a Similarity Metric Library, e.g. from edit distance s (Levenshtein, Gotoh, Jaro etc)

/**
 * SimMetrics - SimMetrics is a java library of Similarity or Distance
 * Metrics, e.g. Levenshtein Distance, that provide float based similarity
 * measures between String Data. All metrics return consistant measures
 * rather than unbounded similarity scores.
 *
 * Copyright (C) 2005 Sam Chapman - Open Source Release v1.1
 *
 * Please Feel free to contact me about this library, I would appreciate
 * knowing quickly what you wish to use it for and any criticisms/comments
 * upon the SimMetric library.
 *
 * email:       [e-mail]
 * www:         http://www.dcs.shef.ac.uk/~sam/
 * www:         http://www.dcs.shef.ac.uk/~sam/stringmetrics.html
 *
 * address:     Sam Chapman,
 *              Department of Computer Science,
 *              University of Sheffield,
 *              Sheffield,
 *              S. Yorks,
 *              S1 4DP
 *              United Kingdom,
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

package uk.ac.shef.wit.simmetrics.wordhandlers;

import uk.ac.shef.wit.simmetrics.wordhandlers.InterfaceTermHandler;

/**
 * Package: uk.ac.shef.wit.simmetrics.wordhandlers
 * Description: DummyStopTermHandler implements a dummy stop word handling function whereby no stopwords are considered.
 * Date: 19-Apr-2004
 * Time: 14:25:11
 * 
 * @author Sam Chapman <a href="http://www.dcs.shef.ac.uk/~sam/">Website</a>, <a href="mailto:[e-mail]">Email</a>.
 * @version 1.1
 */
public final class DummyStopTermHandler implements InterfaceTermHandler {

    /**
     * adds a word to the intewrface.
     * @param termToAdd the word to add
     */
    public void addWord(final String termToAdd) {
        //empty call
    }

    /**
     * displays the stopWordHandler method.
     *
     * @return the stopWordHandler method
     */
    public final String getShortDescriptionString() {
        return "DummyStopTermHandler";
    }

    /**
     * removes the given stopword from the list.
     * @param termToRemove the stopword term to remove
     */
    public void removeWord(final String termToRemove) {
        //empty call
    }

    /**
     * gets the number of stopwords in the list.
     * @return the number of stopwords in the list
     */
    public int getNumberOfWords() {
        //always zero
        return 0;
    }

    /**
     * isStopWord determines if a given term is a stop word or not.
     * @param termToTest the term to test
     * @return always returns false.
     */
    public boolean isWord(final String termToTest) {
        return false;
    }

    /**
     * gets the stopwords as a stringBuffer.
     * @return an empty StringBuffer
     */
    public StringBuffer getWordsAsBuffer() {
        return new StringBuffer();
    }
}