CypherBuilder (GORM for Neo4j

org.grails.datastore.gorm.neo4j.CypherBuilder

A builder for Cypher queries
Since:
3.0
Authors:
Stefan
Graeme Rocher

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`COMMAND_SEPARATOR`
`static java.lang.String`	`CYPHER_CREATE`
`static java.lang.String`	`CYPHER_MATCH_ID`
`static java.lang.String`	`CYPHER_MATCH_NATIVE_ID`
`static java.lang.String`	`DEFAULT_RETURN_STATEMENT`
`static java.lang.String`	`DEFAULT_RETURN_TYPES`
`static java.lang.String`	`DELETE`
`static java.lang.String`	`END`
`static java.lang.String`	`IDENTIFIER`
`static java.lang.String`	`NEW_LINE`
`static java.lang.String`	`NODE_DATA`
`static java.lang.String`	`NODE_LABELS`
`static java.lang.String`	`NODE_VAR`
`static java.lang.String`	`OPTIONAL_MATCH`
`static java.lang.String`	`PROPS`
`static java.lang.String`	`RELATED`
`static java.lang.String`	`RETURN`
`static java.lang.String`	`SPACE`
`static java.lang.String`	`START`
`static java.lang.String`	`START_MATCH`
`static java.lang.String`	`TYPE`
`static java.lang.String`	`WHERE`

Constructor Summary

Constructors
Constructor and description
`CypherBuilder (java.lang.String forLabels)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addDeleteColumn(java.lang.String deleteColumn)` Adds a variable to be deleted by a DELETE statement
	`void`	`addMatch(java.lang.String match)`
	`void`	`addOptionalMatch(java.lang.String match)` Optional matches are added to do joins for relationships
	`int`	`addParam(java.lang.Object value)`
	`void`	`addPropertySet(java.util.Map<java.lang.String, java.lang.Object> sets)` Adds the property to be set using SET statement
	`void`	`addReturnColumn(java.lang.String returnColumn)` Adds a variable to be returned by a RETURN statement
	`java.lang.String`	`build()`
	`int`	`getNextMatchNumber()`
	`java.util.Map<java.lang.String, java.lang.Object>`	`getParams()` @return The parameters to the query
	`void`	`replaceParamAt(int position, java.lang.Object value)` @param position first element is 1
	`void`	`setConditions(java.lang.String conditions)`
	`void`	`setOrderAndLimits(java.lang.String orderAndLimits)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static final java.lang.String COMMAND_SEPARATOR
  - public static final java.lang.String CYPHER_CREATE
  - public static final java.lang.String CYPHER_MATCH_ID
  - public static final java.lang.String CYPHER_MATCH_NATIVE_ID
  - public static final java.lang.String DEFAULT_RETURN_STATEMENT
  - public static final java.lang.String DEFAULT_RETURN_TYPES
  - public static final java.lang.String DELETE
  - public static final java.lang.String END
  - public static final java.lang.String IDENTIFIER
  - public static final java.lang.String NEW_LINE
  - public static final java.lang.String NODE_DATA
  - public static final java.lang.String NODE_LABELS
  - public static final java.lang.String NODE_VAR
  - public static final java.lang.String OPTIONAL_MATCH
  - public static final java.lang.String PROPS
  - public static final java.lang.String RELATED
  - public static final java.lang.String RETURN
  - public static final java.lang.String SPACE
  - public static final java.lang.String START
  - public static final java.lang.String START_MATCH
  - public static final java.lang.String TYPE
  - public static final java.lang.String WHERE
- Constructor Detail
  - public CypherBuilder(java.lang.String forLabels)
- Method Detail
  - public void addDeleteColumn(java.lang.String deleteColumn)
    
    Adds a variable to be deleted by a DELETE statement
    Parameters:
    deleteColumn - The name of the variable in the cypher query
  - public void addMatch(java.lang.String match)
  - public void addOptionalMatch(java.lang.String match)
    
    Optional matches are added to do joins for relationships
    See Also:
    http://neo4j.com/docs/stable/query-optional-match.html
    Parameters:
    match - The optional match
  - public int addParam(java.lang.Object value)
  - public void addPropertySet(java.util.Map<java.lang.String, java.lang.Object> sets)
    
    Adds the property to be set using SET statement
    Parameters:
    sets - The property to be set
  - public void addReturnColumn(java.lang.String returnColumn)
    
    Adds a variable to be returned by a RETURN statement
    Parameters:
    returnColumn - The name of the variable in the cypher query
  - public java.lang.String build()
  - public int getNextMatchNumber()
  - public java.util.Map<java.lang.String, java.lang.Object> getParams()
    
    Returns:
    The parameters to the query
  - public void replaceParamAt(int position, java.lang.Object value)
    
    Parameters:
    position - first element is 1
    value
  - public void setConditions(java.lang.String conditions)
  - public void setOrderAndLimits(java.lang.String orderAndLimits)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class CypherBuilder

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String COMMAND_SEPARATOR

public static final java.lang.String CYPHER_CREATE

public static final java.lang.String CYPHER_MATCH_ID

public static final java.lang.String CYPHER_MATCH_NATIVE_ID

public static final java.lang.String DEFAULT_RETURN_STATEMENT

public static final java.lang.String DEFAULT_RETURN_TYPES

public static final java.lang.String DELETE

public static final java.lang.String END

public static final java.lang.String IDENTIFIER

public static final java.lang.String NEW_LINE

public static final java.lang.String NODE_DATA

public static final java.lang.String NODE_LABELS

public static final java.lang.String NODE_VAR

public static final java.lang.String OPTIONAL_MATCH

public static final java.lang.String PROPS

public static final java.lang.String RELATED

public static final java.lang.String RETURN

public static final java.lang.String SPACE

public static final java.lang.String START

public static final java.lang.String START_MATCH

public static final java.lang.String TYPE

public static final java.lang.String WHERE

Constructor Detail

public CypherBuilder(java.lang.String forLabels)

Method Detail

public void addDeleteColumn(java.lang.String deleteColumn)

public void addMatch(java.lang.String match)

public void addOptionalMatch(java.lang.String match)

public int addParam(java.lang.Object value)

public void addPropertySet(java.util.Map<java.lang.String, java.lang.Object> sets)

public void addReturnColumn(java.lang.String returnColumn)

public java.lang.String build()

public int getNextMatchNumber()

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

public void replaceParamAt(int position, java.lang.Object value)

public void setConditions(java.lang.String conditions)

public void setOrderAndLimits(java.lang.String orderAndLimits)