com.datastax.bdp.graph.api.model

Interface PropertyIndex

All Superinterfaces:

Identified, Named

public interface PropertyIndex
extends Named, Identified

Property indexes allow quick retrieval of vertex properties with certain meta-properties associated with a particular vertex by gremlin queries.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PropertyIndex.Builder

Method Summary

Modifier and Type	Method and Description
void	drop() Drops this index.
PropertyKey	propertyKey()
java.util.Set<? extends IndexedPropertyKey>	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

vertexLabel

VertexLabel vertexLabel()

Returns:

The VertexLabel that this index is on.

propertyKey

PropertyKey propertyKey()

Returns:

The PropertyKeys by which the vertex properties of this index are indexed

propertyKeys

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

Returns:

The meta-PropertyKeys by which the edges of this index are indexed

drop

void drop()

Drops this index.