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

Documentation updates.

Browse Source 
* SDG->SDN renames.
* Couple of typos fixed.
* URL fixes.
* Update AspectJ section on Eclipse IDE integration.
This commit is contained in:
Johannes Mockenhaupt
2012-07-29 14:34:43 +02:00
parent 36e2d147de
commit b86149785c
12 changed files with 33 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.textile
View File

@@ -1,4 +1,4 @@
h1. Spring Data Graph - Quick start
h1. Spring Data Neo4j - Quick start
<pre>
@NodeEntity
@@ -47,7 +47,7 @@ h2. About
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 Neo4j 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.
h2. Maven configuration
@@ -122,7 +122,7 @@ h2. Maven configuration
h2. Spring configuration
* Configure Spring Data Graph for Neo4j in your application using the provided XML namespace:
* Configure Spring Data Neo4j for Neo4j in your application using the provided XML namespace:
<pre>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
@@ -179,7 +179,7 @@ public class World {
h2. 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.
* 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-neo4j/docs/current/reference/html/#programming-model.
<pre>
public interface WorldRepository extends GraphRepository<World>, NamedIndexRepository<World> {}
@@ -238,7 +238,7 @@ Please see the "Hello Worlds sample project":https://github.com/SpringSource/spr
h2. 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-neo4j/docs/current/reference/html/ are the best places to start learning about Spring Data Neo4j. There are also "three sample applications":https://github.com/SpringSource/spring-data-neo4j/tree/master/spring-data-neo4j-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.

8
developer_notes.html
View File

@@ -51,7 +51,7 @@ order by movie.title </pre>
TraversalDescription actors = Traversal.description()
.relationships("ACTS_IN").filter(returnAllButStartNode());
for (Node actors : actors.traverse(movie))
for (Node actor : actors.traverse(movie))
...</pre>
<h4>Transactional: TX needed for write operations</h4>
@@ -94,11 +94,11 @@ try {
&lt;/beans></pre>
<h4>Testing</h4>
<pre>&lt;neo4j:config graphDatabaseService="gds"/>
&lt;bean id="gds" class=”...ImpermanentGraphDatabase/></pre>
&lt;bean id="gds" class="...ImpermanentGraphDatabase"/></pre>
<h4>REST</h4>
<pre>&lt;neo4j:config graphDatabaseService="rds"/>
&lt;bean id="rds" class=”...SpringRestGraphDatabase/></pre>
&lt;bean id="rds" class="...SpringRestGraphDatabase"/></pre>
</div>
<div class="note">
<h3>Entity - Annotations</h3>
@@ -229,4 +229,4 @@ roo> controller all --package ~.web</pre>
<a href="http://spring.neo4j.org" target="_blank"><img width="200" height="200" src="http://spring.neo4j.org/qr"/></a>
</div>
</body>
</html>
</html>

4
notice.txt
View File

@@ -1,5 +1,5 @@
Spring Data Graph 1.0
Copyright (c) [2010] SpringSource, a division of VMware, Inc.
Spring Data Neo4j 2.0
Copyright (c) [2012] SpringSource, a division of VMware, Inc.
This product is licensed to you under the Apache License, Version 2.0 (the "License").
You may not use this product except in compliance with the License.

4
spring-data-neo4j-examples/cineasts-aspects/Readme.md
View File

@@ -2,9 +2,9 @@
Cineasts.net
============
This project is the demo/tutorial application for the [Spring Data Graph](http://github.com/springsource/spring-data-graph) library which provides convenient access to the [Neo4j](http://neo4j.org) graph database.
This project is the demo/tutorial application for the [Spring Data Neo4j](https://github.com/SpringSource/spring-data-neo4j) library which provides convenient access to the [Neo4j](http://neo4j.org) graph database.
This tutorial creates a complete web application built on top of Spring Data Graph.
This tutorial creates a complete web application built on top of Spring Data Neo4j.
It uses a domain that should be familiar to most - movies. So for cineasts.net we decided to add a social
touch to the whole movie rating business, allowing friends to share their ratings and get recommendations

2
spring-data-neo4j-examples/cineasts-aspects/src/main/java/org/neo4j/cineasts/controller/MovieController.java
View File

@@ -38,7 +38,7 @@ public class MovieController {
private static final Logger log = LoggerFactory.getLogger(MovieController.class);
/**
* Only matches 'GET /moviies/{id}}' requests for JSON content; a 404 is sent otherwise.
* Only matches 'GET /movies/{id}}' requests for JSON content; a 404 is sent otherwise.
* TODO send a 406 if an unsupported representation, such as XML, is requested. See SPR-7353.
*/
@RequestMapping(value = "/movies/{id}", method = RequestMethod.GET, headers = "Accept=application/json")

2
spring-data-neo4j-examples/cineasts-aspects/src/main/webapp/WEB-INF/views/includes/footer.jsp
View File

@@ -1,5 +1,5 @@
<div id="footer">
This site is running on SpringFramework and Spring Data Graph powered by the Neo4j graph database. All movie data is provided by <a href="http://themoviedb.org">themoviedb.org</a>.<br/>
This site is running on SpringFramework and Spring Data Neo4j powered by the Neo4j graph database. All movie data is provided by <a href="http://themoviedb.org">themoviedb.org</a>.<br/>
<br/>
<a href="http://springsource.org"><img src="/images/logo/springsource.png"/></a><a href="http://springsource.org/spring-data"><img src="/images/logo/springdata.jpg"/></a><a href="http://github.com/springsource/spring-data-graph"><img src="/images/logo/springdatagraph.png"/></a><a href="http://neo4j.org"><img src="/images/logo/neo4j.png"/></a>
</div>

4
spring-data-neo4j-examples/cineasts-rest/Readme.md
View File

@@ -2,9 +2,9 @@
Cineasts.net
============
This project is the demo/tutorial application for the [Spring Data Graph](http://github.com/springsource/spring-data-graph) library which provides convenient access to the [Neo4j](http://neo4j.org) graph database.
This project is the demo/tutorial application for the [Spring Data Neo4j](https://github.com/SpringSource/spring-data-neo4j) library which provides convenient access to the [Neo4j](http://neo4j.org) graph database.
This tutorial creates a complete web application built on top of Spring Data Graph.
This tutorial creates a complete web application built on top of Spring Data Neo4j.
It uses a domain that should be familiar to most - movies. So for cineasts.net we decided to add a social
touch to the whole movie rating business, allowing friends to share their ratings and get recommendations

2
spring-data-neo4j-examples/cineasts-rest/src/main/webapp/WEB-INF/views/includes/footer.jsp
View File

@@ -1,5 +1,5 @@
<div id="footer">
This site is running on SpringFramework and Spring Data Graph powered by the Neo4j graph database. All movie data is provided by <a href="http://themoviedb.org">themoviedb.org</a>.<br/>
This site is running on SpringFramework and Spring Data Neo4j powered by the Neo4j graph database. All movie data is provided by <a href="http://themoviedb.org">themoviedb.org</a>.<br/>
<br/>
<a href="http://springsource.org"><img src="/images/logo/springsource.png"/></a><a href="http://springsource.org/spring-data"><img src="/images/logo/springdata.jpg"/></a><a href="http://github.com/springsource/spring-data-graph"><img src="/images/logo/springdatagraph.png"/></a><a href="http://neo4j.org"><img src="/images/logo/neo4j.png"/></a>
</div>

4
spring-data-neo4j-examples/cineasts/Readme.md
View File

@@ -2,9 +2,9 @@
Cineasts.net
============
This project is the demo/tutorial application for the [Spring Data Graph](http://github.com/springsource/spring-data-graph) library which provides convenient access to the [Neo4j](http://neo4j.org) graph database.
This project is the demo/tutorial application for the [Spring Data Neo4j](https://github.com/SpringSource/spring-data-neo4j) library which provides convenient access to the [Neo4j](http://neo4j.org) graph database.
This tutorial creates a complete web application built on top of Spring Data Graph.
This tutorial creates a complete web application built on top of Spring Data Neo4j.
It uses a domain that should be familiar to most - movies. So for cineasts.net we decided to add a social
touch to the whole movie rating business, allowing friends to share their ratings and get recommendations

2
spring-data-neo4j-examples/cineasts/src/main/webapp/WEB-INF/views/includes/footer.jsp
View File

@@ -1,5 +1,5 @@
<div id="footer">
This site is running on SpringFramework and Spring Data Graph powered by the Neo4j graph database. All movie data is provided by <a href="http://themoviedb.org">themoviedb.org</a>.<br/>
This site is running on SpringFramework and Spring Data Neo4j powered by the Neo4j graph database. All movie data is provided by <a href="http://themoviedb.org">themoviedb.org</a>.<br/>
<br/>
<a href="http://springsource.org"><img src="/images/logo/springsource.png"/></a><a href="http://springsource.org/spring-data"><img src="/images/logo/springdata.jpg"/></a><a href="http://github.com/springsource/spring-data-graph"><img src="/images/logo/springdatagraph.png"/></a><a href="http://neo4j.org"><img src="/images/logo/neo4j.png"/></a>
</div>

2
spring-data-neo4j/src/main/java/org/springframework/data/neo4j/server/SpringPluginInitializer.java
View File

@@ -27,7 +27,7 @@ import java.util.ArrayList;
import java.util.Collection;
/**
* Initializer to run Spring Data Graph based Server Plugins in a Neo4j REST-server. It takes the list of
* Initializer to run Spring Data Neo4j based Server Plugins in a Neo4j REST-server. It takes the list of
* config locations and a number of spring beans from those contexts that should be exposed
* as injectable dependencies with a Jersey @Context.<br/>
* For example:</br>

22
src/docbkx/reference/programming-model/aspectj.xml
View File

@@ -40,31 +40,31 @@
classes, and generified introduced methods.
</para>
<para>
IDE's not providing the full AJ support might mark parts of your code as errors.
IDEs not providing the full AJ support might mark parts of your code as errors.
You should rely on your build-system and tests to verify the correctness of the code. You might also have
your Entities (or their interfaces) implement the <code>NodeBacked</code> and <code>RelationshipBacked</code>
interfaces directly to benefit from completion support and error checking.
</para>
<para>
Eclipse and STS support AspectJ via the AJDT plugin which can be installed from the update-site:
<ulink url="http://download.eclipse.org/tools/ajdt/36/update/">http://download.eclipse.org/tools/ajdt/37/update/</ulink>
(it might be necessary to use the latest development snapshot of the plugin
<ulink url="http://download.eclipse.org/tools/ajdt/36/dev/update">http://download.eclipse.org/tools/ajdt/36/dev/update</ulink>).
Eclipse and STS support AspectJ via the AJDT plugin which can be installed from the update-site listed at
<ulink url="http://www.eclipse.org/ajdt/downloads/">http://www.eclipse.org/ajdt/downloads/</ulink>
(it might be necessary to use the latest development snapshot of the plugin).
The current version that does not show incorrect errors is AspectJ 1.6.12 (included in STS 2.8.0), previous versions are reported
to mislead the user.
to mislead the user. Note that as of Spring Data Neo4j version 2.0.1 the AspectJ version 1.7.0 is not yet supported. This also
means that AJDT 2.2.0 on Eclipse 4.2 is not yet supported as this version of AJDT internally uses AspectJ 1.7.0.
</para>
<note>
<para>
There might be some issues with the eclipse maven plugin not adding AspectJ files correctly to the build path.
If you encounter issues, please try the following:
Try editing the build path to <code>include **/*.aj</code> for the spring-data-neo4j project.
Try editing the build path to <code>include **/*.aj</code> for the spring-data-neo4j-aspects project.
You can do this by selecting "Build Path -> Configure Build Path ..." from the Package Explorer.
Then for the <code>spring-data-neo4j/src/main/java</code> add <code>**/*.aj</code> to the Included path.
For importing an Spring Data Graph project into Eclipse with m2e.
Please make sure that the <ulink url="http://dist.springsource.org/release/AJDT/configurator">AspectJ Configurator</ulink> is installed and
Then for the <code>spring-data-neo4j-aspects/src/main/java</code> add <code>**/*.aj</code> to the Included path.
When importing a Spring Data Neo4j project into Eclipse with m2e, please make sure the AspectJ Configurator is
installed from the following update-site:
<ulink url="http://dist.springsource.org/release/AJDT/configurator">http://dist.springsource.org/release/AJDT/configurator</ulink>
</para>
</note>
<para>