com.tinkerpop.blueprints

Interface Index<T extends Element>

All Known Implementing Classes:

EventIndex, IdEdgeIndex, IdVertexIndex, TinkerGraph.TinkerKeyIndex

public interface Index<T extends Element>

An Index maintains a mapping between some key/value pair and an element. An index requires that the developer explicitly put elements of the graph into the index. The key/value pair need not be specific to the element properties. There is a query method to support index lookups beyond exact matches.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Method Summary

Methods

Modifier and Type	Method and Description
long	count(String key, Object value) Get a count of elements with a particular key/value pair.
CloseableIterable<T>	get(String key, Object value) Get all elements that are indexed by the provided key/value.
Class<T>	getIndexClass() Get the class that this index is indexing.
String	getIndexName() Get the name of the index.
void	put(String key, Object value, T element) Index an element by a key and a value.
CloseableIterable<T>	query(String key, Object query) Get all the elements that are indexed by the provided key and specified query object.
void	remove(String key, Object value, T element) Remove an element indexed by a particular key/value.

Method Detail

getIndexName

String getIndexName()

Get the name of the index.

Returns:

the name of the index

getIndexClass

Class<T> getIndexClass()

Get the class that this index is indexing.

Returns:

the class this index is indexing

put

void put(String key,
       Object value,
       T element)

Index an element by a key and a value.

Parameters:

key - the key to index the element by

value - the value to index the element by

element - the element to index

get

CloseableIterable<T> get(String key,
                       Object value)

Get all elements that are indexed by the provided key/value.

Parameters:

key - the key of the indexed elements

value - the value of the indexed elements

Returns:

an iterable of elements that have a particular key/value in the index

query

CloseableIterable<T> query(String key,
                         Object query)

Get all the elements that are indexed by the provided key and specified query object. This is useful for graph implementations that support complex query capabilities. If querying is not supported, simply throw an UnsupportedOperationException.

Parameters:

key - the key of the indexed elements

query - the query object for the indexed elements' keys

Returns:

an iterable of elements that have a particular key/value in the index that match the query object

count

long count(String key,
         Object value)

Get a count of elements with a particular key/value pair. The semantics are the same as the get method.

Parameters:

key - denoting the sub-index to search

value - the value to search for

Returns:

the collection of elements that meet that criteria

remove

void remove(String key,
          Object value,
          T element)

Remove an element indexed by a particular key/value.

Parameters:

key - the key of the indexed element

value - the value of the indexed element

element - the element to remove given the key/value pair