Node (GORM for Neo4j

grails.neo4j.Node

All Implemented Interfaces and Traits:: DynamicAttributes, GormEntity<D>, Neo4jEntity<D>

@groovy.transform.Trait
@groovy.transform.CompileStatic
trait Node<D>
extends java.lang.Object
implements DynamicAttributes, GormEntity<D>, Neo4jEntity<D>

A domain class that represents a Neo4j Node

Authors:: Graeme Rocher

Since:: 6.1

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static grails.neo4j.Path<D, D>`	`findPath(java.lang.CharSequence cypher)` Execute cypher that finds a path to the given entity
	`static grails.neo4j.Path<D, D>`	`findPath(java.lang.CharSequence cypher, java.util.Map params)` Execute cypher that finds a path to the given entity
`<T>`	`static grails.neo4j.Path<D, T>`	`findPathTo(java.lang.Class<T> type, java.lang.CharSequence cypher)` Execute cypher that finds a path to the given entity
`<T>`	`static grails.neo4j.Path<D, T>`	`findPathTo(java.lang.Class<T> type, java.lang.CharSequence cypher, java.util.Map params)` Execute cypher that finds a path to the given entity
`<F extends GormEntity, T extends GormEntity>`	`static Relationship<F, T>`	`findRelationship(F from, T to)` Finds a relationship between two entities
`<F extends GormEntity, T extends GormEntity>`	`static java.util.List<Relationship<F, T>>`	`findRelationships(F from, T to, java.util.Map params)` Finds a relationship between two entities
`<F extends GormEntity, T extends GormEntity>`	`static java.util.List<Relationship<F, T>>`	`findRelationships(java.lang.Class<F> from, java.lang.Class<T> to, java.util.Map params)` Finds a relationship between two entity types
`<F, T>`	`static grails.neo4j.Path<F, T>`	`findShortestPath(F from, T to, int maxDistance)` Finds a path between two entities
	`java.lang.Object`	`propertyMissing(java.lang.String name)` Allows accessing to dynamic properties with the dot operator
	`java.lang.Object`	`propertyMissing(java.lang.String name, java.lang.Object val)` Allows setting a dynamic property via the dot operator

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), 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()`

- Method Detail
  - static grails.neo4j.Path<D, D> findPath(java.lang.CharSequence cypher)
    
    Execute cypher that finds a path to the given entity
    Parameters:
    cypher - The cypher
    Returns:
    The path
  - static grails.neo4j.Path<D, D> findPath(java.lang.CharSequence cypher, java.util.Map params)
    
    Execute cypher that finds a path to the given entity
    Parameters:
    cypher - The cypher
    params - The parameters
    Returns:
    The path or null if non exists
  - <T> static grails.neo4j.Path<D, T> findPathTo(java.lang.Class<T> type, java.lang.CharSequence cypher)
    
    Execute cypher that finds a path to the given entity
    Parameters:
    type - The type to find a path to
    cypher - The cypher
    Returns:
    The path
  - <T> static grails.neo4j.Path<D, T> findPathTo(java.lang.Class<T> type, java.lang.CharSequence cypher, java.util.Map params)
    
    Execute cypher that finds a path to the given entity
    Parameters:
    cypher - The cypher
    Returns:
    The path
  - <F extends GormEntity, T extends GormEntity> static Relationship<F, T> findRelationship(F from, T to)
    
    Finds a relationship between two entities
    Parameters:
    from - The from entity (can be a proxy)
    to - The to entity (can be a proxy)
    Returns:
    The relationship or null if it doesn't exist
  - <F extends GormEntity, T extends GormEntity> static java.util.List<Relationship<F, T>> findRelationships(F from, T to, java.util.Map params)
    
    Finds a relationship between two entities
    Parameters:
    from - The from entity (can be a proxy)
    to - The to entity (can be a proxy)
    Returns:
    The relationship or null if it doesn't exist
  - <F extends GormEntity, T extends GormEntity> static java.util.List<Relationship<F, T>> findRelationships(java.lang.Class<F> from, java.lang.Class<T> to, java.util.Map params)
    
    Finds a relationship between two entity types
    Parameters:
    from - The from entity (can be a proxy)
    to - The to entity (can be a proxy)
    Returns:
    The relationship or null if it doesn't exist
  - <F, T> static grails.neo4j.Path<F, T> findShortestPath(F from, T to, int maxDistance)
    
    Finds a path between two entities
    Parameters:
    from - The from entity (can be a proxy)
    to - The to entity (can be a proxy)
    maxDistance - The maximum distance to traverse (defaults to 10)
    Returns:
    The path or null if non exists
  - java.lang.Object propertyMissing(java.lang.String name)
    
    Allows accessing to dynamic properties with the dot operator
    Parameters:
    instance - The instance
    name - The property name
    Returns:
    The property value
  - java.lang.Object propertyMissing(java.lang.String name, java.lang.Object val)
    
    Allows setting a dynamic property via the dot operator
    Parameters:
    instance - The instance
    name - The property name
    val - The value

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Trait Node<D>

Methods Summary

Inherited Methods Summary

Method Detail

static grails.neo4j.Path<D, D> findPath(java.lang.CharSequence cypher)

static grails.neo4j.Path<D, D> findPath(java.lang.CharSequence cypher, java.util.Map params)

<T> static grails.neo4j.Path<D, T> findPathTo(java.lang.Class<T> type, java.lang.CharSequence cypher)

<T> static grails.neo4j.Path<D, T> findPathTo(java.lang.Class<T> type, java.lang.CharSequence cypher, java.util.Map params)

<F extends GormEntity, T extends GormEntity> static Relationship<F, T> findRelationship(F from, T to)

<F extends GormEntity, T extends GormEntity> static java.util.List<Relationship<F, T>> findRelationships(F from, T to, java.util.Map params)

<F extends GormEntity, T extends GormEntity> static java.util.List<Relationship<F, T>> findRelationships(java.lang.Class<F> from, java.lang.Class<T> to, java.util.Map params)

<F, T> static grails.neo4j.Path<F, T> findShortestPath(F from, T to, int maxDistance)

java.lang.Object propertyMissing(java.lang.String name)

java.lang.Object propertyMissing(java.lang.String name, java.lang.Object val)