PartialResultExecutor.java

/*
 * 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.translator.google.api.result;

import java.util.List;


/**
 * Executable query that will retrieve just specified portion of results (rows). 
 * 
 * For example to get rows starting at row 10 and retrieves 5 rows (included) use this interface:
 *   
 *   partialResultExecutor.getResultBatch(10,5) 
 * 
 * @author fnguyen
 */
public interface PartialResultExecutor {
	
	/**
	 *  Returns part of the result.
	 *  
	 * @return null or empty list if no more results are in the batch. Maximum amount of sheet rows in the result
	 * is amount
	 */
	List<SheetRow> getResultsBatch(int startIndex, int amount);
}