application/hub/main/producer/class_BaseProducer.php

   1 <?php
   2 /**
   3  * A general Producer class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 abstract class BaseProducer extends BaseFrameworkSystem {
  25         /**
  26          * Out-going work-queue
  27          */
  28         private $outgoingQueueInstance = null;
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @param       $className      Name of the class
  34          * @return      void
  35          */
  36         protected function __construct ($className) {
  37                 // Call parent constructor
  38                 parent::__construct($className);
  39
  40                 // Initialize all producers
  41                 $this->initProducer();
  42
  43                 // Initialize work queue (out-going, produced items)
  44                 $this->initWorkQueue();
  45         }
  46
  47         /**
  48          * Setter for out-going work queue
  49          *
  50          * @param       $outgoingQueueInstance  The out-going work queue instance
  51          * @return      void
  52          */
  53         private function setOutgoingQueueInstance (Stackable $outgoingQueueInstance) {
  54                 $this->outgoingQueueInstance = $outgoingQueueInstance;
  55         }
  56
  57         /**
  58          * Getter for out-going work queue
  59          *
  60          * @param       $outgoingQueueInstance  The out-going work queue instance
  61          */
  62         protected function getOutgoingQueueInstance () {
  63                 return $this->outgoingQueueInstance;
  64         }
  65
  66         /**
  67          * Initializes this producer, this method must be overwritten.
  68          *
  69          * @return      void
  70          */
  71         abstract protected function initProducer();
  72
  73         /**
  74          * Initializes the work queue which is being used for out-going, produced
  75          * items.
  76          *
  77          * @return      void
  78          */
  79         protected function initWorkQueue () {
  80                 // Get an instance and set it in this producer
  81                 $this->setOutgoingQueueInstance(ObjectFactory::createObjectByConfiguredName('producer_outgoing_work_queue'));
  82
  83                 // Init the queue
  84                 $this->getOutgoingQueueInstance()->initStacker('work_queue');
  85
  86                 // Debug message
  87                 $this->debugOutput('PRODUCER: Out-going work queue initialized.');
  88         }
  89 }
  90
  91 // [EOF]
  92 ?>