com.datastax.dse.driver.api.core.graph

Class ScriptGraphStatementBuilder

java.lang.Object

com.datastax.dse.driver.api.core.graph.GraphStatementBuilderBase<ScriptGraphStatementBuilder,ScriptGraphStatement>

com.datastax.dse.driver.api.core.graph.ScriptGraphStatementBuilder

@NotThreadSafe
public class ScriptGraphStatementBuilder
extends GraphStatementBuilderBase<ScriptGraphStatementBuilder,ScriptGraphStatement>

A builder to create a script graph statement.

This class is mutable and not thread-safe.

Field Summary

Fields inherited from class com.datastax.dse.driver.api.core.graph.GraphStatementBuilderBase

consistencyLevel, executionProfile, executionProfileName, graphName, isIdempotent, node, readConsistencyLevel, subProtocol, timeout, timestamp, traversalSource, writeConsistencyLevel

Constructor Summary

Constructors

Constructor and Description
ScriptGraphStatementBuilder()
ScriptGraphStatementBuilder(ScriptGraphStatement template)
ScriptGraphStatementBuilder(String script)

Method Summary

Modifier and Type	Method and Description
ScriptGraphStatement	build() Create the statement with the configuration defined by this builder object.
ScriptGraphStatementBuilder	clearQueryParams() Clears all the parameters previously added to this builder.
ScriptGraphStatementBuilder	removeQueryParam(String name) Removes a parameter.
ScriptGraphStatementBuilder	setQueryParam(String name, Object value) Set a value for a parameter defined in the script query.
ScriptGraphStatementBuilder	setQueryParams(Map<String,Object> params) Set multiple values for named parameters defined in the script query.
ScriptGraphStatementBuilder	setScript(String script)
ScriptGraphStatementBuilder	setSystemQuery(Boolean isSystemQuery)

Methods inherited from class com.datastax.dse.driver.api.core.graph.GraphStatementBuilderBase

addCustomPayload, buildCustomPayload, clearCustomPayload, setConsistencyLevel, setExecutionProfile, setExecutionProfileName, setGraphName, setIdempotence, setNode, setReadConsistencyLevel, setSubProtocol, setTimeout, setTimestamp, setTraversalSource, setWriteConsistencyLevel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptGraphStatementBuilder

public ScriptGraphStatementBuilder()

ScriptGraphStatementBuilder

public ScriptGraphStatementBuilder(String script)

ScriptGraphStatementBuilder

public ScriptGraphStatementBuilder(ScriptGraphStatement template)

Method Detail

setScript

@NonNull
public ScriptGraphStatementBuilder setScript(@NonNull
                                                      String script)

setSystemQuery

@NonNull
public ScriptGraphStatementBuilder setSystemQuery(@Nullable
                                                           Boolean isSystemQuery)

See Also:

ScriptGraphStatement.isSystemQuery()

setQueryParam

@NonNull
public ScriptGraphStatementBuilder setQueryParam(@NonNull
                                                          String name,
                                                          @Nullable
                                                          Object value)

Set a value for a parameter defined in the script query.

See Also:

ScriptGraphStatement.setQueryParam(String, Object)

setQueryParams

@NonNull
public ScriptGraphStatementBuilder setQueryParams(@NonNull
                                                           Map<String,Object> params)

Set multiple values for named parameters defined in the script query.

See Also:

ScriptGraphStatement.setQueryParam(String, Object)

removeQueryParam

@NonNull
public ScriptGraphStatementBuilder removeQueryParam(@NonNull
                                                             String name)

Removes a parameter.

This is useful if the builder was initialized with a template statement that has more parameters than desired.

See Also:

ScriptGraphStatement.setQueryParam(String, Object), clearQueryParams()

clearQueryParams

public ScriptGraphStatementBuilder clearQueryParams()

Clears all the parameters previously added to this builder.

build

@NonNull
public ScriptGraphStatement build()

Description copied from class: GraphStatementBuilderBase

Create the statement with the configuration defined by this builder object.

Specified by:

build in class GraphStatementBuilderBase<ScriptGraphStatementBuilder,ScriptGraphStatement>