com.datastax.bdp.graph.api.model

Enum IdPropertyKey.Type

java.lang.Object

java.lang.Enum<IdPropertyKey.Type>

com.datastax.bdp.graph.api.model.IdPropertyKey.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IdPropertyKey.Type>

Enclosing interface:

IdPropertyKey

public static enum IdPropertyKey.Type
extends java.lang.Enum<IdPropertyKey.Type>

The type of the property key within a vertex' id. The type determines the position of the property key within the vertex id and its locality property when placing a vertex instance in the cluster.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Clustering Property key is part of the clustering key for a vertex instance.
Partition Property key is part of the partition key for a vertex instance.
Routing Property key is part of the routing key for a vertex instance.

Method Summary

Modifier and Type	Method and Description
static IdPropertyKey.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IdPropertyKey.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Routing

public static final IdPropertyKey.Type Routing

Property key is part of the routing key for a vertex instance. NOT YET SUPPORTED!

Partition

public static final IdPropertyKey.Type Partition

Property key is part of the partition key for a vertex instance.

Clustering

public static final IdPropertyKey.Type Clustering

Property key is part of the clustering key for a vertex instance.

Method Detail

values

public static IdPropertyKey.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IdPropertyKey.Type c : IdPropertyKey.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IdPropertyKey.Type valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null