org.janusgraph.core.schema

Interface JanusGraphManagement.IndexBuilder

Enclosing interface:

JanusGraphManagement

public static interface JanusGraphManagement.IndexBuilder

Builder for JanusGraphIndex. Allows for the configuration of a graph index prior to its construction.

Method Summary

Modifier and Type	Method and Description
JanusGraphManagement.IndexBuilder	addKey(PropertyKey key) Adds the given key to the composite key of this index
JanusGraphManagement.IndexBuilder	addKey(PropertyKey key, Parameter... parameters) Adds the given key and associated parameters to the composite key of this index
JanusGraphIndex	buildCompositeIndex() Builds a composite index according to the specification
JanusGraphIndex	buildMixedIndex(String backingIndex) Builds a mixed index according to the specification against the backend index with the given name (i.e.
JanusGraphManagement.IndexBuilder	indexOnly(JanusGraphSchemaType schemaType) Restricts this index to only those elements that have the provided schemaType.
JanusGraphManagement.IndexBuilder	unique() Makes this a unique index for the configured element type, i.e.

Method Detail

addKey

JanusGraphManagement.IndexBuilder addKey(PropertyKey key)

Adds the given key to the composite key of this index

Parameters:

key -

Returns:

this IndexBuilder

addKey

JanusGraphManagement.IndexBuilder addKey(PropertyKey key,
                                         Parameter... parameters)

Adds the given key and associated parameters to the composite key of this index

Parameters:

key -

parameters -

Returns:

this IndexBuilder

indexOnly

JanusGraphManagement.IndexBuilder indexOnly(JanusGraphSchemaType schemaType)

Restricts this index to only those elements that have the provided schemaType. If this graph index indexes vertices, then the argument is expected to be a vertex label and only vertices with that label will be indexed. Likewise, for edges and properties only those with the matching relation type will be indexed.

Parameters:

schemaType -

Returns:

this IndexBuilder

unique

JanusGraphManagement.IndexBuilder unique()

Makes this a unique index for the configured element type, i.e. an index key can be associated with at most one element in the graph.

Returns:

this IndexBuilder

buildCompositeIndex

JanusGraphIndex buildCompositeIndex()

Builds a composite index according to the specification

Returns:

the created composite JanusGraphIndex

buildMixedIndex

JanusGraphIndex buildMixedIndex(String backingIndex)

Builds a mixed index according to the specification against the backend index with the given name (i.e. the name under which that index is configured in the graph configuration)

Parameters:

backingIndex - the name of the mixed index

Returns:

the created mixed JanusGraphIndex