/*
 * Legal Notice
 *
 * This document and associated source code (the "Work") is a part of a
 * benchmark specification maintained by the TPC.
 *
 * The TPC reserves all right, title, and interest to the Work as provided
 * under U.S. and international laws, including without limitation all patent
 * and trademark rights therein.
 *
 * No Warranty
 *
 * 1.1 TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE INFORMATION
 *     CONTAINED HEREIN IS PROVIDED "AS IS" AND WITH ALL FAULTS, AND THE
 *     AUTHORS AND DEVELOPERS OF THE WORK HEREBY DISCLAIM ALL OTHER
 *     WARRANTIES AND CONDITIONS, EITHER EXPRESS, IMPLIED OR STATUTORY,
 *     INCLUDING, BUT NOT LIMITED TO, ANY (IF ANY) IMPLIED WARRANTIES,
 *     DUTIES OR CONDITIONS OF MERCHANTABILITY, OF FITNESS FOR A PARTICULAR
 *     PURPOSE, OF ACCURACY OR COMPLETENESS OF RESPONSES, OF RESULTS, OF
 *     WORKMANLIKE EFFORT, OF LACK OF VIRUSES, AND OF LACK OF NEGLIGENCE.
 *     ALSO, THERE IS NO WARRANTY OR CONDITION OF TITLE, QUIET ENJOYMENT,
 *     QUIET POSSESSION, CORRESPONDENCE TO DESCRIPTION OR NON-INFRINGEMENT
 *     WITH REGARD TO THE WORK.
 * 1.2 IN NO EVENT WILL ANY AUTHOR OR DEVELOPER OF THE WORK BE LIABLE TO
 *     ANY OTHER PARTY FOR ANY DAMAGES, INCLUDING BUT NOT LIMITED TO THE
 *     COST OF PROCURING SUBSTITUTE GOODS OR SERVICES, LOST PROFITS, LOSS
 *     OF USE, LOSS OF DATA, OR ANY INCIDENTAL, CONSEQUENTIAL, DIRECT,
 *     INDIRECT, OR SPECIAL DAMAGES WHETHER UNDER CONTRACT, TORT, WARRANTY,
 *     OR OTHERWISE, ARISING IN ANY WAY OUT OF THIS OR ANY OTHER AGREEMENT
 *     RELATING TO THE WORK, WHETHER OR NOT SUCH AUTHOR OR DEVELOPER HAD
 *     ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.
 *
 * Contributors
 * - Doug Johnson
 */

/*
 *   Class representing the Fixed table.
 */
#ifndef FIXED_TABLE_H
#define FIXED_TABLE_H

namespace TPCE {

template <class DataFileT, class TableRowT> class FixedTable {
protected:
	const DataFileT &df;
	TableRowT tableRow;
	int recordIdx;

public:
	FixedTable(const DataFileT &dataFile) : df(dataFile), tableRow(), recordIdx(-1) {
	}

	virtual ~FixedTable() {
	}

	/*
	 *   Generates all fields for the next record.
	 *   Template Method Pattern used to accommodate
	 *   subtle variations in underlying data files
	 *   (i.e. DataFile vs. WeightedDataFile).
	 */
	bool GenerateNextRecord() {
		// Don't increment past size().
		if (MaxRecordIdx() != recordIdx) {
			++recordIdx;
		}

		// See if we just went past the end.
		if (MaxRecordIdx() == recordIdx) {
			return false;
		}

		LoadTableRow();

		// We have a valid record.
		return true;
	}

	virtual unsigned int MaxRecordIdx() const {
		return df.size();
	}

	const TableRowT &GetRow() const {
		return tableRow;
	}

	virtual void LoadTableRow() = 0;
};

} // namespace TPCE
#endif // FIXED_TABLE_H