org.neo4j.ogm.cypher.statement

Class ParameterisedStatement

java.lang.Object

org.neo4j.ogm.cypher.statement.ParameterisedStatement

Direct Known Subclasses:

Query, RowModelQueryWithStatistics

public class ParameterisedStatement
extends Object

Simple encapsulation of a Cypher query and its parameters and other optional parts (paging/sort). Note, this object will be transformed directly to JSON so don't add anything here that is not part of the HTTP Transactional endpoint syntax

Author:

Vince Bickers, Luanne Misquitta

Constructor Summary

Constructors

Modifier	Constructor and Description
	ParameterisedStatement(String cypher, Map<String,?> parameters) Constructs a new ParameterisedStatement based on the given Cypher query string and query parameters.
protected	ParameterisedStatement(String cypher, Map<String,?> parameters, boolean includeStats, String... resultDataContents)
protected	ParameterisedStatement(String cypher, Map<String,?> parameters, String... resultDataContents)

Method Summary

Methods

Modifier and Type	Method and Description
void	addFilters(Filters filters)
protected void	addPaging(Pagination page)
void	addSortOrder(SortOrder sortOrder)
Map<String,Object>	getParameters()
String[]	getResultDataContents()
String	getStatement()
boolean	isIncludeStats()
Pagination	page()
SortOrder	sortOrder()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterisedStatement

public ParameterisedStatement(String cypher,
                      Map<String,?> parameters)

Constructs a new ParameterisedStatement based on the given Cypher query string and query parameters.

Parameters:

cypher - The parameterised Cypher query string

parameters - The name-value pairs that satisfy the parameters in the given query

ParameterisedStatement

protected ParameterisedStatement(String cypher,
                      Map<String,?> parameters,
                      String... resultDataContents)

ParameterisedStatement

protected ParameterisedStatement(String cypher,
                      Map<String,?> parameters,
                      boolean includeStats,
                      String... resultDataContents)

Method Detail

getStatement

public String getStatement()

getParameters

public Map<String,Object> getParameters()

getResultDataContents

public String[] getResultDataContents()

isIncludeStats

public boolean isIncludeStats()

page

public Pagination page()

sortOrder

public SortOrder sortOrder()

addPaging

protected void addPaging(Pagination page)

addSortOrder

public void addSortOrder(SortOrder sortOrder)

addFilters

public void addFilters(Filters filters)