package com.tool.main;

import java.util.List;
import java.util.Map;

public interface TTSheet2HashMap {

	/****************************************** PUBLIC ********************************************/
	/**
	 * Initiates the processing of the sheet to List<Map<String,
	 * String>>. Only rows for which all values found in the
	 * columnName2SeachValue map, will be included in the output.
	 *
	 * Considers rows within range [start, end].
	 *
	 * @param columnName2SeachValue
	 *            Map = ColumnName -> SearchValue
	 * @param start
	 * @param end
	 * @return
	 */
	List<Map<String, String>> load(Map<String, String> columnName2SeachValue, int start, int end);

	/**
	 * Initiates the processing of the sheet to List<Map<String,
	 * String>>. Only rows for which all value found in the
	 * columnName2SeachValue map, will be included in the output.
	 *
	 * Considers all rows.
	 *
	 * @param columnName2SeachValue
	 *            Map = ColumnName -> SearchValue
	 * @return
	 */
	List<Map<String, String>> load(Map<String, String> columnName2SeachValue);

	/**
	 * Initiates the processing of the sheet to List<Map<String,
	 * String>>.
	 *
	 * Loads all rows.
	 *
	 * @return
	 */
	List<Map<String, String>> load();

	/**
	 * Loads rows within range [start, end].
	 *
	 * @param start
	 * @param end
	 * @return
	 */
	List<Map<String, String>> load(int start, int end);

	/**
	 * Returns total number of rows in the sheet.
	 *
	 * @return number of rows in the sheet
	 */
	int numberOfRows();

}