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

documentation updates

Browse Source
This commit is contained in:
Michael Hunger
2011-08-12 01:33:54 +02:00
parent 11c86801c6
commit 02aa926a89
4 changed files with 30 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/docbkx/reference/neo4j-server.xml
View File

@@ -1,6 +1,6 @@
<?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">
<chapter id="reference:neo4j-server">
<title>Neo4j Server</title>
<para>
Neo4j is not only available in embedded mode. It can also be installed and run as a stand-alone server

18
src/docbkx/reference/performance.xml
View File

@@ -1,6 +1,6 @@
<?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">
<chapter id="reference:performance">
<title>Performance considerations</title>
<para>
Although adding layers of abstraction is a common pattern in software development, each of these layers
@@ -15,14 +15,14 @@
mapped to the graph with very little work. Building on this foundation, one can later explore other,
more efficient ways to explore and process the graph - if the performance requirements demand it.
</para>
<!--<para>-->
<!--Like any other object mapping framework, the domain entities that are created, read, or persisted -->
<!--represent only a small fraction of the data stored in the database. This is the set needed for a -->
<!--certain use-case to be displayed, edited or processed in a low throughput fashion. The main advantages -->
<!--of using an object mapper in this case are the ease of use of real domain objects in your business -->
<!--logic and also with existing-->
<!--frameworks and libraries that expect Java POJOs as input or create them as results.-->
<!--</para>-->
<para>
Like any other object mapping framework, the domain entities that are created, read, or persisted
represent only a small fraction of the data stored in the database. This is the set needed for a
certain use-case to be displayed, edited or processed in a low throughput fashion. The main advantages
of using an object mapper in this case are the ease of use of real domain objects in your business
logic and also with existing
frameworks and libraries that expect Java POJOs as input or create them as results.
</para>
<para>
Spring Data Graph, however, was not designed with a major focus on performance. It does add some overhead
to pure graph operations. Something to keep in mind is that any access of properties and relationships

43
src/docbkx/reference/preface.xml
View File

@@ -118,30 +118,25 @@
The provided samples, which are also publicly hosted on <ulink url="http://github.com/springsource/spring-data-graph-examples">github</ulink> are explained in
<xref linkend="reference:samples"/>.
</para>
<!--
<xi:include href="reference/neo4j.xml"/>
<xi:include href="reference/programming-model/programming-model.xml"/>
<xi:include href="aspectj.xml"/>
<xi:include href="node-entities.xml"/>
<xi:include href="relationships.xml"/>
<xi:include href="introducedmethods.xml"/>
<xi:include href="indexing.xml"/>
<xi:include href="repositories.xml"/>
<xi:include href="transactions.xml"/>
<xi:include href="attachdetach.xml"/>
<xi:include href="typerepresentationstrategy.xml"/>
<xi:include href="projection.xml"/>
<xi:include href="beanvalidation.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/aspectj-details.xml" />
<xi:include href="reference/neo4j-server.xml" />
-->
<para>
The performance implications of using Spring Data Graph are detailed in <xref linkend="reference:performance"/>. This chapter also discusses
which usecases should be handled with Spring Data Graph and when it should not be used.
</para>
<para>
Being a Spring Data library, Spring Data Graph also implements a comprehensive template for interacting with the Neo4j graph database.
The <xref linkend="reference:template">Neo4jTemplate</xref> provides all basic graph operations as well as advanced querying with
Indexes, Cypher, Gremlin and Traversals with a convenient API.
</para>
<para>
As AspectJ might not come that easy to everyone, some of the core concepts of this Aspect oriented programming implementation for Java
are explained in <xref linkend="reference:aspectj-details"/>.
</para>
<para>
How to consume the REST-API of a Neo4j-Server is the topic of <xref linkend="reference:neo4j-server"/>. But Spring Data Graph can also
be used to create custom Extensions for the Neo4j Server which would serve domain model abstractions to a suitable front-end. So instead of
talking low level primitives to a database, the front-end would communicate via a domain level protocol with endpoints implemented
in Jersey and Spring Data Graph.
</para>
<para>
<note>
<para>

2
src/docbkx/reference/template.xml
View File

@@ -1,6 +1,6 @@
<?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">
<chapter id="reference:template">
<title>Neo4jTemplate</title>
<para>
The <code>Neo4jTemplate</code> offers the convenient API of Spring templates for the Neo4j graph