]> git.mxchange.org Git - core.git/blobdiff - framework/main/interfaces/index/class_Indexable.php
Continued:
[core.git] / framework / main / interfaces / index / class_Indexable.php
index c9263284c5fd15421564fa769f1e2caabe6e3a2c..f5da8e4f45b394e830a6de363d54c709c0a17ccc 100644 (file)
@@ -10,7 +10,7 @@ use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -28,5 +28,31 @@ use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 interface Indexable extends FrameworkInterface {
+       /**
+        * Magic for this index
+        */
+       const INDEX_MAGIC = 'INDEXv0.1';
+
+       /**
+        * Separator group->hash
+        */
+       const SEPARATOR_GROUP_HASH = 0x01;
+
+       /**
+        * Separator hash->gap position
+        */
+       const SEPARATOR_HASH_GAP_POSITION = 0x02;
+
+       /**
+        * Separator gap position->length
+        */
+       const SEPARATOR_GAP_LENGTH = 0x03;
+
+       /**
+        * Checks whether the index has been fully loaded (and parsed)
+        *
+        * @return      $isLoaded       Whether the index has been loaded
+        */
+       function isIndexLoaded ();
 
 }