Package org.fusesource.hawtdb.api

The HawDB client API

See: Description

Interface Summary

Interface	Description
Allocator	Handles allocation management of resources.
Index<Key,Value>	Provides Key/Value storage and retrieval.
IndexFactory<Key,Value>	The common interface to Index factories.
IndexVisitor<Key,Value>	Interface used to selectively visit the entries in a BTree.
Journal	Created by IntelliJ IDEA.
Paged	Implemented by objects which provides block io access to pages on file.
PagedAccessor<T>	Encodes objects to a page file and decodes them from a page file.
PageFile	A page file provides paged access to a physical file.
Predicate<Key>	A predicate is used to narrow down the keys that an application is interested in accessing.
Prefixer<Key>	Interface used to determine the simple prefix of two keys.
SortedIndex<Key,Value>	Provides Key/Value storage and retrieval.
Transaction	Provides transactional access to a Paged resource.
TxPageFile	Implemented by objects to provides transactional access to a page file.

Class Summary

Class	Description
AbstractStreamPagedAccessor<T>	Abstract base class for implementations of EncoderDecoder which use stream encoding/decoding.
BTreeIndexFactory<Key,Value>	This object is used to create variable magnitude b+tree indexes.
CodecPagedAccessor<T>	A EncoderDecoder which uses a Marshaller to encode/decode the values.
HashIndexFactory<Key,Value>	Uses to create Hash based storage of key/values.
MultiIndexFactory	Special purpose index factory providing APIs to create and open several indexes at a given Paged object: each index is identified by a unique name, which must be used to refer to the index itself when opening or creating it.
PageFileFactory	A factory to create PageFile objects.
Predicates	Implements commonly used Predicates like AND, OR, <, > etc.
StringPrefixer	StringPrefixer is a Prefixer implementation that works on strings.
TxPageFileFactory	A factory to create TxPageFile objects.

Enum Summary

Enum	Description
Paged.SliceType

Exception Summary

Exception	Description
IndexException	This exception is thrown by index implementation why they detect an error.
IOPagingException	Exception thrown when an IOException occurs with a a Paging operation.
OptimisticUpdateException	Thrown when transactional operation fails to apply because another transaction has already updated the values there were seem and are being updated by the current transaction.
OutOfSpaceException	Thrown when you have run out of storage space on your page file.
PagingException	The root of all exceptions thrown by all Paged object operations.

Package org.fusesource.hawtdb.api Description

The HawDB client API

As implementation interfaces harden up, they will get moved into this package.