org.eclipse.rdf4j.rio.hdt.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rdf4j-rio-hdt Show documentation

Experimental Rio parser and writer implementation for the HDT file format.

There is a newer version: 5.1.0

/*******************************************************************************
 * Copyright (c) 2020 Eclipse RDF4J contributors.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Distribution License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *******************************************************************************/
/**
 * Parser/writer for the HDT v1.0 format.
 *
 * Unfortunately the draft specification is not entirely clear and probably slightly out of date, since the open source
 * reference implementation HDT-It seems to implement a slightly different version. This parser tries to be compatible
 * with HDT-It 1.0.
 *
 * File structure:
 *
 *  * +---------------------+
 * | Global              |
 * | Header              |
 * | Dictionary (Shared) |
 * | Dictionary (S)      |
 * | Dictionary (P)      |
 * | Dictionary (O)      |
 * | Triples             |
 * +---------------------+
 * 
 *
 * General structure for Global, Header, Dictionary and Triples
 *
 * These part all starts with $HDT, followed by a byte indicating the type of the part, the format, and
 * optionally one or more key=value; properties.
 *
 * Then a NULL byte, followed by the 16-bit CRC ($HDT and NULL included)
 *
 *  * +------+------+--------+------+------------+------+-------+
 * | $HDT | type | format | NULL | key=value; | NULL | CRC16 |
 * +------+------+--------+------+------------+------+-------+
 * 
 *
 * The format varies slightly: depending on the section, it can either be a string or a URI.
 *
 */
package org.eclipse.rdf4j.rio.hdt;