Spring/spring-data-neo4j
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
David Montag
2011-04-18 10:53:17 -07:00
parent 13bb7c171b
commit efc5937d5d
1 changed files with 135 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files

264
README.md
View File

@@ -1,153 +1,53 @@
Spring Data - Graph
=======================
The primary goal of the [Spring Data](http://www.springsource.org/spring-data) project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services.
As the name implies, the **Graph ** project provides integration with graph value stores. The only supported Graph Database now is [Neo4j](http://neo4j.org/).
The primary goal of the [Spring Data](http://www.springsource.org/spring-data) project is to make it easier to
build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce
frameworks, and cloud based data services. As the name implies, the **Graph** project provides integration with
graph value stores. The only supported Graph Database now is [Neo4j](http://neo4j.org/).
The Spring Data Graph project provides a simplified POJO based programming model that reduces that amount of boilerplate code needed to create neo4j applications. it also provides a 'cross store' persistence solution that can extend existing JPA data models with new parts (properties, entities, relationships) that are stored exclusively in the graph while being transparently integrated with the JPA entities. This enables for easy and seamless addition of new features that were not available before to JPA-based applications.
The Spring Data Graph project provides a simplified POJO based programming model that reduces that amount of
boilerplate code needed to create neo4j applications. it also provides a 'cross store' persistence solution that
can extend existing JPA data models with new parts (properties, entities, relationships) that are stored exclusively
in the graph while being transparently integrated with the JPA entities. This enables for easy and seamless
addition of new features that were not available before to JPA-based applications.
Getting Help
------------
This README and the [User Guide](http://static.springsource.org/spring-data/data-graph/docs/current/reference/html/) are the best places to start learning about Spring Data Graph. There are also [three sample appilcations](https://github.com/SpringSource/spring-data-graph-examples) briefly described in the reference documentation.
This README and the [User Guide](http://static.springsource.org/spring-data/data-graph/docs/current/reference/html/)
are the best places to start learning about Spring Data Graph. There are also
[three sample appilcations](https://github.com/SpringSource/spring-data-graph-examples) briefly described in the
reference documentation.
The main project [website](http://www.springsource.org/spring-data) contains links to basic project information such as source code, JavaDocs, Issue tracking, etc.
The main project [website](http://www.springsource.org/spring-data) contains links to basic project information such
as source code, JavaDocs, Issue tracking, etc.
For more detailed questions, use the [forum](http://forum.springsource.org/forumdisplay.php?f=80). If you are new to Spring as well as to Spring Data, look for information about [Spring projects](http://www.springsource.org/projects).
For more detailed questions, use the [forum](http://forum.springsource.org/forumdisplay.php?f=80). If you are new to
Spring as well as to Spring Data, look for information about [Spring projects](http://www.springsource.org/projects).
# Quick Start
## Maven configuration:
* Add the maven repository and dependency
* Add the maven repository and dependency
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-neo4j</artifactId>
<version>1.0.0.RELEASE</version>
</dependency>
</dependency>
<repository>
<id>spring-maven-snapshot</id>
<snapshots><enabled>true</enabled></snapshots>
<name>Springframework Maven MILESTONE Repository</name>
<url>http://maven.springframework.org/milestone</url>
</repository>
</repository>
## Spring Configuration:
* Configure Spring Data Graph for Neo4j in your application using the provided xml namespace.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:datagraph="http://www.springframework.org/schema/data/graph"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd
http://www.springframework.org/schema/data/graph http://www.springframework.org/schema/data/graph/datagraph-1.0.xsd
">
<context:annotation-config/>
<datagraph:config storeDirectory="target/config-test"/>
</beans>
## Graph-Entities
* Annotate your entity class. In this case it is a 'World' class that has a relationship to other worlds that are reachable by rocket travel:
@NodeEntity
public class World {
@Indexed
private String name;
@Indexed(indexName="moons")
private int moons;
@RelatedTo(type = "REACHABLE_BY_ROCKET", elementClass = World.class, direction = Direction.OUTGOING)
private Set<World> reachableByRocket;
public World( String name, int moons ) {
this.name = name;
this.moons = moons;
}
public String getName() { return name; }
public int getMoons() { return moons; }
public void addRocketRouteTo( World otherWorld ) {
reachableByRocket.add(otherWorld);
}
public boolean canBeReachedFrom( World otherWorld ) {
return reachableByRocket.contains( otherWorld );
}
}
## Transactional Services
* Create a repository or service to perform typical operations on your entities. The FinderFactory and Finder helper classes make searching easy for common use cases. The complete functionality is covered in the [reference manual](http://static.springsource.org/spring-data/data-graph/docs/current/reference/html/#programming-model).
public interface WorldRepository extends GraphRepository<World>, NamedIndexRepository<World> {}
@Repository
public class WorldRepositoryImpl implements WorldRepositoryExtension {
@Autowired
private WorldRepository worldRepository;
@Transactional
public Collection<World> makeSomeWorlds() {
World earth = world( "Earth", 1 );
World mars = world( "Mars", 2 );
mars.addRocketRouteTo( earth );
return Arrays.asList(
world( "Mercury", 0 ), world( "Venus", 0 ), earth, mars,
world( "Jupiter", 63 ), world( "Saturn", 62 ),
world( "Uranus", 27 ), world( "Neptune", 13 ));
}
private World world(String name, int moons) {
return new World(name,moons).persist();
}
public World findWorldIdentifiedBy( long id ) {
return worldRepository.findById( id );
}
public Iterable<World> findAllWorlds() {
return worldRepository.findAll();
}
public long countWorlds() {
return worldRepository.count();
}
public World findWorldNamed( String name ) {
return worldRepository.findByPropertyValue( "name", name );
}
public World findWorldWithMoons( long moonCount ) {
return worldRepository.findByPropertyValue( "moons", "moons", moonCount );
}
public Iterable<World> findWorldsWithMoons( int moonCount ) {
return worldRepository.findAllByPropertyValue( "moons", "moons", moonCount );
}
}
## Aspectj Compile Step
* Configure the Aspect-J maven plugin build & library dependency. Add the following plugin XML to your project's <plugins> config in pom.xml to hook AspectJ into the build process:
* Configure AspectJ: Add the following plugin XML to your project's <plugins> config in pom.xml to
hook AspectJ into the build process:
<plugin>
<groupId>org.codehaus.mojo</groupId>
@@ -190,7 +90,117 @@ For more detailed questions, use the [forum](http://forum.springsource.org/forum
</dependencies>
</plugin>
Please see the [Hello Worlds sample project](https://github.com/SpringSource/spring-data-graph-examples/tree/master/hello-worlds) in the examples repository for more information.
## Spring configuration:
* Configure Spring Data Graph for Neo4j in your application using the provided xml namespace.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:datagraph="http://www.springframework.org/schema/data/graph"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd
http://www.springframework.org/schema/data/graph http://www.springframework.org/schema/data/graph/datagraph-1.0.xsd
">
<context:annotation-config/>
<datagraph:config storeDirectory="target/config-test"/>
</beans>
## Graph entities
* Annotate your entity class. In this case it is a 'World' class that has a relationship to other worlds that are reachable by rocket travel:
@NodeEntity
public class World {
@Indexed
private String name;
@Indexed( indexName = "moons" )
private int moons;
@RelatedTo( type = "REACHABLE_BY_ROCKET", direction = Direction.BOTH, elementClass = World.class )
private Set<World> reachableByRocket;
public World(String name, int moons) {
this.name = name;
this.moons = moons;
}
public String getName() { return name; }
public int getMoons() { return moons; }
public void addRocketRouteTo( World otherWorld ) {
reachableByRocket.add( otherWorld );
}
public boolean canBeReachedFrom( World otherWorld ) {
return reachableByRocket.contains( otherWorld );
}
}
## Transactional services
* Create a repository or service to perform typical operations on your entities. The FinderFactory and Finder helper classes make searching easy for common use cases. The complete functionality is covered in the [reference manual](http://static.springsource.org/spring-data/data-graph/docs/current/reference/html/#programming-model).
public interface WorldRepository extends GraphRepository<World>, NamedIndexRepository<World> {}
@Repository
public class WorldRepositoryImpl implements WorldRepositoryExtension {
@Autowired
private WorldRepository worldRepository;
@Transactional
public Collection<World> makeSomeWorlds() {
World earth = world( "Earth", 1 );
World mars = world( "Mars", 2 );
mars.addRocketRouteTo( earth );
return Arrays.asList(
world( "Mercury", 0 ), world( "Venus", 0 ), earth, mars,
world( "Jupiter", 63 ), world( "Saturn", 62 ),
world( "Uranus", 27 ), world( "Neptune", 13 ));
}
private World world(String name, int moons) {
return new World(name, moons).persist();
}
public World findWorldIdentifiedBy( long id ) {
return worldRepository.findById( id );
}
public Iterable<World> findAllWorlds() {
return worldRepository.findAll();
}
public long countWorlds() {
return worldRepository.count();
}
public World findWorldNamed( String name ) {
return worldRepository.findByPropertyValue( "name", name );
}
public World findWorldWithMoons( long moonCount ) {
return worldRepository.findByPropertyValue( "moons", "moons", moonCount );
}
public Iterable<World> findWorldsWithMoons( int moonCount ) {
return worldRepository.findAllByPropertyValue( "moons", "moons", moonCount );
}
}
Please see the [Hello Worlds sample project](https://github.com/SpringSource/spring-data-graph-examples/tree/master/hello-worlds)
in the examples repository for more information.
Contributing to Spring Data
@@ -199,12 +209,8 @@ Contributing to Spring Data
Here are some ways for you to get involved in the community:
* Get involved with the Spring community on the Spring Community Forums. Please help out on the [forum](http://forum.springsource.org/forumdisplay.php?f=80) by responding to questions and joining the debate.
* Create [JIRA](https://jira.springframework.org/browse/DATAGRAPH) tickets for bugs and new features and comment and vote on the ones that you are interested in.
* Create [JIRA](https://jira.springframework.org/browse/DATAGRAPH) tickets for bugs and new features and comment and vote on the ones that you are interested in.
* Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way, please reference a JIRA ticket as well covering the specific issue you are addressing.
* Watch for upcoming articles on Spring by [subscribing](http://www.springsource.org/node/feed) to springframework.org
Before we accept a non-trivial patch or pull request we will need you to sign the [contributor's agreement](https://support.springsource.com/spring_committer_signup). Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.