org.eclipse.rdf4j.sail.lmdb.model.LmdbValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rdf4j-sail-lmdb Show documentation

Sail implementation that stores data to disk using LMDB.

There is a newer version: 5.1.0-M1

/*******************************************************************************
 * Copyright (c) 2021 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
 *******************************************************************************/
package org.eclipse.rdf4j.sail.lmdb.model;

import org.eclipse.rdf4j.model.Value;
import org.eclipse.rdf4j.sail.lmdb.ValueStoreRevision;

public interface LmdbValue extends Value {

	long UNKNOWN_ID = -1;

	/**
	 * Sets the ID that is used for this value in a specific revision of the value store.
	 */
	void setInternalID(long id, ValueStoreRevision revision);

	/**
	 * Gets the ID that is used in the lmdb store for this Value.
	 *
	 * @return The value's ID, or {@link #UNKNOWN_ID} if not yet set.
	 */
	long getInternalID();

	/**
	 * Initializes this value if it was a lazy value (ID-only value) before.
	 */
	void init();

	/**
	 * Gets the revision of the value store that created this value. The value's internal ID is only valid when it's
	 * value store revision is equal to the value store's current revision.
	 *
	 * @return The revision of the value store that created this value at the time it last set the value's internal ID.
	 */
	ValueStoreRevision getValueStoreRevision();
}