org.hypergraphdb.storage

Class StorageWithAnnotatedIncidence

java.lang.Object

org.hypergraphdb.storage.StorageWithAnnotatedIncidence

All Implemented Interfaces:

HGStoreImplementation

public class StorageWithAnnotatedIncidence
extends Object
implements HGStoreImplementation

TODO - this could be used as a wrapper for any storage implementation, a wrapper that allows incidence set indexing to be augmented with additional attributes.

Author:

borislav

Constructor Summary

Constructors

Constructor and Description
StorageWithAnnotatedIncidence(HGStoreImplementation wrapped)

Method Summary

Methods

Modifier and Type	Method and Description
void	addIncidenceLink(HGPersistentHandle handle, HGPersistentHandle newLink) And an element to the incidence set of a given atom (as identified by the handle parameter).
boolean	containsData(HGPersistentHandle handle) Return true if the data space contains data with the given handle and false otherwise.
boolean	containsLink(HGPersistentHandle handle) Return true if there is a primitive link for the given handle.
Object	getConfiguration() Each different storage mechanism provides its own configuration object with parameters that can be set before storage is initialized.
byte[]	getData(HGPersistentHandle handle) Return the data corresponding to a given handle or null if it is not found.
HGRandomAccessResult<HGPersistentHandle>	getIncidenceResultSet(HGPersistentHandle handle) Return the incidence set associate with the given handle.
long	getIncidenceSetCardinality(HGPersistentHandle handle) Return the number of elements of the incidence set for the given handle or 0 if no such set exists.
<KeyType,ValueType> HGIndex<KeyType,ValueType>	getIndex(String name) Get the HyperGraphDB index with the given name.
<KeyType,ValueType> HGIndex<KeyType,ValueType>	getIndex(String name, ByteArrayConverter<KeyType> keyConverter, ByteArrayConverter<ValueType> valueConverter, Comparator<?> comparator, boolean isBidirectional, boolean createIfNecessary) Retrieve the index with the given name, or create a new index if no index with that name exists.
HGPersistentHandle[]	getLink(HGPersistentHandle handle) Return the link corresponding to a given handle or null if it is not found.
HGTransactionFactory	getTransactionFactory() Return the transaction factory associated with this storage instance.
void	removeData(HGPersistentHandle handle) Remove the data corresponding to a given handle.
void	removeIncidenceLink(HGPersistentHandle handle, HGPersistentHandle oldLink) Remove a specifiec element from the incidence set of a given atom (as identified by the handle parameter).
void	removeIncidenceSet(HGPersistentHandle handle) Remove the incidence set associated with the given handle.
void	removeIndex(String name) Remove the index with the given name.
void	removeLink(HGPersistentHandle handle) Remove the link corresponding to a given handle.
void	shutdown() Stops the storage engine.
void	startup(HGStore store, HGConfiguration configuration) Starts the storage engine.
HGPersistentHandle	store(HGPersistentHandle handle, byte[] data) Store a raw data buffer and return its handle.
HGPersistentHandle	store(HGPersistentHandle handle, HGPersistentHandle[] link) Store a primitive link and return its handle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StorageWithAnnotatedIncidence

public StorageWithAnnotatedIncidence(HGStoreImplementation wrapped)

Method Detail

getConfiguration

public Object getConfiguration()

Description copied from interface: HGStoreImplementation

Each different storage mechanism provides its own configuration object with parameters that can be set before storage is initialized. This method returns the storage specific configuration object that must be cast to be appropriate concrete type.

Specified by:

getConfiguration in interface HGStoreImplementation

startup

public void startup(HGStore store,
           HGConfiguration configuration)

Description copied from interface: HGStoreImplementation

Starts the storage engine.

This method is invoked after storage configuration parameters have been set and its purpose is to perform complete initialization for the underlying storage layer, possibly creating a new database instance. When this method returns, the storage should be ready for use.

Specified by:

startup in interface HGStoreImplementation

shutdown

public void shutdown()

Description copied from interface: HGStoreImplementation

Stops the storage engine.

This method is invoked when the database instance is closed. It is expected to perform all necessary cleanup and closing of resources of the storage layer.

Specified by:

shutdown in interface HGStoreImplementation

getTransactionFactory

public HGTransactionFactory getTransactionFactory()

Description copied from interface: HGStoreImplementation

Return the transaction factory associated with this storage instance. Storage implementations in HyperGraphDB are expected to be transactional and support snapshot isolation semantics.

Specified by:

getTransactionFactory in interface HGStoreImplementation

store

public HGPersistentHandle store(HGPersistentHandle handle,
                       HGPersistentHandle[] link)

Description copied from interface: HGStoreImplementation

Store a primitive link and return its handle.

Specified by:

