package edu.vt.marian.search;

import java.util.*;
import java.io.*;

import edu.vt.marian.common.*;


/**
 * WtdObjSetSequencers are constructed from a weighted set of sets
 * (actually a WtdObjSet where each object can be mapped to a further
 * WtdObjSet).  They merge all the elements of all the (mapped)
 * WtdObjSets into a single sequence in Weight order, after scaling
 * each terminal object by the weight of the "key" set.
 *
 * @author Robert France
 * @version $Id: WtdObjSetSequencer.java,v 1.2 2000/03/10 15:34:37 paul Exp $
 * @see	Sequencer
 * @see java.util.Enumeration
 */

public interface WtdObjSetSequencer extends Sequencer
{
    /**
     * Add a weighted object set of "keys" to the Sequencer.  Each key
     * can itself be developed into a "secondary" weighted object set.
     *
     * @param keySet a weighted object set, each of .
     * @param map someone who can turn each FullID in keySet into a WtdObjSet.
     * @return	ReturnValues.OK -- set was added without problems;
     * anything else -- problems.
     */
    public int addSets(WtdObjSet keySet, WtdObjToSetMapping map);
}