com.tinkerpop.blueprints.util.wrappers.readonly

Class ReadOnlyIndexableGraph<T extends IndexableGraph>

java.lang.Object

com.tinkerpop.blueprints.util.wrappers.readonly.ReadOnlyGraph<T>

com.tinkerpop.blueprints.util.wrappers.readonly.ReadOnlyIndexableGraph<T>

All Implemented Interfaces:

Graph, IndexableGraph, WrapperGraph<T>

Direct Known Subclasses:

ReadOnlyKeyIndexableGraph

public class ReadOnlyIndexableGraph<T extends IndexableGraph>
extends ReadOnlyGraph<T>
implements IndexableGraph, WrapperGraph<T>

A ReadOnlyIndexableGraph wraps an IndexableGraph and overrides the underlying graph's mutating methods. In this way, a ReadOnlyIndexableGraph can only be read from, not written to.

Author:

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

Field Summary

Fields inherited from class com.tinkerpop.blueprints.util.wrappers.readonly.ReadOnlyGraph

baseGraph

Constructor Summary

Constructors

Constructor and Description
ReadOnlyIndexableGraph(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 name) 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.readonly.ReadOnlyGraph

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

ReadOnlyIndexableGraph

public ReadOnlyIndexableGraph(T baseIndexableGraph)

Method Detail

dropIndex

public void dropIndex(String name)
               throws UnsupportedOperationException

Description copied from interface: IndexableGraph

Remove an index associated with the graph.

Specified by:

dropIndex in interface IndexableGraph

Parameters:

name - the name of the index to drop

Throws:

UnsupportedOperationException

createIndex

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

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

Throws:

UnsupportedOperationException

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

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