application/hub/main/database/wrapper/class_NodeInformationDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database wrapper for node informations
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core 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 class NodeInformationDatabaseWrapper extends BaseDatabaseWrapper {
  25         // Constants for database table names
  26         const DB_TABLE_NODE_INFORMATION = 'node_data';
  27
  28         // Constants for database column names
  29         const DB_COLUMN_NODE_NR   = 'node_nr';
  30         const DB_COLUMN_NODE_ID   = 'node_id';
  31         const DB_COLUMN_NODE_TYPE = 'node_type';
  32
  33         /**
  34          * Protected constructor
  35          *
  36          * @return      void
  37          */
  38         protected function __construct() {
  39                 // Call parent constructor
  40                 parent::__construct(__CLASS__);
  41         }
  42
  43         /**
  44          * Creates an instance of this database wrapper by a provided user class
  45          *
  46          * @return      $wrapperInstance        An instance of the created wrapper class
  47          */
  48         public final static function createNodeInformationDatabaseWrapper () {
  49                 // Get a new instance
  50                 $wrapperInstance = new NodeInformationDatabaseWrapper();
  51
  52                 // Set (primary!) table name
  53                 $wrapperInstance->setTableName(self::DB_TABLE_NODE_INFORMATION);
  54
  55                 // Return the instance
  56                 return $wrapperInstance;
  57         }
  58
  59         /**
  60          * Getter for index key
  61          *
  62          * @return      $indexKey       Index key
  63          */
  64         public final function getIndexKey () {
  65                 return $this->getDatabaseInstance()->getIndexKey();
  66         }
  67
  68         /**
  69          * 'Registers' a new node id along with data provided in the node instance.
  70          * This may sound confusing but avoids double code very nicely...
  71          *
  72          * @param       $nodeInstance   A node instance
  73          * @return      void
  74          */
  75         public function registerNodeId (BaseHubNode $nodeInstance) {
  76                 // Get a dataset instance
  77                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_NODE_INFORMATION));
  78
  79                 // Set the primary key
  80                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_NODE_ID);
  81
  82                 // Add registration elements to the dataset
  83                 $nodeInstance->addElementsToDataSet($dataSetInstance);
  84
  85                 // "Insert" this request instance completely into the database
  86                 $this->getDatabaseInstance()->queryInsertDataSet($dataSetInstance);
  87         }
  88 }
  89
  90 // [EOF]
  91 ?>