*
* @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
*
* 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 ();
}