<?php

namespace Box\Spout\Reader\ODS;

use Box\Spout\Reader\SheetInterface;
use Box\Spout\Reader\Wrapper\XMLReader;

/**
 * Class Sheet
 * Represents a sheet within a ODS file
 *
 * @package Box\Spout\Reader\ODS
 */
class Sheet implements SheetInterface {

	/** @var \Box\Spout\Reader\ODS\RowIterator To iterate over sheet's rows */
	protected $rowIterator;

	/** @var int ID of the sheet */
	protected $id;

	/** @var int Index of the sheet, based on order in the workbook (zero-based) */
	protected $index;

	/** @var string Name of the sheet */
	protected $name;

	/** @var bool Whether the sheet was the active one */
	protected $isActive;

	/**
	 * @param XMLReader $xmlReader XML Reader, positioned on the "<table:table>" element
	 * @param int $sheetIndex Index of the sheet, based on order in the workbook (zero-based)
	 * @param string $sheetName Name of the sheet
	 * @param bool $isSheetActive Whether the sheet was defined as active
	 * @param \Box\Spout\Reader\ODS\ReaderOptions $options Reader's current options
	 */
	public function __construct( $xmlReader, $sheetIndex, $sheetName, $isSheetActive, $options ) {
		$this->rowIterator = new RowIterator( $xmlReader, $options );
		$this->index       = $sheetIndex;
		$this->name        = $sheetName;
		$this->isActive    = $isSheetActive;
	}

	/**
	 * @api
	 * @return \Box\Spout\Reader\ODS\RowIterator
	 */
	public function getRowIterator() {
		return $this->rowIterator;
	}

	/**
	 * @api
	 * @return int Index of the sheet, based on order in the workbook (zero-based)
	 */
	public function getIndex() {
		return $this->index;
	}

	/**
	 * @api
	 * @return string Name of the sheet
	 */
	public function getName() {
		 return $this->name;
	}

	/**
	 * @api
	 * @return bool Whether the sheet was defined as active
	 */
	public function isActive() {
		return $this->isActive;
	}
}