/*
 * Copyright (C) 1999-2004 <a href="mailto:mandarax@jbdietrich.com">Jens Dietrich</a>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package org.mandarax.util;


import org.mandarax.kernel.Clause;
import org.mandarax.kernel.ClauseSetException;
import ws.prova.parser.ParsingException;

/**
 * Iterator for clauses. This iterator simple merges other iterators:
 * it first iterates the first iterator, then the second iterator, and so on.
 * @author <A HREF="mailto:mandarax@jbdietrich.com">Jens Dietrich</A>
 * @version 3.3.1 <9 August 2004>
 * @since 1.2
 */
public final class MergedClauseIterator extends AbstractClauseIterator {

    private ClauseIterator[] slaves     = null;
    private int              index      = 0;
    private Clause           nextClause = null;

    /**
     * Constructor.
     * @param iterators an array of clause iterators
     */
    public MergedClauseIterator(ClauseIterator[] iterators) {
        super ();

        slaves = iterators;
    }

    /**
     * Constructor.
     * @param iterators a collection of clause iterators
     */
    public MergedClauseIterator(java.util.Collection iterators) {
        super ();

        Object objs = iterators.toArray ();

        slaves = new ClauseIterator[iterators.size ()];

        System.arraycopy (objs, 0, slaves, 0, iterators.size ());
    }

    /**
     * Indicates whether there is a next clause.
     * @return boolean
     * @throws ClauseSetException
     */
    public boolean hasMoreClauses() throws ClauseSetException, ParsingException {
        nextClause = null;

        if((index < slaves.length) && (index > -1)) {
            if(slaves[index].hasMoreClauses ()) {
                nextClause = slaves[index].nextClause ();

                return true;
            } else {

                // go to next slave     
                index = index + 1;

                return hasMoreClauses ();
            }
        }

        return false;
    }

    /**
     * Return the next clause.
     * @return the next clause.
     */
    public Clause nextClause() {
        return nextClause;
    }
}
