com.j256.ormlite.dao.RawRowObjectMapper Maven / Gradle / Ivy

package com.j256.ormlite.dao;

import java.sql.SQLException;

import com.j256.ormlite.field.DataType;
import com.j256.ormlite.stmt.QueryBuilder;

/**
 * Parameterized row mapper that takes output from the {@link GenericRawResults} and returns a T. Is used in the
 * {@link Dao#queryRaw(String, DataType[], RawRowObjectMapper, String...)} method.
 * 
 * 
 *  NOTE:  If you need to map Strings instead then consider using the {@link RawRowMapper} with the
 * {@link Dao#queryRaw(String, RawRowMapper, String...)} method which allows you to iterate over the raw results as
 * String[].
 * 
 * 
 * @param 
 *            Type that the mapRow returns.
 * @author graywatson
 */
public interface RawRowObjectMapper {

	/**
	 * Used to convert a raw results row to an object.
	 * 
	 * 
	 * NOTE: If you are using the {@link QueryBuilder#prepareStatementString()} to build your query, it may have
	 * added the id column to the selected column list if the Dao object has an id you did not include it in the columns
	 * you selected. So the results might have one more column than you are expecting.
	 * 
	 * 
	 * @return The created object with all of the fields set from the results. Return null if there is no object
	 *         generated from these results.
	 * @param columnNames
	 *            Array of names of columns.
	 * @param dataTypes
	 *            Array of the DataTypes of each of the columns as passed into the
	 *            {@link Dao#queryRaw(String, DataType[], RawRowObjectMapper, String...)}
	 * @param resultColumns
	 *            Array of result columns.
	 * @throws SQLException
	 *             If there is any critical error with the data and you want to stop the paging.
	 */
	public T mapRow(String[] columnNames, DataType[] dataTypes, Object[] resultColumns) throws SQLException;
}