org.apache.lucene.search.spell.Dictionary Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lucene-suggest Show documentation

Apache Lucene (module: suggest)

There is a newer version: 10.0.0

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.lucene.search.spell;

import java.io.IOException;
import org.apache.lucene.search.suggest.InputIterator;

/**
 * A simple interface representing a Dictionary. A Dictionary here is a list of entries, where every
 * entry consists of term, weight and payload.
 */
public interface Dictionary {

  /**
   * Returns an iterator over all the entries
   *
   * @return Iterator
   */
  InputIterator getEntryIterator() throws IOException;
}