From b86149785cb936967430900c332ca79baf88e1ff Mon Sep 17 00:00:00 2001 From: Johannes Mockenhaupt Date: Sun, 29 Jul 2012 14:34:43 +0200 Subject: [PATCH] Documentation updates. * SDG->SDN renames. * Couple of typos fixed. * URL fixes. * Update AspectJ section on Eclipse IDE integration. --- README.textile | 10 ++++----- developer_notes.html | 8 +++---- notice.txt | 4 ++-- .../cineasts-aspects/Readme.md | 4 ++-- .../cineasts/controller/MovieController.java | 2 +- .../webapp/WEB-INF/views/includes/footer.jsp | 2 +- .../cineasts-rest/Readme.md | 4 ++-- .../webapp/WEB-INF/views/includes/footer.jsp | 2 +- spring-data-neo4j-examples/cineasts/Readme.md | 4 ++-- .../webapp/WEB-INF/views/includes/footer.jsp | 2 +- .../neo4j/server/SpringPluginInitializer.java | 2 +- .../reference/programming-model/aspectj.xml | 22 +++++++++---------- 12 files changed, 33 insertions(+), 33 deletions(-) diff --git a/README.textile b/README.textile index 394dab1e3..8c84ca24c 100644 --- a/README.textile +++ b/README.textile @@ -1,4 +1,4 @@ -h1. Spring Data Graph - Quick start +h1. Spring Data Neo4j - Quick start 
 @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:
 
 
 
@@ -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.
 
 
 public interface WorldRepository extends GraphRepository, NamedIndexRepository {}
@@ -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.
 
diff --git a/developer_notes.html b/developer_notes.html
index a416199d8..5c05a801e 100644
--- a/developer_notes.html
+++ b/developer_notes.html
@@ -51,7 +51,7 @@ order by movie.title 

 TraversalDescription actors = Traversal.description()
   .relationships("ACTS_IN").filter(returnAllButStartNode());
 
-for (Node actors : actors.traverse(movie))
+for (Node actor : actors.traverse(movie))
  ...

 
        
Transactional: TX needed for write operations

