com.datastax.bdp.graph.api.model

Interface VertexIndex.Builder

Enclosing interface:

VertexIndex

public static interface VertexIndex.Builder

Method Summary

Modifier and Type	Method and Description
VertexIndex	add()
VertexIndex.Builder	byPropertyKey(java.lang.String propertyKey) Indexes a property key using default options.
VertexIndex.Builder	byPropertyKeyAsStringAndText(java.lang.String propertyKey) Force indexing as both plain strings and analyzed text for the given property.
VertexIndex.Builder	byPropertyKeyAsText(java.lang.String propertyKey, VertexIndex.IndexOption.Text option) Only supported for VertexIndex.Type.Search indexes
VertexIndex.Builder	byPropertyKeyWithError(java.lang.String propertyKey, java.lang.Double maxDistErr, java.lang.Double distErrPct) Only supported for VertexIndex.Type.Search geo indexes
VertexIndex.Builder	ifNotExists()
default VertexIndex.Builder	materialized() Sets the VertexIndex.Type of this index to VertexIndex.Type.Materialized
default VertexIndex.Builder	search() Sets the VertexIndex.Type of this index to VertexIndex.Type.Search
default VertexIndex.Builder	secondary() Sets the VertexIndex.Type of this index to VertexIndex.Type.Secondary
VertexIndex.Builder	type(VertexIndex.Type type) Sets the VertexIndex.Type of this index.
VertexIndex.Builder	unique() This is not yet supported

Method Detail

type

VertexIndex.Builder type(VertexIndex.Type type)

Sets the VertexIndex.Type of this index. The type must be set.

Parameters:

type - The type of this index

Returns:

This builder.

search

default VertexIndex.Builder search()

Sets the VertexIndex.Type of this index to VertexIndex.Type.Search

Returns:

This builder.

See Also:

type(VertexIndex.Type)

materialized

default VertexIndex.Builder materialized()

Sets the VertexIndex.Type of this index to VertexIndex.Type.Materialized

Returns:

This builder.

See Also:

type(VertexIndex.Type)

secondary

default VertexIndex.Builder secondary()

Sets the VertexIndex.Type of this index to VertexIndex.Type.Secondary

Returns:

This builder.

See Also:

type(VertexIndex.Type)

byPropertyKey

VertexIndex.Builder byPropertyKey(java.lang.String propertyKey)

Indexes a property key using default options. On Search indexes, this method's behavior depends on whether the propertyKey is part of the vertex label's ID. If it is part of the vertex label's ID, then this method indexes the property key as a plain string, without fulltext analysis. If it is not part of the vertex label's ID, then this method indexes the property key as both a plain string and with fulltext analysis. To force the latter behavior on properties that are part of the vertex label's ID, use byPropertyKeyAsStringAndText(String) instead.

Parameters:

propertyKey - The property key by which vertices are indexed

Returns:

This builder.

byPropertyKeyAsText

VertexIndex.Builder byPropertyKeyAsText(java.lang.String propertyKey,
                                        VertexIndex.IndexOption.Text option)

Only supported for VertexIndex.Type.Search indexes

Parameters:

propertyKey - The property key by which vertices are indexed

option - The text index option for configuring the indexing mechanism.

Returns:

This builder.

byPropertyKeyAsStringAndText

VertexIndex.Builder byPropertyKeyAsStringAndText(java.lang.String propertyKey)

Force indexing as both plain strings and analyzed text for the given property. Only supported for VertexIndex.Type.Search indexes.

Parameters:

propertyKey - the property key by which vertices are indexed

Returns:

this builder

byPropertyKeyWithError

VertexIndex.Builder byPropertyKeyWithError(java.lang.String propertyKey,
                                           java.lang.Double maxDistErr,
                                           java.lang.Double distErrPct)

Only supported for VertexIndex.Type.Search geo indexes

Parameters:

propertyKey - The property key by which vertices are indexed

Returns:

ifNotExists

VertexIndex.Builder ifNotExists()

Returns:

if the vertex index already exists then just return it.

unique

VertexIndex.Builder unique()

This is not yet supported

Returns:

Indicates that the index may only return a unique result.

add

VertexIndex add()

Returns:

Add the index.