com.thinkaurelius.titan.diskstorage.indexing

Interface IndexProvider

All Superinterfaces:

IndexInformation

public interface IndexProvider
extends IndexInformation

External index for querying. An index can contain an arbitrary number of index stores which are updated and queried separately.

Author:

Matthias Broecheler (me@matthiasb.com)

Method Summary

Methods

Modifier and Type	Method and Description
BaseTransactionConfigurable	beginTransaction(BaseTransactionConfig config) Returns a transaction handle for a new index transaction.
void	clearStorage() Clears the index and removes all entries in all stores.
void	close() Closes the index
void	mutate(Map<String,Map<String,IndexMutation>> mutations, KeyInformation.IndexRetriever informations, BaseTransaction tx) Mutates the index (adds and removes fields or entire documents)
List<String>	query(IndexQuery query, KeyInformation.IndexRetriever informations, BaseTransaction tx) Executes the given query against the index.
Iterable<RawQuery.Result<String>>	query(RawQuery query, KeyInformation.IndexRetriever informations, BaseTransaction tx) Executes the given raw query against the index
void	register(String store, String key, KeyInformation information, BaseTransaction tx) This method registers a new key for the specified index store with the given data type.

Methods inherited from interface com.thinkaurelius.titan.diskstorage.indexing.IndexInformation

supports, supports

Method Detail

register

void register(String store,
            String key,
            KeyInformation information,
            BaseTransaction tx)
              throws StorageException

This method registers a new key for the specified index store with the given data type. This allows the IndexProvider to prepare the index if necessary. It is expected that this method is first called with each new key to inform the index of the expected type before the key is used in any documents.

Parameters:

store - Index store

key - New key to register

information - Information on the key to register

tx - enclosing transaction

Throws:

StorageException

mutate

void mutate(Map<String,Map<String,IndexMutation>> mutations,
          KeyInformation.IndexRetriever informations,
          BaseTransaction tx)
            throws StorageException

Mutates the index (adds and removes fields or entire documents)

Parameters:

mutations - Updates to the index. First map contains all the mutations for each store. The inner map contains all changes for each document in an IndexMutation.

informations - Information on the keys used in the mutation accessible through KeyInformation.IndexRetriever.

tx - Enclosing transaction

Throws:

StorageException

See Also:

IndexMutation

query

List<String> query(IndexQuery query,
                 KeyInformation.IndexRetriever informations,
                 BaseTransaction tx)
                   throws StorageException

Executes the given query against the index.

Parameters:

query - Query to execute

informations - Information on the keys used in the query accessible through KeyInformation.IndexRetriever.

tx - Enclosing transaction

Returns:

The ids of all matching documents

Throws:

StorageException

See Also:

IndexQuery

query

Iterable<RawQuery.Result<String>> query(RawQuery query,
                                      KeyInformation.IndexRetriever informations,
                                      BaseTransaction tx)
                                        throws StorageException

Executes the given raw query against the index

Parameters:

query - Query to execute

informations - Information on the keys used in the query accessible through KeyInformation.IndexRetriever.

tx - Enclosing transaction

Returns:

Results objects for all matching documents (i.e. document id and score)

Throws:

StorageException

See Also:

RawQuery

beginTransaction

BaseTransactionConfigurable beginTransaction(BaseTransactionConfig config)
                                             throws StorageException

Returns a transaction handle for a new index transaction.

Returns:

New Transaction Handle

Throws:

StorageException

close

void close()
           throws StorageException

Closes the index

Throws:

StorageException

clearStorage

void clearStorage()
                  throws StorageException

Clears the index and removes all entries in all stores.

Throws:

StorageException