com.tinkerpop.blueprints.util.wrappers.wrapped

Class WrappedIndexableGraph<T extends IndexableGraph>

java.lang.Object

com.tinkerpop.blueprints.util.wrappers.wrapped.WrappedGraph<T>

com.tinkerpop.blueprints.util.wrappers.wrapped.WrappedIndexableGraph<T>

All Implemented Interfaces:

Graph, IndexableGraph, WrapperGraph<T>

public class WrappedIndexableGraph<T extends IndexableGraph>
extends WrappedGraph<T>
implements IndexableGraph, WrapperGraph<T>

Author:

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

Field Summary

Fields inherited from class com.tinkerpop.blueprints.util.wrappers.wrapped.WrappedGraph

baseGraph

Constructor Summary

Constructors

Constructor and Description
WrappedIndexableGraph(T baseIndexableGraph)

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 class com.tinkerpop.blueprints.util.wrappers.wrapped.WrappedGraph

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.tinkerpop.blueprints.Graph

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

Methods inherited from interface com.tinkerpop.blueprints.util.wrappers.WrapperGraph

getBaseGraph

Constructor Detail

WrappedIndexableGraph

public WrappedIndexableGraph(T baseIndexableGraph)

Method Detail

dropIndex

public void dropIndex(String indexName)

Description copied from interface: IndexableGraph

Remove an index associated with the graph.

Specified by:

dropIndex in interface IndexableGraph

Parameters:

indexName - the name of the index to drop

getIndices

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

Description copied from interface: IndexableGraph

Get all the indices maintained by the graph.

Specified by:

getIndices in interface IndexableGraph

Returns:

the indices associated with the graph

getIndex

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

Description copied from interface: IndexableGraph

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

Specified by:

getIndex in interface IndexableGraph

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

createIndex

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

Description copied from interface: IndexableGraph

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

Specified by:

createIndex in interface IndexableGraph

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