You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cayenne.apache.org by nt...@apache.org on 2018/01/31 13:05:51 UTC
cayenne-website git commit: Update documentation
Repository: cayenne-website
Updated Branches:
refs/heads/master 06cb4f038 -> 44b03baec
Update documentation
Project: http://git-wip-us.apache.org/repos/asf/cayenne-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/cayenne-website/commit/44b03bae
Tree: http://git-wip-us.apache.org/repos/asf/cayenne-website/tree/44b03bae
Diff: http://git-wip-us.apache.org/repos/asf/cayenne-website/diff/44b03bae
Branch: refs/heads/master
Commit: 44b03baecfcb0a742228b40588dfc9e9a61023d1
Parents: 06cb4f0
Author: Nikita Timofeev <st...@gmail.com>
Authored: Wed Jan 31 16:05:45 2018 +0300
Committer: Nikita Timofeev <st...@gmail.com>
Committed: Wed Jan 31 16:05:45 2018 +0300
----------------------------------------------------------------------
.../content/docs/4.0/getting-started-guide.html | 21 ++----
.../images/modeler-started.png | Bin 95897 -> 93190 bytes
.../docs/4.1/getting-started-db-first.html | 66 ++++++++++++-------
.../docs/4.1/getting-started-db-first.toc.html | 2 +
.../content/docs/4.1/getting-started-guide.html | 29 ++++----
.../images/modeler-started.png | Bin 95897 -> 93190 bytes
6 files changed, 64 insertions(+), 54 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/44b03bae/src/main/site/content/docs/4.0/getting-started-guide.html
----------------------------------------------------------------------
diff --git a/src/main/site/content/docs/4.0/getting-started-guide.html b/src/main/site/content/docs/4.0/getting-started-guide.html
index 8cb2fbd..287972b 100644
--- a/src/main/site/content/docs/4.0/getting-started-guide.html
+++ b/src/main/site/content/docs/4.0/getting-started-guide.html
@@ -285,6 +285,8 @@ menu:
<version>0.0.1-SNAPSHOT</version>
<properties>
<cayenne.version>4.0.B3-SNAPSHOT</cayenne.version> <i class="conum" data-value="1"></i><b>(1)</b>
+ <maven.compiler.source>1.8</maven.compiler.source> <i class="conum" data-value="2"></i><b>(2)</b>
+ <maven.compiler.target>1.8</maven.compiler.target>
</properties>
<dependencies>
@@ -305,21 +307,6 @@ menu:
<version>1.7.25</version>
</dependency>
</dependencies>
-
- <build>
- <plugins>
- <!-- Tell maven to support Java 8 -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-compiler-plugin</artifactId>
- <version>3.6.1</version>
- <configuration>
- <source>1.8</source>
- <target>1.8</target>
- </configuration>
- </plugin>
- </plugins>
- </build>
</project></code></pre>
</div>
</div>
@@ -330,6 +317,10 @@ menu:
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Here you can specify the version of Cayenne you are actually using</td>
</tr>
+ <tr>
+ <td><i class="conum" data-value="2"></i><b>2</b></td>
+ <td>Tell Maven to support Java 8</td>
+ </tr>
</tbody>
</table>
</div>
http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/44b03bae/src/main/site/content/docs/4.0/getting-started-guide/images/modeler-started.png
----------------------------------------------------------------------
diff --git a/src/main/site/content/docs/4.0/getting-started-guide/images/modeler-started.png b/src/main/site/content/docs/4.0/getting-started-guide/images/modeler-started.png
index dbf8324..5d83e7c 100644
Binary files a/src/main/site/content/docs/4.0/getting-started-guide/images/modeler-started.png and b/src/main/site/content/docs/4.0/getting-started-guide/images/modeler-started.png differ
http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/44b03bae/src/main/site/content/docs/4.1/getting-started-db-first.html
----------------------------------------------------------------------
diff --git a/src/main/site/content/docs/4.1/getting-started-db-first.html b/src/main/site/content/docs/4.1/getting-started-db-first.html
index d419668..1802afd 100644
--- a/src/main/site/content/docs/4.1/getting-started-db-first.html
+++ b/src/main/site/content/docs/4.1/getting-started-db-first.html
@@ -98,10 +98,12 @@ ALTER TABLE PAINTING ADD FOREIGN KEY (GALLERY_ID) REFERENCES GALLERY (ID) ON DEL
<div class="sect3">
<h4 id="create-a-new-project-in-intellij-idea"><a class="anchor" href="#create-a-new-project-in-intellij-idea"></a>Create a new Project in IntelliJ IDEA</h4>
<div class="paragraph">
- <p>In IntelliJ IDEA select <span class="menuseq"><b class="menu">File</b> <i class="fa fa-angle-right caret"></i> <b class="submenu">New</b> <i class="fa fa-angle-right caret"></i> <b class="menuitem">Project…</b></span> and then select "Maven" and click "Next". In the dialog shown on the screenshot below, fill the "Group Id" and "Artifact Id" fields and click "Next".</p>
+ <p>In IntelliJ IDEA select <code>File > New > Project…</code> and then select "Maven" and click "Next". In the dialog shown on the screenshot below, fill the "Group Id" and "Artifact Id" fields and click "Next".</p>
</div>
- <div class="paragraph">
- <p><span class="image"><img src="images/tutorial-idea-project.png" alt="tutorial idea project"></span></p>
+ <div class="imageblock" style="text-align: center">
+ <div class="content">
+ <img src="images/tutorial-idea-project.png" alt="tutorial idea project">
+ </div>
</div>
<div class="paragraph">
<p>On next dialog screen you can customize directory for your project and click "Finish". Now you should have a new empty project.</p>
@@ -251,8 +253,10 @@ ALTER TABLE PAINTING ADD FOREIGN KEY (GALLERY_ID) REFERENCES GALLERY (ID) ON DEL
<div class="paragraph">
<p>You can open created <code>datamap.map.xml</code> file and check it’s content in IDEA:</p>
</div>
- <div class="paragraph">
- <p><span class="image"><img src="images/tutorial-new-datamap.png" alt="tutorial new datamap"></span></p>
+ <div class="imageblock" style="text-align: center">
+ <div class="content">
+ <img src="images/tutorial-new-datamap.png" alt="tutorial new datamap">
+ </div>
</div>
<div class="paragraph">
<p>Great! We now have Cayenne DataMap file that describe model from our database.</p>
@@ -262,14 +266,17 @@ ALTER TABLE PAINTING ADD FOREIGN KEY (GALLERY_ID) REFERENCES GALLERY (ID) ON DEL
<tbody>
<tr>
<td class="icon"> <i class="fa fa-info-circle fa-2x" title="Note"></i> </td>
- <td class="content"> If you have some problems with configuration you can always delete <code>datamap.map.xml</code> file and try again. === Creating project </td>
+ <td class="content"> If you have some problems with configuration you can always delete <code>datamap.map.xml</code> file and try again. </td>
</tr>
</tbody>
</table>
</div>
- <div class="paragraph">
- <p>Now we also need to create project file, currently this should be done manually via Cayenne Modeler.</p>
- </div>
+ </div>
+ </div>
+ <div class="sect2">
+ <h3 id="creating-project"><a class="anchor" href="#creating-project"></a>2.2. Creating project</h3>
+ <div class="paragraph">
+ <p>Now we also need to create project file, currently this should be done manually via Cayenne Modeler.</p>
</div>
<div class="sect3">
<h4 id="setup-modeler-maven-plugin"><a class="anchor" href="#setup-modeler-maven-plugin"></a>Setup Modeler Maven plugin</h4>
@@ -299,8 +306,10 @@ ALTER TABLE PAINTING ADD FOREIGN KEY (GALLERY_ID) REFERENCES GALLERY (ID) ON DEL
<div class="paragraph">
<p>In Modeler start new project and select <code>File</code> > <code>Import DataMap</code>. In File Select dialog select created <code>datamap.map.xml</code> file and click <code>Select DataMap</code>. Now all we need is to save project, click <code>Save</code> and select same folder where <code>datamap.map.xml</code> file is (it should be selected by default). That’s all, you should see now <code>cayenne-project.xml</code> file in IDEA:</p>
</div>
- <div class="paragraph">
- <p><span class="image"><img src="images/tutorial-cayenne-project.png" alt="tutorial cayenne project"></span></p>
+ <div class="imageblock" style="text-align: center">
+ <div class="content">
+ <img src="images/tutorial-cayenne-project.png" alt="tutorial cayenne project">
+ </div>
</div>
<div class="paragraph">
<p>To use newly created project in Modeler later let’s configure plugin to open it automatically:</p>
@@ -382,8 +391,10 @@ ALTER TABLE cayenne_demo.PAINTING_INFO ADD FOREIGN KEY (PAINTING_ID) REFERENCES
<pre>$ mvn cayenne-modeler:run</pre>
</div>
</div>
- <div class="paragraph">
- <p><span class="image"><img src="images/tutorial-update-model.png" alt="tutorial update model"></span></p>
+ <div class="imageblock" style="text-align: center">
+ <div class="content">
+ <img src="images/tutorial-update-model.png" alt="tutorial update model">
+ </div>
</div>
<div class="paragraph">
<p>Great! New table and ObjEntity are in place, as well as a new field.</p>
@@ -394,8 +405,10 @@ ALTER TABLE cayenne_demo.PAINTING_INFO ADD FOREIGN KEY (PAINTING_ID) REFERENCES
<div class="paragraph">
<p>There is often a need to customize model to better fit it to your application requirements, such customization can be simple removal of toMany part of a relationship between two objects. Let’s do it, in a Modeler just select and remove relationship <code>paintings</code> in Artist object:</p>
</div>
- <div class="paragraph">
- <p><span class="image"><img src="images/tutorial-drop-relationship.png" alt="tutorial drop relationship"></span></p>
+ <div class="imageblock" style="text-align: center">
+ <div class="content">
+ <img src="images/tutorial-drop-relationship.png" alt="tutorial drop relationship">
+ </div>
</div>
<div class="paragraph">
<p>Now if you run</p>
@@ -419,14 +432,17 @@ ALTER TABLE cayenne_demo.PAINTING_INFO ADD FOREIGN KEY (PAINTING_ID) REFERENCES
<tbody>
<tr>
<td class="icon"> <i class="fa fa-info-circle fa-2x" title="Note"></i> </td>
- <td class="content"> <code>cdbimport</code> will skip only modifications in Object layer (e.g. ObjEntities, ObjAttributes and ObjRelationships), if you modify Db layer your changes will be overridden by next run of <code>cdbimport</code>. === Advanced filtering </td>
+ <td class="content"> <code>cdbimport</code> will skip only modifications in Object layer (e.g. ObjEntities, ObjAttributes and ObjRelationships), if you modify Db layer your changes will be overridden by next run of <code>cdbimport</code>. </td>
</tr>
</tbody>
</table>
</div>
- <div class="paragraph">
- <p>Final part of our tutorial is about fine-tuning what you load from DB into your model.</p>
- </div>
+ </div>
+ </div>
+ <div class="sect2">
+ <h3 id="advanced-filtering"><a class="anchor" href="#advanced-filtering"></a>3.2. Advanced filtering</h3>
+ <div class="paragraph">
+ <p>Final part of our tutorial is about fine-tuning what you load from DB into your model.</p>
</div>
<div class="sect3">
<h4 id="update-schema"><a class="anchor" href="#update-schema"></a>Update schema</h4>
@@ -508,8 +524,10 @@ ALTER TABLE cayenne_demo.PAINTING ADD COLUMN __service_column INT;</code></pre>
<div class="paragraph">
<p>In IDEA you should be able to see these newly generated classes:</p>
</div>
- <div class="paragraph">
- <p><span class="image"><img src="images/tutorial-java-classes.png" alt="tutorial java classes"></span></p>
+ <div class="imageblock" style="text-align: center">
+ <div class="content">
+ <img src="images/tutorial-java-classes.png" alt="tutorial java classes">
+ </div>
</div>
<div class="paragraph">
<p>Note that Cayenne code is unrecognized, that’s because we need to include Cayenne as dependency, let’s do this in <code>pom.xml</code> file:</p>
@@ -662,8 +680,10 @@ context.commitChanges();</code></pre>
<div class="paragraph">
<p>Now we are ready to run. Right click the "Main" class in IDEA and select "Run 'Main.main()'".</p>
</div>
- <div class="paragraph">
- <p><span class="image"><img src="images/idea-file-run-menu.png" alt="idea file run menu"></span></p>
+ <div class="imageblock" style="text-align: center">
+ <div class="content">
+ <img src="images/idea-file-run-menu.png" alt="idea file run menu">
+ </div>
</div>
<div class="paragraph">
<p>In the console you’ll see output similar to this, indicating that Cayenne stack has been started:</p>
http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/44b03bae/src/main/site/content/docs/4.1/getting-started-db-first.toc.html
----------------------------------------------------------------------
diff --git a/src/main/site/content/docs/4.1/getting-started-db-first.toc.html b/src/main/site/content/docs/4.1/getting-started-db-first.toc.html
index a4c97a4..74708d4 100644
--- a/src/main/site/content/docs/4.1/getting-started-db-first.toc.html
+++ b/src/main/site/content/docs/4.1/getting-started-db-first.toc.html
@@ -11,10 +11,12 @@
<li><a href="#importing-database" class="nav-link">2. Importing database</a>
<ul class="sectlevel2 nav">
<li><a href="#reverse-engineering-database" class="nav-link">2.1. Reverse engineering database</a></li>
+ <li><a href="#creating-project" class="nav-link">2.2. Creating project</a></li>
</ul> </li>
<li><a href="#advanced-usage-of-cdbimport" class="nav-link">3. Advanced usage of cdbimport</a>
<ul class="sectlevel2 nav">
<li><a href="#updating-model" class="nav-link">3.1. Updating model</a></li>
+ <li><a href="#advanced-filtering" class="nav-link">3.2. Advanced filtering</a></li>
</ul> </li>
<li><a href="#java-code" class="nav-link">4. Java code</a>
<ul class="sectlevel2 nav">
http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/44b03bae/src/main/site/content/docs/4.1/getting-started-guide.html
----------------------------------------------------------------------
diff --git a/src/main/site/content/docs/4.1/getting-started-guide.html b/src/main/site/content/docs/4.1/getting-started-guide.html
index 73ac36a..8dccd22 100644
--- a/src/main/site/content/docs/4.1/getting-started-guide.html
+++ b/src/main/site/content/docs/4.1/getting-started-guide.html
@@ -280,8 +280,11 @@ menu:
<groupId>org.example.cayenne</groupId>
<artifactId>tutorial</artifactId>
<version>0.0.1-SNAPSHOT</version>
+
<properties>
<cayenne.version>4.1.M2-SNAPSHOT</cayenne.version> <i class="conum" data-value="1"></i><b>(1)</b>
+ <maven.compiler.source>1.8</maven.compiler.source> <i class="conum" data-value="2"></i><b>(2)</b>
+ <maven.compiler.target>1.8</maven.compiler.target>
</properties>
<dependencies>
@@ -296,21 +299,6 @@ menu:
<version>1.7.25</version>
</dependency>
</dependencies>
-
- <build>
- <plugins>
- <!-- Tell maven to support Java 8 -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-compiler-plugin</artifactId>
- <version>3.6.1</version>
- <configuration>
- <source>1.8</source>
- <target>1.8</target>
- </configuration>
- </plugin>
- </plugins>
- </build>
</project></code></pre>
</div>
</div>
@@ -321,6 +309,10 @@ menu:
<td><i class="conum" data-value="1"></i><b>1</b></td>
<td>Here you can specify the version of Cayenne you are actually using</td>
</tr>
+ <tr>
+ <td><i class="conum" data-value="2"></i><b>2</b></td>
+ <td>Tell Maven to support Java 8</td>
+ </tr>
</tbody>
</table>
</div>
@@ -909,7 +901,7 @@ INFO: +++ transaction committed.</pre>
<div class="sect3">
<h4 id="running-web-application"><a class="anchor" href="#running-web-application"></a>Running Web Application</h4>
<div class="paragraph">
- <p>We need to provide javax servlet-api for our application.</p>
+ <p>We need to add cayenne-web module and javax servlet-api for our application.</p>
</div>
<div class="listingblock">
<div class="title">
@@ -917,6 +909,11 @@ INFO: +++ transaction committed.</pre>
</div>
<div class="content">
<pre class="highlight"><code class="language-xml xml" data-lang="xml"><dependency>
+ <groupId>org.apache.cayenne</groupId>
+ <artifactId>cayenne-web</artifactId>
+ <version>${cayenne.version}</version>
+</dependency>
+<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/44b03bae/src/main/site/content/docs/4.1/getting-started-guide/images/modeler-started.png
----------------------------------------------------------------------
diff --git a/src/main/site/content/docs/4.1/getting-started-guide/images/modeler-started.png b/src/main/site/content/docs/4.1/getting-started-guide/images/modeler-started.png
index dbf8324..5d83e7c 100644
Binary files a/src/main/site/content/docs/4.1/getting-started-guide/images/modeler-started.png and b/src/main/site/content/docs/4.1/getting-started-guide/images/modeler-started.png differ