Package org.neo4j.cypherdsl.core

Class ProcedureCall

java.lang.Object

org.neo4j.cypherdsl.core.ProcedureCall

All Implemented Interfaces:

Statement, Visitable

public final class ProcedureCall
extends java.lang.Object
implements Statement

See StandaloneCall.

Since:

2020.0.1

Author:

Michael J. Simons

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProcedureCall.OngoingInQueryCallWithArguments	The union of an in-query call exposing yields.
static interface	ProcedureCall.OngoingInQueryCallWithoutArguments	The union of an in-query call exposing new arguments and yields.
static interface	ProcedureCall.OngoingInQueryCallWithReturnFields	An in-query call exposing where and return clauses.
static interface	ProcedureCall.OngoingStandaloneCallWithArguments	The union of a buildable statement and call exposing yields.
static interface	ProcedureCall.OngoingStandaloneCallWithoutArguments	The union of a buildable statement and call exposing new arguments and yields.
static interface	ProcedureCall.OngoingStandaloneCallWithReturnFields	A buildable statement exposing where and return clauses.

Nested classes/interfaces inherited from interface org.neo4j.cypherdsl.core.Statement

Statement.RegularQuery, Statement.SingleQuery

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor visitor)	Accept a Visitor visiting this Visitable and its nested Visitables if applicable.
StatementContext	getContext()
java.lang.String	getCypher()	This method uses the default renderer to create a String representation of this statement.
java.util.Set<java.lang.String>	getParameterNames()	After the statement has been build, this method returns a list of all parameter names used, regardless whether a value was bound to the parameter o not.
java.util.Map<java.lang.String,java.lang.Object>	getParameters()	After a statement has been build, all parameters that have been added to the statement can be retrieved through this method.
boolean	isRenderConstantsAsParameters()	Some constants may be rendered as parameters.
void	setRenderConstantsAsParameters(boolean renderConstantsAsParameters)	Use this method to configure whether some constant values should be rendered as parameters or as literals before the first call to Statement.getParameters() or Statement.getCypher().

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.neo4j.cypherdsl.core.Statement

getContext, getCypher, getParameterNames, getParameters, isRenderConstantsAsParameters, setRenderConstantsAsParameters

Method Detail

accept

public void accept(Visitor visitor)

Description copied from interface: Visitable

Accept a Visitor visiting this Visitable and its nested Visitables if applicable.

Specified by:

accept in interface Visitable

Parameters:

visitor - the visitor to notify, must not be null.

getContext

public StatementContext getContext()

Specified by:

getContext in interface Statement

isRenderConstantsAsParameters

public boolean isRenderConstantsAsParameters()

Description copied from interface: Statement

Some constants may be rendered as parameters.

Specified by:

isRenderConstantsAsParameters in interface Statement

Returns:

True if literal parameters hav

setRenderConstantsAsParameters

public void setRenderConstantsAsParameters(boolean renderConstantsAsParameters)

Description copied from interface: Statement

Use this method to configure whether some constant values should be rendered as parameters or as literals before the first call to Statement.getParameters() or Statement.getCypher().

Renderers are free to chose to ignore this.

Specified by:

setRenderConstantsAsParameters in interface Statement

Parameters:

renderConstantsAsParameters - Set to true to render constants as parameters (when using Statement.getCypher().

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

Description copied from interface: Statement

After a statement has been build, all parameters that have been added to the statement can be retrieved through this method. The result will only contain parameters with a defined value. If you are interested in all parameter names, use Statement.getParameterNames().

The map can be used for example as an argument with various methods on the Neo4j Java Driver that allow the execution of parameterized queries.

This method is threadsafe

Specified by:

getParameters in interface Statement

Returns:

A map of all parameters with a bound value.

getParameterNames

public java.util.Set<java.lang.String> getParameterNames()

Description copied from interface: Statement

After the statement has been build, this method returns a list of all parameter names used, regardless whether a value was bound to the parameter o not.

This method is threadsafe

Specified by:

getParameterNames in interface Statement

Returns:

A set of parameter names being used.

getCypher

public java.lang.String getCypher()

Description copied from interface: Statement

This method uses the default renderer to create a String representation of this statement. The generated Cypher will use escaped literals and correct placeholders like $param for parameters. The placeholders for parameters can be retrieved via Statement.getParameterNames(). Bounded values for paramters can be retrieved via Statement.getParameters().

This method is threadsafe

Specified by:

getCypher in interface Statement

Returns:

A valid Cypher statement