3 namespace Org\Mxchange\CoreFramework\Filesystem\Index;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Filesystem\File\BaseBinaryFile;
7 use Org\Mxchange\CoreFramework\Filesystem\Index\IndexableFile;
8 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
9 use Org\Mxchange\CoreFramework\Index\Stack\IndexableStack;
17 * @author Roland Haeder <webmaster@ship-simu.org>
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.ship-simu.org
23 * This program is free software: you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation, either version 3 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 class IndexFile extends BaseBinaryFile implements IndexableFile {
38 * Protected constructor
42 protected function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
48 * Creates an instance of this File class and prepares it for usage
50 * @param $fileInfoInstance An instance of a SplFileInfo class
51 * @param $indexInstance An instance of a IndexableStack class
52 * @return $indexFileInstance An instance of an IndexableFile class
54 public final static function createIndexFile (SplFileInfo $fileInfoInstance, IndexableStack $indexInstance) {
56 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('INDEX-FILE: fileInfoInstance[%s]=%s,indexInstance=%s - CALLED!', get_class($fileInfoInstance), $fileInfoInstance, $indexInstance->__toString()));
57 $indexFileInstance = new IndexFile();
59 // Set file instance here for callbacks
60 $indexFileInstance->setIndexableStackInstance($indexInstance);
62 // Expand file name with .idx
63 $indexInfoInstance = new SplFileInfo(sprintf('%s.idx', $fileInfoInstance->__toString()));
65 // Init this abstract file
66 $indexFileInstance->initFile($indexInfoInstance);
68 // Return the prepared instance
69 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('INDEX-FILE: indexFileInstance=%s - EXIT!', $indexFileInstance->__toString()));
70 return $indexFileInstance;
74 * Writes given value to the file and returns a hash and gap position for it
76 * @param $groupId Group identifier
77 * @param $value Value to be added to the stack
78 * @return $data Hash and gap position
79 * @throws UnsupportedOperationException If this method is called
81 public function writeValueToFile (string $groupId, $value) {
82 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('INDEX-FILE: groupId=' . $groupId . ',value[' . gettype($value) . ']=' . print_r($value, true));
83 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
87 * Writes given raw data to the file and returns a gap position and length
89 * @param $groupId Group identifier
90 * @param $hash Hash from encoded value
91 * @param $encoded Encoded value to be written to the file
92 * @return $data Gap position and length of the raw data
93 * @throws UnsupportedOperationException If this method is called
95 public function writeDataToFreeGap (string $groupId, string $hash, string $encoded) {
96 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('INDEX-FILE: groupId=' . $groupId . ',encoded()=' . strlen($encoded));
97 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);