org.neo4j.ogm.cypher.query

Class CypherQuery

java.lang.Object

org.neo4j.ogm.cypher.query.CypherQuery

All Implemented Interfaces:

Statement

Direct Known Subclasses:

AbstractRequest

public class CypherQuery
extends Object
implements Statement

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

Constructor and Description
CypherQuery(String cypher, Map<String,?> parameters) Constructs a new CypherQuery based on the given Cypher query string and query parameters.

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

CypherQuery

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

Constructs a new CypherQuery 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

Method Detail

getStatement

public String getStatement()

Specified by:

getStatement in interface Statement

getParameters

public Map<String,Object> getParameters()

Specified by:

getParameters in interface Statement

getResultDataContents

public String[] getResultDataContents()

Specified by:

getResultDataContents in interface Statement

isIncludeStats

public boolean isIncludeStats()

Specified by:

isIncludeStats in interface Statement

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)