com.tinkerpop.blueprints

Interface KeyIndexableGraph

All Superinterfaces:

Graph

All Known Implementing Classes:

IdGraph, ReadOnlyKeyIndexableGraph, TinkerGraph

public interface KeyIndexableGraph
extends Graph

A KeyIndexableGraph is a graph that supports basic index functionality around the key/value pairs of the elements of the graph. By creating key indices for a particular property key, that key is indexed on all the elements of the graph. This has ramifications for quick lookups on methods like getVertices(String, Object) and getEdges(String, Object).

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Element> void	createKeyIndex(String key, Class<T> elementClass, Parameter... indexParameters) Create an automatic indexing structure for indexing provided key for element class.
<T extends Element> void	dropKeyIndex(String key, Class<T> elementClass) Remove an automatic indexing structure associated with indexing provided key for element class.
<T extends Element> Set<String>	getIndexedKeys(Class<T> elementClass) Return all the index keys associated with a particular element class.

Methods inherited from interface com.tinkerpop.blueprints.Graph

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

Method Detail

dropKeyIndex

<T extends Element> void dropKeyIndex(String key,
                                    Class<T> elementClass)

Remove an automatic indexing structure associated with indexing provided key for element class.

Type Parameters:

T - the element class specification

Parameters:

key - the key to drop the index for

elementClass - the element class that the index is for

createKeyIndex

<T extends Element> void createKeyIndex(String key,
                                      Class<T> elementClass,
                                      Parameter... indexParameters)

Create an automatic indexing structure for indexing provided key for element class.

Type Parameters:

T - the element class specification

Parameters:

key - the key to create the index for

elementClass - the element class that the index is for

indexParameters - a collection of parameters for the underlying index implementation

getIndexedKeys

<T extends Element> Set<String> getIndexedKeys(Class<T> elementClass)

Return all the index keys associated with a particular element class.

Type Parameters:

T - the element class specification

Parameters:

elementClass - the element class that the index is for

Returns:

the indexed keys as a Set