framework/main/classes/index/class_BaseIndex.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Index;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
   7 use Org\Mxchange\CoreFramework\Filesystem\File\BaseBinaryFile;
   8 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
   9 use Org\Mxchange\CoreFramework\Iterator\Filesystem\SeekableWritableFileIterator;
  10 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
  11 use Org\Mxchange\CoreFramework\Utils\String\StringUtils;
  12 use Org\Mxchange\CoreFramework\Traits\Iterator\IteratorTrait;
  13
  14 // Import SPL stuff
  15 use \SplFileInfo;
  16 use \UnexpectedValueException;
  17
  18 /**
  19  * A general index class
  20  *
  21  * @author              Roland Haeder <webmaster@ship-simu.org>
  22  * @version             0.0.0
  23  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
  24  * @license             GNU GPL 3.0 or any newer version
  25  * @link                http://www.ship-simu.org
  26  *
  27  * This program is free software: you can redistribute it and/or modify
  28  * it under the terms of the GNU General Public License as published by
  29  * the Free Software Foundation, either version 3 of the License, or
  30  * (at your option) any later version.
  31  *
  32  * This program is distributed in the hope that it will be useful,
  33  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  34  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  35  * GNU General Public License for more details.
  36  *
  37  * You should have received a copy of the GNU General Public License
  38  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  39  */
  40 abstract class BaseIndex extends BaseFrameworkSystem implements Indexable {
  41         // Load traits
  42         use IteratorTrait;
  43
  44         /**
  45          * Minimum block length
  46          */
  47         private static $minimumBlockLength = 0;
  48
  49         /**
  50          * Protected constructor
  51          *
  52          * @param       $className      Name of the class
  53          * @return      void
  54          */
  55         protected function __construct (string $className) {
  56                 // Call parent constructor
  57                 parent::__construct($className);
  58         }
  59
  60         /**
  61          * Checks if this index has been fully and properly loaded.
  62          *
  63          * @return      $isLoaded       Whether this index has been loaded
  64          */
  65         public function isIndexLoaded () {
  66                 // Trace message
  67                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-INDEX: CALLED!');
  68                 /* DEBUG-DIE: */ ApplicationEntryPoint::exitApplication(sprintf('[%s:%d]: this=%s', __METHOD__, __LINE__, print_r($this, true)));
  69         }
  70
  71 }