Hunt.DocTable

The document table interface.

Documentation

class DocumentWrapper (DValue i) => DocTable i where

The document table type class which needs to be implemented to be used by the Interpreter. The type parameter i is the implementation. The implementation must have a value type parameter.

Minimal complete definition

null, size, lookup, lookupByURI, union, disjoint, insert, update, delete, difference, map, filter, toMap, empty

Associated Types

type DValue i :: *

The value type of the document table.

Methods

null :: Monad m => i -> m Bool

Test whether the document table is empty.

size :: Monad m => i -> m Int

Returns the number of unique documents in the table.

lookup :: Monad m => DocId -> i -> m (Maybe (DValue i))

Lookup a document by its ID.

lookupByURI :: Monad m => URI -> i -> m (Maybe DocId)

Lookup the DocId of a document by an URI.

union :: Monad m => i -> i -> m i

Union of two disjoint document tables. It is assumed, that the DocIds and the document URIs of both indexes are disjoint.

disjoint :: Monad m => i -> i -> m Bool

Test whether the DocIds of both tables are disjoint.

insert :: Monad m => DValue i -> i -> m (DocId, i)

Insert a document into the table. Returns a tuple of the DocId for that document and the new table. If a document with the same URI is already present, its id will be returned and the table is returned unchanged.

update :: Monad m => DocId -> DValue i -> i -> m i

Update a document with a certain DocId.

adjust :: Monad m => (DValue i -> m (DValue i)) -> DocId -> i -> m i

Update a document by DocId with the result of the provided function.

adjustByURI :: Monad m => (DValue i -> m (DValue i)) -> URI -> i -> m i

Update a document by URI with the result of the provided function.

delete :: Monad m => DocId -> i -> m i

Removes the document with the specified DocId from the table.

deleteByURI :: Monad m => URI -> i -> m i

Removes the document with the specified URI from the table.

difference :: Monad m => DocIdSet -> i -> m i

Deletes a set of documents by DocId from the table.

differenceByURI :: Monad m => Set URI -> i -> m i

Deletes a set of documents by URI from the table.

map :: Monad m => (DValue i -> DValue i) -> i -> m i

Map a function over all values of the document table.

filter :: Monad m => (DValue i -> Bool) -> i -> m i

Filters all documents that satisfy the predicate.

toMap :: Monad m => i -> m (DocIdMap (DValue i))

Convert document table to a DocIdMap.

empty :: i

Empty DocTable.

Instances

DocumentWrapper e => DocTable (Documents e)

restrict :: (Functor m, Monad m, Applicative m, DocTable i) => DocIdSet -> i -> m i

toJSON'DocTable :: (Functor m, Monad m, Applicative m, DocTable i) => i -> m Value

JSON dump of the document table.

fromJSON'DocTable :: (Functor m, Monad m, Applicative m, DocTable i) => Value -> m i

JSON import of the document table.