com.aliasi.dict.Dictionary Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aliasi-lingpipe Show documentation

This is the original Lingpipe: http://alias-i.com/lingpipe/web/download.html There were not made any changes to the source code.

There is a newer version: 4.1.2-JL1.0

Show newest version

/*
 * LingPipe v. 4.1.0
 * Copyright (C) 2003-2011 Alias-i
 *
 * This program is licensed under the Alias-i Royalty Free License
 * Version 1 WITHOUT ANY WARRANTY, without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the Alias-i
 * Royalty Free License Version 1 for more details.
 *
 * You should have received a copy of the Alias-i Royalty Free License
 * Version 1 along with this program; if not, visit
 * http://alias-i.com/lingpipe/licenses/lingpipe-license-1.txt or contact
 * Alias-i, Inc. at 181 North 11th Street, Suite 401, Brooklyn, NY 11211,
 * +1 (718) 290-9170.
 */

package com.aliasi.dict;

import java.util.Iterator;
import java.util.List;
import java.util.Set;

/**
 * The Dictionary interface represents a dictionary as a
 * set of entries. Dictionary entries povide a string, a category, and
 * a score.
 *
 * Equality conditions and basic access are documented in the
 * {@link Set} interface.
 *
 * @author Bob Carpenter
 * @version 4.0.0
 * @since   LingPipe2.1
 * @param  the type of entries in the dictionary
 */
public interface Dictionary extends Set> {

    /**
     * Returns an iterator over the dictionary entries with the
     * specified phrase.
     *
     * @param phrase The phrase to look up.
     * @return Iterator over the entries with the specified phrase.
     */
    public Iterator> phraseEntryIt(String phrase);

    /**
     * Returns the dictionary entries with the specified phrase.
     *
     * @param phrase The phrase to look up.
     * @return The entries with the specified phrase.
     */
    public List> phraseEntryList(String phrase);

    /**
     * Returns an iterator over the dictionary entries with the
     * specified category.
     *
     * @param category Category of entries.
     * @return Iterator over entries with specified category.
     */
    public Iterator> categoryEntryIt(C category);

    /**
     * Returns the dictionary entries with the specified category.
     *
     * @param category Category of entries.
     * @return Entries with specified category.
     */
    public List> categoryEntryList(C category);

    /**
     * Returns the size of this dictionary as measured by number
     * of dictionary entries.
     *
     * @return Size of this dictionary.
     */
    public int size();


    /**
     * Returns all of the dictionary entries for this dictionary.
     *
     * @return This dictionary's entries.
     */
    public List> entryList();

    /**
     * Adds the specified dictionary entry to the dictionary.  If an
     * implementation of Dictionary is immutable, then
     * this method may throw an unsupported operation exception.
     *
     * @param entry Dictionary entry to add.
     * @throws UnsupportedOperationException If this operation is not
     * supported by a subclass implementation.
     */
    public void addEntry(DictionaryEntry entry);

}