public interface VertexLabel extends Named, Identified
| Modifier and Type | Interface and Description |
|---|---|
static interface |
VertexLabel.Builder |
| 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() |
idVertexIndex vertexIndex(java.lang.String name)
name - The name of the index.EdgeIndex edgeIndex(java.lang.String name)
name - The name of the edge indexPropertyIndex propertyIndex(java.lang.String name)
name - The name of the property index.VertexIndex.Builder buildVertexIndex(java.lang.String name)
name - The name of the index.EdgeIndex.Builder buildEdgeIndex(java.lang.String name, java.lang.String label)
name - The name of the index.label - The edge label to be indexed.EdgeIndex.Builder.add() must be called for the index to be
added.PropertyIndex.Builder buildPropertyIndex(java.lang.String name, java.lang.String propertyKey)
name - The name of the index.propertyKey - The propertyKey to be indexed.PropertyIndex.Builder.add() must be called for the index to be
added.java.util.Set<? extends VertexIndex> vertexIndices()
java.util.Set<? extends EdgeIndex> edgeIndices()
java.util.Set<? extends PropertyIndex> propertyIndices()
java.util.Set<? extends PropertyKey> propertyKeys()
java.util.Set<? extends EdgeLabel> edgeLabels()
java.util.Set<? extends IdPropertyKey> idPropertyKeys()
java.util.Optional<java.time.Duration> ttl()
java.util.Set<? extends CacheConfig> cacheConfigs()
CacheConfig cache configurations for this vertex label.void setPropertyCacheTime(java.time.Duration cacheTime)
Duration.ZERO as the argument for cacheTime disables property caching.cacheTime - The maximum time result sets can be cached locally, Duration.ZERO to disable.void setEdgeCacheTime(java.time.Duration cacheTime,
java.lang.String... edgeLabels)
edgeLabels configures the general edge cache time which applies to all edge labels.
Providing Duration.ZERO as the argument for cacheTime disables property caching.cacheTime - The maximum time result sets can be cached locally, Duration.ZERO to disable.java.util.Set<? extends Adjacency> adjacencies()
void addAdjacency(java.lang.String edgeLabel,
org.apache.tinkerpop.gremlin.structure.Direction direction,
java.lang.String adjacentVertexLabel)
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.default void addAdjacency(java.lang.String edgeLabel,
java.lang.String adjacentVertexLabel)
edgeLabel - The name of the edge labeladjacentVertexLabel - The name of adjacent vertex labelPropertyKey addPropertyKey(java.lang.String name)
name - The property key nameboolean hasStandardId()
void drop()
void dropPropertyKey(java.lang.String name)
name - The property key to drop