/*
* JBoss, Home of Professional Open Source.
* See the COPYRIGHT.txt file distributed with this work for information
* regarding copyright ownership. Some portions may be licensed
* to Red Hat, Inc. under one or more contributor license agreements.
*
* 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.1 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., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*/
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();
}