org.springframework.data.neo4j.repository

Class AbstractGraphRepository<S extends org.neo4j.graphdb.PropertyContainer,T>

java.lang.Object

org.springframework.data.neo4j.repository.AbstractGraphRepository<S,T>

Type Parameters:

T - GraphBacked target of this finder, enables the finder methods to return this concrete type

S - Type of backing state, either Node or Relationship

All Implemented Interfaces:

CRUDRepository<T>, CypherDslRepository<T>, GraphRepository<T>, IndexRepository<T>, NamedIndexRepository<T>, SchemaIndexRepository<T>, SpatialRepository<T>, TraversalRepository<T>, CrudRepository<T,Long>, PagingAndSortingRepository<T,Long>, Repository<T,Long>

Direct Known Subclasses:

NodeGraphRepositoryImpl, RelationshipGraphRepository

@Transactional(readOnly=true)
public abstract class AbstractGraphRepository<S extends org.neo4j.graphdb.PropertyContainer,T>
extends Object
implements GraphRepository<T>, NamedIndexRepository<T>, SpatialRepository<T>, CypherDslRepository<T>

Repository like finder for Node and Relationship-Entities. Provides finder methods for direct access, access via TypeRepresentationStrategy and indexing.

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<T>	clazz Target graphbacked type
static org.neo4j.helpers.collection.ClosableIterable	EMPTY_CLOSABLE_ITERABLE
protected Neo4jTemplate	template

Constructor Summary

Constructors

Constructor and Description
AbstractGraphRepository(Neo4jTemplate template, Class<T> clazz)

Method Summary

Modifier and Type	Method and Description
long	count()
protected T	createEntity(S node)
void	delete(Iterable<? extends T> entities)
void	delete(Long id)
void	delete(T entity)
void	deleteAll()
boolean	exists(Long id)
Result<T>	findAll() uses the configured TypeRepresentationStrategy to load all entities, might return a large result
Iterable<T>	findAll(Iterable<Long> ids)
Page<T>	findAll(Pageable pageable)
Result<T>	findAll(Sort sort) finder that takes the provided sorting into account NOTE: the sorting is not yet implemented
Result<T>	findAllByPropertyValue(String property, Object value) Index based exact finder, uses the default index name for this type (short class name).
Result<T>	findAllByPropertyValue(String indexName, String property, Object value) Deprecated.
Result<T>	findAllByQuery(String key, Object query) Deprecated.
Result<T>	findAllByQuery(String indexName, String property, Object query) Deprecated.
Result<T>	findAllByRange(String property, Number from, Number to) Deprecated.
Result<T>	findAllByRange(String indexName, String property, Number from, Number to) Deprecated.
Result<T>	findAllBySchemaPropertyValue(String property, Object value) Schema (aka Label based) finder, uses the default label name for this type to lookup entities.
T	findByPropertyValue(String property, Object value) Index based single finder, uses the default index name for this type (short class name).
T	findByPropertyValue(String indexName, String property, Object value) Deprecated.
T	findBySchemaPropertyValue(String property, Object value) Schema (aka Label based) Index based single finder which uses the default label name for this type to find the entity.
T	findOne(Long id)
Result<T>	findWithinBoundingBox(String indexName, Box box)
Result<T>	findWithinBoundingBox(String indexName, double lowerLeftLat, double lowerLeftLon, double upperRightLat, double upperRightLon)
Result<T>	findWithinDistance(String indexName, Circle circle)
Result<T>	findWithinDistance(String indexName, double lat, double lon, double distanceKm)
Result<T>	findWithinShape(String indexName, Shape shape) Converts the shape into a well-known text representation and executes the appropriate WKT query
Result<T>	findWithinWellKnownText(String indexName, String wellKnownText)
protected abstract S	getById(long id)
Class	getStoredJavaType(Object entity)
Page<T>	query(org.neo4j.cypherdsl.grammar.Execute query, org.neo4j.cypherdsl.grammar.Execute countQuery, Map<String,Object> params, Pageable page)
Result<T>	query(org.neo4j.cypherdsl.grammar.Execute query, Map<String,Object> params)
Page<T>	query(org.neo4j.cypherdsl.grammar.Execute query, Map<String,Object> params, Pageable page)
Result<T>	query(String query, Map<String,Object> params)
<U extends T> Iterable<U>	save(Iterable<U> entities)
<U extends T> U	save(U entity)
<U extends T> void	saveOnly(U entity)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.neo4j.repository.TraversalRepository

