com.tinkerpop.blueprints

Interface IndexableGraph

All Superinterfaces:

Graph

All Known Implementing Classes:

EventIndexableGraph, EventTransactionalIndexableGraph, IdGraph, PartitionIndexableGraph, ReadOnlyIndexableGraph, ReadOnlyKeyIndexableGraph, TinkerGraph, WrappedIndexableGraph

public interface IndexableGraph
extends Graph

An IndexableGraph is a graph that supports the manual indexing of its elements. An index is typically some sort of tree structure that allows for the fast lookup of elements by key/value pairs. Indices have an Index object associated with them and allow the user to specify the putting and getting of elements into the index.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Element> Index<T>	createIndex(String indexName, Class<T> indexClass, Parameter... indexParameters) Generate an index with a particular name for a particular class.
void	dropIndex(String indexName) Remove an index associated with the graph.
<T extends Element> Index<T>	getIndex(String indexName, Class<T> indexClass) Get an index from the graph by its name and index class.
Iterable<Index<? extends Element>>	getIndices() Get all the indices maintained by the graph.

Methods inherited from interface com.tinkerpop.blueprints.Graph

addEdge, addVertex, getEdge, getEdges, getEdges, getFeatures, getVertex, getVertices, getVertices, query, removeEdge, removeVertex, shutdown

Method Detail

createIndex

<T extends Element> Index<T> createIndex(String indexName,
                                       Class<T> indexClass,
                                       Parameter... indexParameters)

Generate an index with a particular name for a particular class.

Type Parameters:

T - the element class that this index is indexing (can be base class)

Parameters:

indexName - the name of the manual index

indexClass - the element class that this index is indexing (can be base class)

indexParameters - a collection of parameters for the underlying index implementation

Returns:

the index created

getIndex

<T extends Element> Index<T> getIndex(String indexName,
                                    Class<T> indexClass)

Get an index from the graph by its name and index class. An index is unique up to name.

Type Parameters:

T - the class of the elements being indexed (can be base class)

Parameters:

indexName - the name of the index to retrieve

indexClass - the class of the elements being indexed (can be base class)

Returns:

the retrieved index

getIndices

Iterable<Index<? extends Element>> getIndices()

Get all the indices maintained by the graph.

Returns:

the indices associated with the graph

dropIndex

void dropIndex(String indexName)

Remove an index associated with the graph.

Parameters:

indexName - the name of the index to drop