FuzzyIndex.java

package com.miguelfonseca.completely.text.index;

import com.miguelfonseca.completely.data.ScoredObject;
import com.miguelfonseca.completely.text.match.Automaton;

import java.util.Set;

/**
 * {@link Index} with approximate key matching.
 */
public interface FuzzyIndex<V> extends Index<V>
{
    /**
     * Returns a {@link Set} of all values associated with a key fragment.
     *
     * @throws NullPointerException if {@code fragment} is null;
     */
    Set<ScoredObject<V>> getAny(String fragment);

    /**
     * Returns a {@link Set} of all values associated with a key matcher.
     *
     * @throws NullPointerException if {@code matcher} is null;
     */
    Set<ScoredObject<V>> getAny(Automaton matcher);
}