store in interface HGStoreImplementation

Parameters:

handle - The handle to use as the identifier of the link.

link - The primitive link. Neither the array nor any of its element can be null.

Returns:

The handle argument.

getLink

public HGPersistentHandle[] getLink(HGPersistentHandle handle)

Description copied from interface: HGStoreImplementation

Return the link corresponding to a given handle or null if it is not found.

Specified by:

getLink in interface HGStoreImplementation

removeLink

public void removeLink(HGPersistentHandle handle)

Description copied from interface: HGStoreImplementation

Remove the link corresponding to a given handle.

Specified by:

removeLink in interface HGStoreImplementation

containsLink

public boolean containsLink(HGPersistentHandle handle)

Description copied from interface: HGStoreImplementation

Return true if there is a primitive link for the given handle.

Specified by:

containsLink in interface HGStoreImplementation

store

public HGPersistentHandle store(HGPersistentHandle handle,
                       byte[] data)

Description copied from interface: HGStoreImplementation

Store a raw data buffer and return its handle.

Specified by:

store in interface HGStoreImplementation

Parameters:

handle - The handle to use as identifier within the data space.

data - The buffer to store. There is no limit to the size of this buffer, but it can't be null.

Returns:

The handle argument.

getData

public byte[] getData(HGPersistentHandle handle)

Description copied from interface: HGStoreImplementation

Return the data corresponding to a given handle or null if it is not found.

Specified by:

getData in interface HGStoreImplementation

removeData

public void removeData(HGPersistentHandle handle)

Description copied from interface: HGStoreImplementation

Remove the data corresponding to a given handle.

Specified by:

removeData in interface HGStoreImplementation

containsData

public boolean containsData(HGPersistentHandle handle)

Description copied from interface: HGStoreImplementation

Return true if the data space contains data with the given handle and false otherwise.

Specified by:

containsData in interface HGStoreImplementation

getIncidenceResultSet

public HGRandomAccessResult<HGPersistentHandle> getIncidenceResultSet(HGPersistentHandle handle)

Description copied from interface: HGStoreImplementation

Return the incidence set associate with the given handle. The result set should be empty if there is no incidence set for that handle.

Specified by:

getIncidenceResultSet in interface HGStoreImplementation

removeIncidenceSet

public void removeIncidenceSet(HGPersistentHandle handle)

Description copied from interface: HGStoreImplementation

Remove the incidence set associated with the given handle. Do nothing if there is no such set.

Specified by:

removeIncidenceSet in interface HGStoreImplementation

getIncidenceSetCardinality

public long getIncidenceSetCardinality(HGPersistentHandle handle)

Description copied from interface: HGStoreImplementation

Return the number of elements of the incidence set for the given handle or 0 if no such set exists.

Specified by:

getIncidenceSetCardinality in interface HGStoreImplementation

addIncidenceLink

public void addIncidenceLink(HGPersistentHandle handle,
                    HGPersistentHandle newLink)

Description copied from interface: HGStoreImplementation

And an element to the incidence set of a given atom (as identified by the handle parameter).

Specified by:

addIncidenceLink in interface HGStoreImplementation

removeIncidenceLink

public void removeIncidenceLink(HGPersistentHandle handle,
                       HGPersistentHandle oldLink)

Description copied from interface: HGStoreImplementation

Remove a specifiec element from the incidence set of a given atom (as identified by the handle parameter).

Specified by:

removeIncidenceLink in interface HGStoreImplementation

getIndex

public <KeyType,ValueType> HGIndex<KeyType,ValueType> getIndex(String name)

Description copied from interface: HGStoreImplementation

Get the HyperGraphDB index with the given name. Return null if no index with that name exists.

Specified by:

getIndex in interface HGStoreImplementation

getIndex

public <KeyType,ValueType> HGIndex<KeyType,ValueType> getIndex(String name,
                                                      ByteArrayConverter<KeyType> keyConverter,
                                                      ByteArrayConverter<ValueType> valueConverter,
                                                      Comparator<?> comparator,
                                                      boolean isBidirectional,
                                                      boolean createIfNecessary)

Description copied from interface: HGStoreImplementation

Retrieve the index with the given name, or create a new index if no index with that name exists.

Specified by:

getIndex in interface HGStoreImplementation

Parameters:

name - The name of the index. It must be unique for the storage layer.

keyConverter - Converter to byte [] for the keys in this index. Necessary when creating a new index. If null, a default converter should be used.

valueConverter - Converter to byte [] for the values in this index. Necessary when creating a new index. If null, a default converter should be used.

removeIndex

public void removeIndex(String name)

Description copied from interface: HGStoreImplementation

Remove the index with the given name. Do nothing if not such index exists.

Specified by:

removeIndex in interface HGStoreImplementation