Package org.hypergraphdb

Welcome to HyperGraphDB

See: Description

Interface Summary

Interface	Description
HGAtomCache	The HGAtomCache interface abstracts the HyperGraph caching activities in order for different caching policies and implementations to be configured and plugged.
HGBidirectionalIndex<KeyType,ValueType>	A HGBidirectionalIndex provides efficient searching of an index entry by value as well as by key.
HGGraphHolder	The interface is for atoms that need to hold a reference to the HyperGraph to which they belong.
HGHandle	A HGHandle represents a reference to a hypergraph atom.
HGHandleFactory	The HGHandleFactory is used to manage persistent handles for the atoms of HyperGraph instance.
HGHandleHolder	Implement this interface for atoms that will hold their HyperGraphDB handle as a bean property.
HGIndex<KeyType,ValueType>	The HGIndex interface represents an user-created index in the HyperGraph data structure.
HGLink	The HGLink interface defines a hypergraph link.
HGOrderedSearchable<KeyType,ValueType>	The HGOrderedSearchable interface specifies that an object can be viewed as an ordered collection from where a range of values can be obtained based on a key and comparison operator.
HGPersistentHandle	A HGPersistentHandle is a HGHandle that survives system downtime.
HGRandomAccessResult<ValueType>	A HGRandomAccessResult is a search result that is based on some kind of cursor that allows immediate positioning on some result value, if it exists.
HGSearchable<KeyType,ValueType>	The HGSearchable interface specifies that an object can be searched by a key.
HGSearchResult<T>	Represents the result set of a HyperGraph query.
HGSortIndex<KeyType,ValueType>	A HGSortIndex is a HGIndex that maintains its keys in an order relation.
HGSystemFlags	This interface defines a set of system-level atom flags that can be specified at atom addition time in order to control things like atom lifetime.
HGTypeHolder<T>	Implement this interface for atoms that will hold the instance of their HyperGraphDB type as a bean property.
HyperNode
LazyRef<T>	Encapsulate the reference of an object for loading on demand.
TwoWayIterator<T>	This interface defines a bi-directional iterator over a collection of objects.

Class Summary

Class	Description
HGAtomAttrib	A simple structure that holds system-level atom attributes.
HGConfiguration	A bean that holds configuration parameters for a HyperGraphDB initialization.
HGEnvironment	This class provides some facilities to manage several open HyperGraph databases within a single virtual machine.
HGIndexManager	The HGIndexManager allows you to create atom indices.
HGPlainLink	A default HGLink implementation provided by hypergraph.
HGQuery<SearchResult>	The HGQuery class represents an arbitrary query to the HyperGraph database.
HGQuery.hg	This class serves as a namespace to a set of syntactically concise functions for constructing HyperGraph query conditions and performing HyperGraph queries.
HGStore	An instance of HGStore is associated with each HyperGraph to manage to low-level interaction with the underlying database mechanism.
HGTypeSystem	The HGTypeSystem manages atom type information for a given HyperGraph database.
HGValueLink	HGValueLink is a HGLink that can hold an arbitrary object as payload.
HyperGraph	This is the main class representing a HyperGraph database.
IncidenceSet	Represents an atom incidence set.
IncidenceSetRef	An implementation that will lazily query for the incidence set of an atom.
ReadyRef<T>	An implementation of LazyRef that simply encapsulates an existing value.

Enum Summary

Enum	Description
HGRandomAccessResult.GotoResult	Enumerates the possible results of a call to the goTo in a HGRandomAccessResult.

Exception Summary

Exception	Description
HGEMissingData
HGException	A HGException is thrown by HyperGraph code anywhere an abnormal situation, that cannot usually be handled in an obvious way besides debugging, occurs.
HGRemoveRefusedException
HGReplaceRefusedException	This exception is thrown when an attempt to replace the value of an existing atom failed.

Package org.hypergraphdb Description

Welcome to HyperGraphDB

This package is the main entry point to the HyperGraphDB API. Most of the core interfaces for search and manipulating HyperGraph atoms are defined here.

The main class is the HyperGraph which represents a single HyperGraph database. You will need to familiarize yourself with most of the methods of that class in order to use HyperGraphDB effectively.

The full querying API can be found in the org.hypergraphdb.query package. However most of the functionality is conveniently exposed from the HGQuery.hg class.

More involved graph-based algorithms can be found in the org.hypergraph.algorithms package.