com.datastax.bdp.graph.api.model

Interface VertexLabel

All Superinterfaces:

Identified, Named

public interface VertexLabel
extends Named, Identified

Represents a type of vertex within the graph.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	VertexLabel.Builder

Method Summary

Modifier and Type	Method and Description
void	addAdjacency(java.lang.String edgeLabel, org.apache.tinkerpop.gremlin.structure.Direction direction, java.lang.String adjacentVertexLabel) Register that vertices with this label may be connected to another label via edge.
default void	addAdjacency(java.lang.String edgeLabel, java.lang.String adjacentVertexLabel) Add an adjacency to the vertex label in both directions
PropertyKey	addPropertyKey(java.lang.String name) Register that a particular property key may be used on vertices with this label.
java.util.Set<? extends Adjacency>	adjacencies()
EdgeIndex.Builder	buildEdgeIndex(java.lang.String name, java.lang.String label) Build an edge index for this vertex label.
PropertyIndex.Builder	buildPropertyIndex(java.lang.String name, java.lang.String propertyKey) Build a property index for this vertex label.
VertexIndex.Builder	buildVertexIndex(java.lang.String name) Build an index of this vertex label.
java.util.Set<? extends CacheConfig>	cacheConfigs() Returns all CacheConfig cache configurations for this vertex label.
void	drop() Drop the vertex label from the graph
void	dropPropertyKey(java.lang.String name) Drops the property key from this vertex label
EdgeIndex	edgeIndex(java.lang.String name)
java.util.Set<? extends EdgeIndex>	edgeIndices()
java.util.Set<? extends EdgeLabel>	edgeLabels()
boolean	hasStandardId()
java.util.Set<? extends IdPropertyKey>	idPropertyKeys()
PropertyIndex	propertyIndex(java.lang.String name)
java.util.Set<? extends PropertyIndex>	propertyIndices()
java.util.Set<? extends PropertyKey>	propertyKeys()
void	setEdgeCacheTime(java.time.Duration cacheTime, java.lang.String... edgeLabels) Configures the edge label cache time for this vertex label.
void	setPropertyCacheTime(java.time.Duration cacheTime) Configures the global property cache time for this vertex label.
java.util.Optional<java.time.Duration>	ttl()
VertexIndex	vertexIndex(java.lang.String name) Retrieve an index associated with this vertex label.
java.util.Set<? extends VertexIndex>	vertexIndices()

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

name

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

id

Method Detail

vertexIndex

VertexIndex vertexIndex(java.lang.String name)

Retrieve an index associated with this vertex label.

Parameters:

name - The name of the index.

Returns:

The index or null if no such index exists.

edgeIndex

EdgeIndex edgeIndex(java.lang.String name)

Parameters:

name - The name of the edge index

Returns:

The edge index or null if it is doesn't exist.

propertyIndex

PropertyIndex propertyIndex(java.lang.String name)

Parameters:

name - The name of the property index.

Returns:

The property index or null if it doesn't exist.

buildVertexIndex

VertexIndex.Builder buildVertexIndex(java.lang.String name)

Build an index of this vertex label.

Parameters:

name - The name of the index.

Returns:

The builder for the index. Note that add() must be called for the index to be added.

buildEdgeIndex

EdgeIndex.Builder buildEdgeIndex(java.lang.String name,
                                 java.lang.String label)

Build an edge index for this vertex label.

Parameters:

name - The name of the index.

label - The edge label to be indexed.

Returns:

The builder for the index. Note that EdgeIndex.Builder.add() must be called for the index to be added.

buildPropertyIndex

PropertyIndex.Builder buildPropertyIndex(java.lang.String name,
                                         java.lang.String propertyKey)

Build a property index for this vertex label.

Parameters:

name - The name of the index.

propertyKey - The propertyKey to be indexed.

Returns:

The builder for the index. Note that PropertyIndex.Builder.add() must be called for the index to be added.

vertexIndices

java.util.Set<? extends VertexIndex> vertexIndices()

Returns:

All the indices associated with this vertex label.

edgeIndices

java.util.Set<? extends EdgeIndex> edgeIndices()

Returns:

All the indices associated with this vertex label.

propertyIndices

java.util.Set<? extends PropertyIndex> propertyIndices()

Returns:

All the indices associated with this relation type.

propertyKeys

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

Returns:

the property keys associated with this vertex label.

edgeLabels

java.util.Set<? extends EdgeLabel> edgeLabels()

Returns:

All the edge labels that are associated with this vertex label.

idPropertyKeys

java.util.Set<? extends IdPropertyKey> idPropertyKeys()

Returns:

The columns that are used to make up the ID.

ttl

java.util.Optional<java.time.Duration> ttl()

Returns:

The time to live of vertices of this type.

cacheConfigs

java.util.Set<? extends CacheConfig> cacheConfigs()

Returns all CacheConfig cache configurations for this vertex label.

Returns:

setPropertyCacheTime

void setPropertyCacheTime(java.time.Duration cacheTime)

Configures the global property cache time for this vertex label. The given duration configures the maximum time that property result sets may be cached locally. Providing Duration.ZERO as the argument for cacheTime disables property caching.

Parameters:

cacheTime - The maximum time result sets can be cached locally, Duration.ZERO to disable.

setEdgeCacheTime

void setEdgeCacheTime(java.time.Duration cacheTime,
                      java.lang.String... edgeLabels)

Configures the edge label cache time for this vertex label. The given duration configures the maximum time that adjacency result sets for these edge labels may be cached locally. Providing no argument for edgeLabels configures the general edge cache time which applies to all edge labels. Providing Duration.ZERO as the argument for cacheTime disables property caching.

Parameters:

cacheTime - The maximum time result sets can be cached locally, Duration.ZERO to disable.

adjacencies

java.util.Set<? extends Adjacency> adjacencies()

Returns:

The set of known adjacencies to this vertex label.

addAdjacency

void addAdjacency(java.lang.String edgeLabel,
                  org.apache.tinkerpop.gremlin.structure.Direction direction,
                  java.lang.String adjacentVertexLabel)

Register that vertices with this label may be connected to another label via edge.

Parameters:

edgeLabel - The edge label to register.

direction - The direction of use, IN, OUT or BOTH.

adjacentVertexLabel - The adjacent label on the other end of the edge.

addAdjacency

default void addAdjacency(java.lang.String edgeLabel,
                          java.lang.String adjacentVertexLabel)

Add an adjacency to the vertex label in both directions

Parameters:

edgeLabel - The name of the edge label

adjacentVertexLabel - The name of adjacent vertex label

addPropertyKey

PropertyKey addPropertyKey(java.lang.String name)

Register that a particular property key may be used on vertices with this label.

Parameters:

name - The property key name

hasStandardId

boolean hasStandardId()

Returns:

Whether this vertex label uses standard ids

drop

void drop()

Drop the vertex label from the graph

dropPropertyKey

void dropPropertyKey(java.lang.String name)

Drops the property key from this vertex label

Parameters:

name - The property key to drop