/*
 * Copyright Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags and
 * the COPYRIGHT.txt file distributed with this work.
 *
 * Licensed 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.teiid.common.buffer;

import org.teiid.core.TeiidComponentException;
import org.teiid.core.TeiidProcessingException;

public interface IndexedTupleSource extends TupleSource {

    /**
     * @return true if there are more tuples
     * @throws TeiidComponentException
     * @throws TeiidProcessingException
     */
    boolean hasNext() throws TeiidComponentException, TeiidProcessingException;

    /**
     * Save the current position that can be restored with a call to {@link #reset()}
     * @throws TeiidComponentException
     */
    void mark() throws TeiidComponentException;

    /**
     * Restore the previous mark and set the mark back to the first position.
     */
    void reset();

    /**
     * Set the tuple source position
     * @param position
     */
    void setPosition(long position);

    /**
     * Get the current position.  The position is 1 based and reports the position of the
     * tuple that will be retrieved with a call to {@link TupleSource#nextTuple()}
     * @return
     */
    long getCurrentIndex();

}
