com.datastax.bdp.graph.api.model

Interface EdgeIndex

All Superinterfaces:

Identified, Named

public interface EdgeIndex
extends Named, Identified

Edge indexes allow quick retrieval of edges with certain properties associated with a particular vertex by gremlin queries.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EdgeIndex.Builder

Method Summary

Modifier and Type	Method and Description
org.apache.tinkerpop.gremlin.structure.Direction	direction()
void	drop() Drops this index.
EdgeLabel	edgeLabel()
java.util.Set<? extends PropertyKey>	propertyKeys()
VertexLabel	vertexLabel()

Methods inherited from interface com.datastax.bdp.graph.api.Named

name

Methods inherited from interface com.datastax.bdp.graph.api.Identified

id

Method Detail

propertyKeys

java.util.Set<? extends PropertyKey> propertyKeys()

Returns:

The PropertyKeys by which the edges of this index are indexed

vertexLabel

VertexLabel vertexLabel()

Returns:

The VertexLabel that this index is on.

edgeLabel

EdgeLabel edgeLabel()

Returns:

the EdgeLabel of edges that will be indexed.

direction

org.apache.tinkerpop.gremlin.structure.Direction direction()

Returns:

the direction in which edges are indexed.

drop

void drop()

Drops this index.