com.datastax.bdp.graph.api.model

Interface PropertyKey

All Superinterfaces:

Identified, Named

All Known Subinterfaces:

IdPropertyKey, IndexedPropertyKey

public interface PropertyKey
extends Named, Identified

Represents the definition of property key that can be used on vertex or edge labels.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PropertyKey.Builder Builder interface for properties.
static interface	PropertyKey.Validator<T> A validator is a user configurable object that restricts the valid values of a property key.

Method Summary

Modifier and Type	Method and Description
PropertyKey	addPropertyKey(java.lang.String name) Register that a particular property key may be used on properties with this property key.
Cardinality	cardinality()
ValueType	dataType()
void	drop() Drop the property key from the schema
void	dropPropertyKey(java.lang.String name) Drop registration that a particular property key may be used on properties with this particular key.
SchemaId	id() Unique identifier for this entity.
java.util.Set<? extends PropertyKey>	propertyKeys()
java.util.Optional<java.time.Duration>	ttl()
java.util.List<PropertyKey.Validator<?>>	validators()

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

name

Method Detail

id

SchemaId id()

Unique identifier for this entity.

Specified by:

id in interface Identified

Returns:

Unique id for this entity

dataType

ValueType dataType()

Returns:

The data type of the property's value.

ttl

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

Returns:

The time to live for the relation type. Once expired the relation will be automatically removed.

cardinality

Cardinality cardinality()

Returns:

The cardinality of this property key, Cardinality.Single means only one property of this key is allowed on a vertex. Cardinality.Multiple allows multiple on a vertex. Edges only support single.

propertyKeys

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

Returns:

the property keys associated with this property key.

addPropertyKey

PropertyKey addPropertyKey(java.lang.String name)

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

Parameters:

name - The property key name

dropPropertyKey

void dropPropertyKey(java.lang.String name)

Drop registration that a particular property key may be used on properties with this particular key.

Parameters:

name - The property key name

drop

void drop()

Drop the property key from the schema

validators

java.util.List<PropertyKey.Validator<?>> validators()

Returns:

Returns the list of validators associated with this property key.