Merge branch 'guidebook'

This commit is contained in:
Michael Hunger
2011-03-14 10:48:40 +01:00
24 changed files with 372 additions and 19 deletions

View File

@@ -172,7 +172,7 @@
</dependency>
<dependency>
<groupId>javax.media</groupId>
<artifactId>jai-core</artifactId>
<artifactId>jai_core</artifactId>
<version>1.1.3</version>
<scope>runtime</scope>
</dependency>

View File

@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<book xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
<title>Spring Data Graph - Reference Documentation</title>
<title>The Spring Data Graph Guidebook</title>
<releaseinfo>&version;</releaseinfo>
<authorgroup>
@@ -37,28 +37,70 @@
<toc/>
<part id="introduction">
<title>Introduction</title>
<preface id="foreword:rod">
<title>Foreword: Rod Johnson, CEO of SpringSource</title>
<para>
Rod ...
</para>
</preface>
<xi:include href="introduction/introduction.xml"/>
<xi:include href="introduction/why-sd-graph.xml"/>
<xi:include href="introduction/requirements.xml"/>
<xi:include href="introduction/get-started.xml"/>
</part>
<preface id="foreword:emil">
<title>Foreword: Emil Eifrem, CEO of Neo Technology</title>
<para>
Emil ...
</para>
</preface>
<preface id="about-book">
<title>About this book</title>
<para>
Duplex book -> Fowler bliki
1. Narrative / Tutorial
2. Reference docs
</para>
</preface>
<part id="tutorial">
<title>Tutorial</title>
<partintro>
<para>
Tutorial intro ...
</para>
</partintro>
<xi:include href="tutorial/about-spring-data.xml"/>
<xi:include href="tutorial/about-tutorial.xml"/>
<xi:include href="tutorial/setup.xml"/>
<xi:include href="tutorial/domain.xml"/>
<xi:include href="tutorial/annotations.xml"/>
<xi:include href="tutorial/data-access.xml"/>
<xi:include href="tutorial/security.xml"/>
<xi:include href="tutorial/social.xml"/>
<xi:include href="tutorial/recommendations.xml"/>
</part>
<part id="reference">
<title>Reference</title>
<partintro>
<para>
This part of the reference documentation details the API, concepts, annotations, datastore, programming model and
the cross-store approach of Spring Data Graph.
This is the reference part of the book. It has information about the programming model, APIs,
concepts, and annotations of Spring Data Graph.
</para>
</partintro>
<xi:include href="preface.xml"/>
<xi:include href="neo4j.xml"/>
<xi:include href="programming-model.xml"/>
<xi:include href="setup.xml"/>
<xi:include href="cross-store.xml"/>
<xi:include href="samples.xml"/>
<xi:include href="reference/preface.xml"/>
<xi:include href="reference/neo4j.xml"/>
<xi:include href="reference/programming-model.xml"/>
<xi:include href="reference/setup.xml"/>
<xi:include href="reference/cross-store.xml"/>
<xi:include href="reference/samples.xml"/>
<xi:include href="reference/performance.xml" />
<xi:include href="reference/template.xml" />
<xi:include href="reference/annotations.xml" />
<xi:include href="reference/aspectj-intro.xml" />
<xi:include href="reference/neo4j-intro.xml" />
<xi:include href="reference/spring-data.xml" />
<xi:include href="reference/neo4j-server.xml" />
</part>
</book>

View File

@@ -0,0 +1,50 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="reference:annotations">
<title>Annotation-driven persistence</title>
<para>
...
</para>
<section>
<title>Annotations</title>
<para>
... this is the most important part
</para>
</section>
<section>
<title>Introduced methods</title>
<para>
...
</para>
</section>
<section>
<title>Finders</title>
<para>
...
</para>
</section>
<section>
<title>GraphDatabaseContext</title>
<para>
...
</para>
</section>
<section>
<title>Indexing</title>
<para>
...
</para>
</section>
<section>
<title>Traversal</title>
<para>
...
</para>
</section>
<section>
<title>EntityMapper and Path</title>
<para>
...
</para>
</section>
</chapter>

View File

@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="reference:aspectj-intro">
<title>AspectJ introduction</title>
<para>
...
</para>
</chapter>

View File

@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="reference:neo4j-intro">
<title>Neo4j introduction</title>
<para>
...
</para>
</chapter>

View File

@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="reference:neo4j-server">
<title>Neo4j Server</title>
<para>
...
</para>
</chapter>

View File

@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="reference:performance">
<title>Performance considerations</title>
<para>
...
</para>
<section>
<title>When to use SDG?</title>
<para>
...
</para>
</section>
</chapter>

View File

@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="reference:spring-data">
<title>Spring Data</title>
<para>
...
</para>
</chapter>

View File

@@ -0,0 +1,38 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="reference:template">
<title>Neo4jTemplate</title>
<para>
...
</para>
<section>
<title>Transaction handling/management</title>
<para>
...
</para>
</section>
<section>
<title>Basic operations</title>
<para>
...
</para>
</section>
<section>
<title>Indexing</title>
<para>
...
</para>
</section>
<section>
<title>Traversal</title>
<para>
...
</para>
</section>
<section>
<title>PathMapper</title>
<para>
... path as general return type?
</para>
</section>
</chapter>

View File

@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="tutorial:about-spring-data">
<title>About Spring Data</title>
<para>
* What is spring data?
* What is spring data graph?
* Why should I use it?
</para>
</chapter>

View File

@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="tutorial:about-tutorial">
<title>About this tutorial</title>
<para>
* What is Cineasts.net
</para>
</chapter>

View File

@@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="tutorial:annotations">
<title>Annotating the domain model</title>
<para>
...
</para>
<section>
<title>Persistent entities</title>
<para>
...
</para>
</section>
<section>
<title>Indexing</title>
<para>
...
</para>
</section>
<section>
<title>Relationships</title>
<para>
...
</para>
</section>
</chapter>

View File

@@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="tutorial:data-access">
<title>Accessing data</title>
<para>
...
</para>
<section>
<title>Importing data</title>
<para>
...
</para>
</section>
<section>
<title>Repository</title>
<para>
...
</para>
</section>
<section>
<title>Controllers</title>
<para>
...
</para>
</section>
</chapter>

View File

@@ -0,0 +1,38 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="tutorial:domain">
<title>The domain</title>
<para>
...
</para>
<section>
<title>Movie</title>
<para>
...
</para>
</section>
<section>
<title>Role</title>
<para>
...
</para>
</section>
<section>
<title>Actor</title>
<para>
...
</para>
</section>
<section>
<title>User</title>
<para>
...
</para>
</section>
<section>
<title>Rating</title>
<para>
...
</para>
</section>
</chapter>

View File

@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="tutorial:recommendations">
<title>Adding recommendations</title>
<para>
</para>
</chapter>

View File

@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="tutorial:security">
<title>Adding security</title>
<para>
</para>
</chapter>

View File

@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="tutorial:setup">
<title>Project setup</title>
<para>
...
</para>
<section>
<title>Spring Data Graph</title>
<para>
...
</para>
<section>
<title>Maven configuration</title>
<para>
...
</para>
</section>
<section>
<title>Spring configuration</title>
<para>
...
</para>
</section>
</section>
<section>
<title>Spring MVC</title>
<para>
...
</para>
<section>
<title>Maven configuration</title>
<para>
...
</para>
</section>
<section>
<title>Spring configuration</title>
<para>
...
</para>
</section>
</section>
</chapter>

View File

@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<chapter id="tutorial:social">
<title>Adding social</title>
<para>
...
</para>
</chapter>