findAllByTraversal

Field Detail

EMPTY_CLOSABLE_ITERABLE

public static final org.neo4j.helpers.collection.ClosableIterable EMPTY_CLOSABLE_ITERABLE

clazz

protected final Class<T> clazz

Target graphbacked type

template

protected final Neo4jTemplate template

Constructor Detail

AbstractGraphRepository

public AbstractGraphRepository(Neo4jTemplate template,
                               Class<T> clazz)

Method Detail

createEntity

protected T createEntity(S node)

save

@Transactional
public <U extends T> U save(U entity)

Specified by:

save in interface CrudRepository<T,Long>

saveOnly

@Transactional
public <U extends T> void saveOnly(U entity)

Specified by:

saveOnly in interface CRUDRepository<T>

save

@Transactional
public <U extends T> Iterable<U> save(Iterable<U> entities)

Specified by:

save in interface CrudRepository<T,Long>

count

public long count()

Specified by:

count in interface CrudRepository<T,Long>

Returns:

Number of instances of the target type in the graph.

findAll

public Result<T> findAll()

Description copied from interface: CRUDRepository

uses the configured TypeRepresentationStrategy to load all entities, might return a large result

Specified by:

findAll in interface CRUDRepository<T>

Specified by:

findAll in interface CrudRepository<T,Long>

Returns:

lazy Iterable over all instances of the target type.

findOne

public T findOne(Long id)

Specified by:

findOne in interface CrudRepository<T,Long>

Parameters:

id - id

Returns:

Entity with the given id or null.

findByPropertyValue

public T findByPropertyValue(String property,
                             Object value)

Index based single finder, uses the default index name for this type (short class name).

Specified by:

findByPropertyValue in interface IndexRepository<T>

Parameters:

property -

value -

Returns:

Single Entity with this property and value

findByPropertyValue

@Deprecated
public T findByPropertyValue(String indexName,
                                         String property,
                                         Object value)

Deprecated.

Index based single finder.

Specified by:

findByPropertyValue in interface NamedIndexRepository<T>

Parameters:

indexName - or null for default

property -

value -

Returns:

Single Entity with this property and value

findAllByPropertyValue

@Deprecated
public Result<T> findAllByPropertyValue(String indexName,
                                                    String property,
                                                    Object value)

Deprecated.

Index based exact finder.

Specified by:

findAllByPropertyValue in interface NamedIndexRepository<T>

Parameters:

indexName - or null for default index

property -

value -

Returns:

Iterable over Entities with this property and value

findAllByPropertyValue

public Result<T> findAllByPropertyValue(String property,
                                        Object value)

Index based exact finder, uses the default index name for this type (short class name).

Specified by:

findAllByPropertyValue in interface IndexRepository<T>

Parameters:

property -

value -

Returns:

Iterable over Entities with this property and value

findAllByQuery

@Deprecated
public Result<T> findAllByQuery(String key,
                                            Object query)

Deprecated.

Index based fulltext / query object finder, uses the default index name for this type (short class name).

Specified by:

findAllByQuery in interface IndexRepository<T>

Parameters:

key - key of the field to query

query - lucene query object or query-string @return Iterable over Entities with this property and value

findAllByQuery

@Deprecated
public Result<T> findAllByQuery(String indexName,
                                            String property,
                                            Object query)

Deprecated.

Index based fulltext / query object finder.

Specified by:

findAllByQuery in interface NamedIndexRepository<T>

Parameters:

indexName - or null for default index

property - property of the field to query

query - lucene query object or query-string @return Iterable over Entities with this property and value

findAllByRange

@Deprecated
public Result<T> findAllByRange(String property,
                                            Number from,
                                            Number to)

Deprecated.

Specified by:

findAllByRange in interface IndexRepository<T>

findAllByRange

@Deprecated
public Result<T> findAllByRange(String indexName,
                                            String property,
                                            Number from,
                                            Number to)

Deprecated.

Specified by:

findAllByRange in interface NamedIndexRepository<T>

