edu.cornell.mannlib.vitro.webapp.modules.searchEngine.SearchResultDocumentList Maven / Gradle / Ivy

/* $This file is distributed under the terms of the license in LICENSE$ */

package edu.cornell.mannlib.vitro.webapp.modules.searchEngine;

/**
 * A collection of results that are returned from a query.
 */
public interface SearchResultDocumentList extends
		Iterable {

	/**
	 * The number of documents that would satisfy the query
	 */
	long getNumFound();

	/**
	 * The number of documents that are included in this result.
	 */
	int size();

	/**
	 * Retrieve the i'th document, starting with 0.
	 *
	 * @throws ArrayIndexOutOfBoundsException
	 */
	SearchResultDocument get(int i);

}