com.datastax.bdp.graph.api.model.system

Interface GraphBuilder

public interface GraphBuilder

Builder pattern for creating new graph instances in DSE Graph. Invoked via GraphSystem.createGraph(String) where the name of the graph instance is specified. The builder allows the user to pre-set configuration options.

Method Summary

Modifier and Type	Method and Description
DseGraph	build() Builds the graph instance and sets the configuration options.
GraphBuilder	ifNotExists() When invoked, the builder checks whether a graph of the given name exists and when it does it returns that instance rather than attempting to open a new one.
GraphBuilder	set(java.lang.String configOption, java.lang.Object value) Sets the provided value for the given configuration option on the graph instance that is created through this builder.

Method Detail

ifNotExists

GraphBuilder ifNotExists()

When invoked, the builder checks whether a graph of the given name exists and when it does it returns that instance rather than attempting to open a new one. If an existing graph is returned in build() any configuration options set through this builder are ignored. If this method is not invoked and a graph of the same name already exists, an exception is thrown.

Returns:

This builder instance

set

GraphBuilder set(java.lang.String configOption,
                 java.lang.Object value)

Sets the provided value for the given configuration option on the graph instance that is created through this builder. The option may either be an option recognized by DSE Graph or Tinkerpop.

Parameters:

configOption - The name of the option

value - The value of the option

Returns:

This builder instance

build

DseGraph build()

Builds the graph instance and sets the configuration options.

Returns:

A new or existing graph instance

Throws:

java.lang.IllegalArgumentException - If a graph of the provided name already exists and ifNotExists() has not been invoked.