findBySchemaPropertyValue

public T findBySchemaPropertyValue(String property,
                                   Object value)

Schema (aka Label based) Index based single finder which uses the default label name for this type to find the entity.

Specified by:

findBySchemaPropertyValue in interface SchemaIndexRepository<T>

Parameters:

property -

value -

Returns:

Single Entity with this property and value or null if it does not exist

findAllBySchemaPropertyValue

public Result<T> findAllBySchemaPropertyValue(String property,
                                              Object value)

Schema (aka Label based) finder, uses the default label name for this type to lookup entities.

Specified by:

findAllBySchemaPropertyValue in interface SchemaIndexRepository<T>

Parameters:

property -

value -

Returns:

Iterable over Entities with this property and value

getById

protected abstract S getById(long id)

exists

public boolean exists(Long id)

Specified by:

exists in interface CrudRepository<T,Long>

getStoredJavaType

public Class getStoredJavaType(Object entity)

Specified by:

getStoredJavaType in interface CRUDRepository<T>

delete

@Transactional
public void delete(T entity)

Specified by:

delete in interface CrudRepository<T,Long>

delete

@Transactional
public void delete(Long id)

Specified by:

delete in interface CrudRepository<T,Long>

delete

@Transactional
public void delete(Iterable<? extends T> entities)

Specified by:

delete in interface CrudRepository<T,Long>

deleteAll

@Transactional
public void deleteAll()

Specified by:

deleteAll in interface CrudRepository<T,Long>

findAll

public Result<T> findAll(Sort sort)

Description copied from interface: CRUDRepository

finder that takes the provided sorting into account NOTE: the sorting is not yet implemented

Specified by:

findAll in interface CRUDRepository<T>

Specified by:

findAll in interface PagingAndSortingRepository<T,Long>

Returns:

all elements of the repository type, sorted according to the sort NOTE: please close the iterable if it is not fully looped through

query

public Result<T> query(String query,
                       Map<String,Object> params)

Specified by:

query in interface CRUDRepository<T>

findAll

public Page<T> findAll(Pageable pageable)

Specified by:

findAll in interface PagingAndSortingRepository<T,Long>

findAll

public Iterable<T> findAll(Iterable<Long> ids)

Specified by:

findAll in interface CrudRepository<T,Long>

query

public Page<T> query(org.neo4j.cypherdsl.grammar.Execute query,
                     org.neo4j.cypherdsl.grammar.Execute countQuery,
                     Map<String,Object> params,
                     Pageable page)

Specified by:

query in interface CypherDslRepository<T>

query

public Page<T> query(org.neo4j.cypherdsl.grammar.Execute query,
                     Map<String,Object> params,
                     Pageable page)

Specified by:

query in interface CypherDslRepository<T>

query

public Result<T> query(org.neo4j.cypherdsl.grammar.Execute query,
                       Map<String,Object> params)

Specified by:

query in interface CypherDslRepository<T>

findWithinWellKnownText

public Result<T> findWithinWellKnownText(String indexName,
                                         String wellKnownText)

Specified by:

findWithinWellKnownText in interface SpatialRepository<T>

findWithinDistance

public Result<T> findWithinDistance(String indexName,
                                    double lat,
                                    double lon,
                                    double distanceKm)

Specified by:

findWithinDistance in interface SpatialRepository<T>

findWithinBoundingBox

public Result<T> findWithinBoundingBox(String indexName,
                                       double lowerLeftLat,
                                       double lowerLeftLon,
                                       double upperRightLat,
                                       double upperRightLon)

Specified by:

findWithinBoundingBox in interface SpatialRepository<T>

findWithinBoundingBox

public Result<T> findWithinBoundingBox(String indexName,
                                       Box box)

Specified by:

findWithinBoundingBox in interface SpatialRepository<T>

findWithinDistance

public Result<T> findWithinDistance(String indexName,
                                    Circle circle)

Specified by:

findWithinDistance in interface SpatialRepository<T>

findWithinShape

public Result<T> findWithinShape(String indexName,
                                 Shape shape)

Description copied from interface: SpatialRepository

Converts the shape into a well-known text representation and executes the appropriate WKT query

Specified by:

findWithinShape in interface SpatialRepository<T>