<?php
/**
 * A general Producer class
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.ship-simu.org
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
abstract class BaseProducer extends BaseFrameworkSystem {
	/**
	 * Outgoing work-queue
	 */
	private $outgoingQueueInstance = null;

	/**
	 * Incoming raw data/items queue
	 */
	private $incomingQueueInstance = null;

	/**
	 * Protected constructor
	 *
	 * @param	$className	Name of the class
	 * @return	void
	 */
	protected function __construct ($className) {
		// Call parent constructor
		parent::__construct($className);

		// Initialize all producers
		$this->initProducer();

		// Initialize work queue (out-going, produced items)
		$this->initWorkQueue();
	}

	/**
	 * Getter for outgoing work queue
	 *
	 * @param	$outgoingQueueInstance	The outgoing work queue instance
	 */
	protected final function getOutgoingQueueInstance () {
		return $this->outgoingQueueInstance;
	}

	/**
	 * Setter for outgoing work queue
	 *
	 * @param	$outgoingQueueInstance	The outgoing work queue instance
	 * @return	void
	 */
	private final function setOutgoingQueueInstance (Stackable $outgoingQueueInstance) {
		$this->outgoingQueueInstance = $outgoingQueueInstance;
	}

	/**
	 * Getter for incoming raw data/items queue
	 *
	 * @param	$incomingQueueInstance	The incoming raw data/items queue instance
	 */
	protected final function getIncomingQueueInstance () {
		return $this->incomingQueueInstance;
	}

	/**
	 * Setter for incoming raw data/items queue
	 *
	 * @param	$incomingQueueInstance	The incoming raw data/items queue instance
	 * @return	void
	 */
	private final function setIncomingQueueInstance (Stackable $incomingQueueInstance) {
		$this->incomingQueueInstance = $incomingQueueInstance;
	}

	/**
	 * Initializes this producer, this method must be overwritten.
	 *
	 * @return	void
	 */
	abstract protected function initProducer();

	/**
	 * Initializes the work queue which is being used for outgoing, produced
	 * items.
	 *
	 * @return	void
	 */
	protected function initWorkQueue () {
		// Get an instance and set it in this producer
		$this->setOutgoingQueueInstance(ObjectFactory::createObjectByConfiguredName('producer_outgoing_queue'));

		// Init the queue
		$this->getOutgoingQueueInstance()->initStacker('outgoing_queue');

		// Get an instance and set it in this producer
		$this->setOutgoingQueueInstance(ObjectFactory::createObjectByConfiguredName('producer_incoming_queue'));

		// Init the queue
		$this->getOutgoingQueueInstance()->initStacker('incoming_queue');

		// Debug message
		$this->debugOutput('PRODUCER: All queues have been initialized.');
	}
}

// [EOF]
?>