framework/main/interfaces/index/class_Indexable.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Index;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   7
   8 /**
   9  * An interface for Indexable classes
  10  *
  11  * @author              Roland Haeder <webmaster@ship-simu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.ship-simu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 interface Indexable extends FrameworkInterface {
  31         /**
  32          * Magic for this index
  33          */
  34         const INDEX_MAGIC = 'INDEXv0.1';
  35
  36         /**
  37          * Separator group->hash
  38          */
  39         const SEPARATOR_GROUP_HASH = 0x01;
  40
  41         /**
  42          * Separator hash->gap position
  43          */
  44         const SEPARATOR_HASH_GAP_POSITION = 0x02;
  45
  46         /**
  47          * Separator gap position->length
  48          */
  49         const SEPARATOR_GAP_LENGTH = 0x03;
  50
  51         /**
  52          * Checks whether the index has been fully loaded (and parsed)
  53          *
  54          * @return      $isLoaded       Whether the index has been loaded
  55          */
  56         function isIndexLoaded ();
  57
  58 }