@@ -94,11 +94,11 @@ try {
 </beans>

Testing

<neo4j:config graphDatabaseService="gds"/>
-<bean id="gds" class=”...ImpermanentGraphDatabase/>
+<bean id="gds" class="...ImpermanentGraphDatabase"/>

REST

<neo4j:config graphDatabaseService="rds"/>
-<bean id="rds" class=”...SpringRestGraphDatabase/>
+<bean id="rds" class="...SpringRestGraphDatabase"/>

Entity - Annotations

@@ -229,4 +229,4 @@ roo> controller all --package ~.web
- \ No newline at end of file + diff --git a/notice.txt b/notice.txt index 3c45a3029..a4f856dc3 100644 --- a/notice.txt +++ b/notice.txt @@ -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. diff --git a/spring-data-neo4j-examples/cineasts-aspects/Readme.md b/spring-data-neo4j-examples/cineasts-aspects/Readme.md index 4913adb66..57c196e9c 100644 --- a/spring-data-neo4j-examples/cineasts-aspects/Readme.md +++ b/spring-data-neo4j-examples/cineasts-aspects/Readme.md @@ -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 diff --git a/spring-data-neo4j-examples/cineasts-aspects/src/main/java/org/neo4j/cineasts/controller/MovieController.java b/spring-data-neo4j-examples/cineasts-aspects/src/main/java/org/neo4j/cineasts/controller/MovieController.java index f98793225..83cee75fe 100644 --- a/spring-data-neo4j-examples/cineasts-aspects/src/main/java/org/neo4j/cineasts/controller/MovieController.java +++ b/spring-data-neo4j-examples/cineasts-aspects/src/main/java/org/neo4j/cineasts/controller/MovieController.java @@ -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") diff --git a/spring-data-neo4j-examples/cineasts-aspects/src/main/webapp/WEB-INF/views/includes/footer.jsp b/spring-data-neo4j-examples/cineasts-aspects/src/main/webapp/WEB-INF/views/includes/footer.jsp index 57861b0d0..1ddcc0b6b 100644 --- a/spring-data-neo4j-examples/cineasts-aspects/src/main/webapp/WEB-INF/views/includes/footer.jsp +++ b/spring-data-neo4j-examples/cineasts-aspects/src/main/webapp/WEB-INF/views/includes/footer.jsp @@ -1,5 +1,5 @@ \ No newline at end of file diff --git a/spring-data-neo4j-examples/cineasts-rest/Readme.md b/spring-data-neo4j-examples/cineasts-rest/Readme.md index 4913adb66..57c196e9c 100644 --- a/spring-data-neo4j-examples/cineasts-rest/Readme.md +++ b/spring-data-neo4j-examples/cineasts-rest/Readme.md @@ -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 diff --git a/spring-data-neo4j-examples/cineasts-rest/src/main/webapp/WEB-INF/views/includes/footer.jsp b/spring-data-neo4j-examples/cineasts-rest/src/main/webapp/WEB-INF/views/includes/footer.jsp index 57861b0d0..1ddcc0b6b 100644 --- a/spring-data-neo4j-examples/cineasts-rest/src/main/webapp/WEB-INF/views/includes/footer.jsp +++ b/spring-data-neo4j-examples/cineasts-rest/src/main/webapp/WEB-INF/views/includes/footer.jsp @@ -1,5 +1,5 @@ \ No newline at end of file diff --git a/spring-data-neo4j-examples/cineasts/Readme.md b/spring-data-neo4j-examples/cineasts/Readme.md index 4913adb66..57c196e9c 100644 --- a/spring-data-neo4j-examples/cineasts/Readme.md +++ b/spring-data-neo4j-examples/cineasts/Readme.md @@ -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 diff --git a/spring-data-neo4j-examples/cineasts/src/main/webapp/WEB-INF/views/includes/footer.jsp b/spring-data-neo4j-examples/cineasts/src/main/webapp/WEB-INF/views/includes/footer.jsp index 57861b0d0..1ddcc0b6b 100644 --- a/spring-data-neo4j-examples/cineasts/src/main/webapp/WEB-INF/views/includes/footer.jsp +++ b/spring-data-neo4j-examples/cineasts/src/main/webapp/WEB-INF/views/includes/footer.jsp @@ -1,5 +1,5 @@ \ No newline at end of file diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/server/SpringPluginInitializer.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/server/SpringPluginInitializer.java index 416e6649b..94c1e810a 100644 --- a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/server/SpringPluginInitializer.java +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/server/SpringPluginInitializer.java @@ -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.
* For example:
diff --git a/src/docbkx/reference/programming-model/aspectj.xml b/src/docbkx/reference/programming-model/aspectj.xml index 62e78473e..40132469a 100644 --- a/src/docbkx/reference/programming-model/aspectj.xml +++ b/src/docbkx/reference/programming-model/aspectj.xml @@ -40,31 +40,31 @@ classes, and generified introduced methods. - 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 NodeBacked and RelationshipBacked interfaces directly to benefit from completion support and error checking. - Eclipse and STS support AspectJ via the AJDT plugin which can be installed from the update-site: - http://download.eclipse.org/tools/ajdt/37/update/ - (it might be necessary to use the latest development snapshot of the plugin - http://download.eclipse.org/tools/ajdt/36/dev/update). + Eclipse and STS support AspectJ via the AJDT plugin which can be installed from the update-site listed at + http://www.eclipse.org/ajdt/downloads/ + (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. 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 include **/*.aj for the spring-data-neo4j project. + Try editing the build path to include **/*.aj 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 spring-data-neo4j/src/main/java add **/*.aj to the Included path. - - For importing an Spring Data Graph project into Eclipse with m2e. - Please make sure that the AspectJ Configurator is installed and + Then for the spring-data-neo4j-aspects/src/main/java add **/*.aj 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: + http://dist.springsource.org/release/AJDT/configurator