com.thinkaurelius.titan.core.schema

Interface TitanManagement.IndexBuilder

Enclosing interface:

TitanManagement

public static interface TitanManagement.IndexBuilder

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

Method Summary

Methods

Modifier and Type	Method and Description
TitanGraphIndex	buildExternalIndex(String backingIndex) Builds an external index according to the specification against the backend index with the given name (i.e.
TitanGraphIndex	buildInternalIndex() Builds an internal index according to the specification
TitanManagement.IndexBuilder	indexKey(PropertyKey key) Adds the given key to the composite key of this index
TitanManagement.IndexBuilder	indexKey(PropertyKey key, Parameter... parameters) Adds the given key and associated parameters to the composite key of this index
TitanManagement.IndexBuilder	indexOnly(TitanSchemaType schemaType) Restricts this index to only those elements that have the provided schemaType.
TitanManagement.IndexBuilder	unique() Makes this a unique index for the configured element type, i.e.

Method Detail

indexKey

TitanManagement.IndexBuilder indexKey(PropertyKey key)

Adds the given key to the composite key of this index

Parameters:

key -

Returns:

this IndexBuilder

indexKey

TitanManagement.IndexBuilder indexKey(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

TitanManagement.IndexBuilder indexOnly(TitanSchemaType 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

TitanManagement.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

buildInternalIndex

TitanGraphIndex buildInternalIndex()

Builds an internal index according to the specification

Returns:

the created internal TitanGraphIndex

buildExternalIndex

TitanGraphIndex buildExternalIndex(String backingIndex)

Builds an external 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 external index

Returns:

the created internal TitanGraphIndex