documentation updates

This commit is contained in:
Michael Hunger
2011-08-11 16:18:20 +02:00
parent b18b56a3ce
commit 645bc9676b
10 changed files with 160 additions and 54 deletions

View File

@@ -11,12 +11,10 @@
</para>
<para>
The aspect introduces some internal fields and some public methods
(see <xref linkend="reference:programming-model:introduced-methods"/>) in the entities, such as
(see <xref linkend="reference:programming-model:introduced-methods"/>) to the entities, such as
<code>entity.getPersistentState()</code> and <code>entity.relateTo</code>.
It also introduces repository methods like
<code>find(Class&lt;? extends NodeEntity>, TraversalDescription)</code>,
and <code>equals()</code> and <code>hashCode</code> delegation, making <code>equals()</code>
honor the backing state.
It also introduces repository methods like<code>find(Class&lt;? extends NodeEntity>, TraversalDescription)</code>.
Introduced methods for <code>equals()</code> and <code>hashCode()</code> use the underlying node or relationship.
</para>
<para>
Spring Data Graph internally uses an abstraction called <code>EntityState</code> that the field
@@ -24,7 +22,7 @@
minimum, focusing mainly on the pointcuts and delegation code. The <code>EntityState</code> then uses
a number of <code>FieldAccessorFactories</code> to create a <code>FieldAccessor</code> instance per
field that does the specific handling needed for the concrete field type. There are various layers of
caching involved as well, so it handles repeat instantiation efficiently.
caching involved as well, so it handles repeated instantiation efficiently.
</para>
<section>
<title>AspectJ IDE support</title>
@@ -50,7 +48,8 @@
</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:
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.
You can do this by selecting "Build Path -> Configure Build Path ..." from the Package Explorer.

View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<section>
<section id="reference:programming-model:lifecycle">
<title>Detached node entities</title>
<para>
Node entities can be in two different persistence state: attached or detached. By default, newly created node

View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<section>
<section id="reference:programming-model:validation">
<title>Bean validation (JSR-303)</title>
<para>
Spring Data Graph supports property-based validation support. When a property is changed, it is

View File

@@ -5,18 +5,18 @@
<para>
This chapter covers the fundamentals of the programming model behind Spring Data Graph. It discusses the
AspectJ features used and the annotations provided by Spring Data Graph and how to use them.
Examples for this section are taken from the imdb project of
Examples for this section are taken from the "IMDB" project of
<ulink url="http://github.com/SpringSource/spring-data-graph-examples">Spring Data Graph examples</ulink>.
</para>
<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="introducedmethods.xml"/>
<xi:include href="projection.xml"/>
<xi:include href="beanvalidation.xml"/>
</chapter>

View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<section>
<section id="reference:programming-model:projection">
<title>Projecting entities</title>
<para>
As the underlying data model of a graph database doesn't imply and enforce strict type constraints like a

View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<section>
<section id="reference:programming-model:transactions">
<title>Transactions</title>
<para>
Neo4j is a transactional database, only allowing modifications to be performed within transaction