Author: aadamchik
Date: Sat Feb 6 12:04:52 2016
New Revision: 1728829
URL: http://svn.apache.org/viewvc?rev=1728829&view=rev
Log:
refreshing upgrade notes
Modified:
cayenne/site/cms/trunk/content/docs/4.0/upgrade-guide/ar01.html
Modified: cayenne/site/cms/trunk/content/docs/4.0/upgrade-guide/ar01.html
URL:
http://svn.apache.org/viewvc/cayenne/site/cms/trunk/content/docs/4.0/upgrade-guide/ar01.html?rev=1728829&r1=1728828&r2=1728829&view=diff
==============================================================================
--- cayenne/site/cms/trunk/content/docs/4.0/upgrade-guide/ar01.html (original)
+++ cayenne/site/cms/trunk/content/docs/4.0/upgrade-guide/ar01.html Sat Feb 6
12:04:52 2016
@@ -10,7 +10,8 @@
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(ga, s);
})();
</script></head><body bgcolor="white" text="black" link="#0000FF"
vlink="#840084" alink="#0000FF"><div xmlns:d="http://docbook.org/ns/docbook";
class="navheader"><table width="100%" summary="Navigation header"><tr><th
class="versioninfo">v.4.0 (4.0.M3-SNAPSHOT)</th><th align="center">Guide to 4.0
Features</th><th></th></tr><tr><td width="20%" align="left"><a accesskey="p"
href="index.html">Prev</a> </td><th width="60%"
align="center"> </th><td width="20%"
align="right"> </td></tr></table><hr></div><div class="article"
title="Guide to 4.0 Features"><div class="titlepage"><div><div><h2
class="title"><a name="d0e18"></a>Guide to 4.0
Features</h2></div></div><hr></div><div class="toc"><p><b>Table of
Contents</b></p><dl><dt><span class="section"><a
href="ar01.html#java-version">Java Version</a></span></dt><dt><span
class="section"><a href="ar01.html#cayenne-configuration">Cayenne
Configuration</a></span></dt><dt><span class="section"><a
href="ar01.html#framework-api
">Framework API</a></span></dt><dt><span class="section"><a
href="ar01.html#cayenne-modeler">CayenneModeler</a></span></dt><dt><span
class="section"><a href="ar01.html#build-tools">Build
Tools</a></span></dt></dl></div><p>This guide highlights the new features and
changes introduced in Apache Cayenne 4.0. For a full list of changes consult
- RELEASE-NOTES.txt included in Cayenne download. For
release-specific upgrade instructions check UPGRADE.txt.</p><div
class="section" title="Java Version"><div class="titlepage"><div><div><h2
class="title"><a name="java-version"></a>Java
Version</h2></div></div></div><p>Minimum required JDK version is 1.6 or newer.
Cayenne 4.0 is fully tested with Java 1.6, 1.7, 1.8. </p><p>The examples below
often use Java 8 syntax. But those same examples should work without lambdas
just as well.</p></div><div class="section" title="Cayenne Configuration"><div
class="titlepage"><div><div><h2 class="title"><a
name="cayenne-configuration"></a>Cayenne
Configuration</h2></div></div></div><div class="section"
title="ServerRuntimeBuilder"><div class="titlepage"><div><div><h3
class="title"><a
name="d0e33"></a>ServerRuntimeBuilder</h3></div></div></div><p>Cayenne 3.1
introduced dependency injection and ServerRuntime. 4.0 provides a very
convenient utility to create a custom runtime
+ RELEASE-NOTES.txt included in Cayenne download. For
release-specific upgrade instructions check UPGRADE.txt.</p><div
class="section" title="Java Version"><div class="titlepage"><div><div><h2
class="title"><a name="java-version"></a>Java
Version</h2></div></div></div><p>Minimum required JDK version is 1.7 or newer.
Cayenne 4.0 is fully tested with Java 1.7,
+ 1.8. </p><p>The examples below often use Java 8 syntax.
But those same examples should work without lambdas just as well.</p></div><div
class="section" title="Cayenne Configuration"><div
class="titlepage"><div><div><h2 class="title"><a
name="cayenne-configuration"></a>Cayenne
Configuration</h2></div></div></div><div class="section"
title="ServerRuntimeBuilder"><div class="titlepage"><div><div><h3
class="title"><a
name="d0e33"></a>ServerRuntimeBuilder</h3></div></div></div><p>Cayenne 3.1
introduced dependency injection and ServerRuntime. 4.0 provides a very
convenient utility to create a custom runtime
with various extensions. This reduces the code
needed to integrate Cayenne in your environment to just a few lines and no
boilerplate.
E.g.:</p><pre
class="programlisting">ServerRuntime runtime = new
ServerRuntimeBuilder("myproject")
@@ -18,29 +19,53 @@
.addModule(binder ->
binder.bind(JdbcEventLogger.class).toInstance(myLogger))
.dataSource(myDataSource)
.build();</pre></div><div class="section" title="Mapping-free
ServerRuntime"><div class="titlepage"><div><div><h3 class="title"><a
name="d0e40"></a>Mapping-free
ServerRuntime</h3></div></div></div><p>ServerRuntime can now be started without
any ORM mapping at all. This is useful in situations when Cayenne is used as a
stack to
- execute raw SQL, in unit tests,
etc.</p></div></div><div class="section" title="Framework API"><div
class="titlepage"><div><div><h2 class="title"><a
name="framework-api"></a>Framework API</h2></div></div></div><div
class="section" title="Fluent Query API"><div class="titlepage"><div><div><h3
class="title"><a name="d0e48"></a>Fluent Query
API</h3></div></div></div><p>Fluent Query API is one of the most exciting new
features in Cayenne 4.0. This syntax is "chainable" so you can write query
- assembly and execution code on one line. The
most useful fluent queries are ObjectSelect, SQLSelect and SelectById:</p><div
class="section" title="ObjectSelect"><div class="titlepage"><div><div><h4
class="title"><a name="d0e53"></a>ObjectSelect</h4></div></div></div><p>A
"chainable" analog of SelectQuery.
+ execute raw SQL, in unit tests,
etc.</p></div><div class="section" title="DI Container Decorators"><div
class="titlepage"><div><div><h3 class="title"><a name="d0e45"></a>DI Container
Decorators</h3></div></div></div><p>In addition to overriding services in DI
container, Cayenne now allows to supply
+ decorators. True to the "smallest-footprint" DI
philosophy, decorator approach is
+ very simple and does not require proxies or
class enhancement. Just implement the
+ decorated interface and provide a constructor
that takes a delegate instance being
+ decorated:</p><pre
class="programlisting">public class MyInterfaceDecorator implements MyInterface
{
+
+ private MyInterface delegate;
+
+ public MockInterface1_Decorator3(@Inject MyInterface delegate) {
+ this.delegate = delegate;
+ }
+
+ @Override
+ public String getName() {
+ return "<" + delegate.getName() + ">";
+ }
+}
+
+Module module = new Module() {
+
+ @Override
+ public void configure(Binder binder) {
+ binder.decorate(MyInterface.class).before(MyInterfaceDecorator.class);
+ }
+};</pre></div></div><div class="section" title="Framework API"><div
class="titlepage"><div><div><h2 class="title"><a
name="framework-api"></a>Framework API</h2></div></div></div><div
class="section" title="Fluent Query API"><div class="titlepage"><div><div><h3
class="title"><a name="d0e55"></a>Fluent Query
API</h3></div></div></div><p>Fluent Query API is one of the most exciting new
features in Cayenne 4.0. This syntax is "chainable" so you can write query
+ assembly and execution code on one line. The
most useful fluent queries are ObjectSelect, SQLSelect and SelectById:</p><div
class="section" title="ObjectSelect"><div class="titlepage"><div><div><h4
class="title"><a name="d0e60"></a>ObjectSelect</h4></div></div></div><p>A
"chainable" analog of SelectQuery.
</p><pre class="programlisting">Artist
a = ObjectSelect
.query(Artist.class)
.where(Artist.ARTIST_NAME.eq("Picasso"))
- .selectOne(context);</pre></div><div class="section"
title="SQLSelect"><div class="titlepage"><div><div><h4 class="title"><a
name="d0e60"></a>SQLSelect</h4></div></div></div><p>A "chainable" analog of
SQLTemplate used specifically to run selecting raw
+ .selectOne(context);</pre></div><div class="section"
title="SQLSelect"><div class="titlepage"><div><div><h4 class="title"><a
name="d0e67"></a>SQLSelect</h4></div></div></div><p>A "chainable" analog of
SQLTemplate used specifically to run selecting raw
SQL:</p><pre
class="programlisting">List<Long> ids = SQLSelect
.scalarQuery(Long.class, "SELECT ARTIST_ID FROM ARTIST ORDER BY
ARTIST_ID")
- .select(context);</pre></div><div class="section" title="SelectById"><div
class="titlepage"><div><div><h4 class="title"><a
name="d0e67"></a>SelectById</h4></div></div></div><p>There's really no good
analog of SelectById in Cayenne prior to 4.0. Previously available
ObjectIdQuery didn't support half of
+ .select(context);</pre></div><div class="section" title="SelectById"><div
class="titlepage"><div><div><h4 class="title"><a
name="d0e74"></a>SelectById</h4></div></div></div><p>There's really no good
analog of SelectById in Cayenne prior to 4.0. Previously available
ObjectIdQuery didn't support half of
the features of SelectById (e.g.
caching consistent with other queries, prefetches, etc.)
:</p><pre class="programlisting">Artist
a = SelectById
.query(Artist.class, 3)
.useLocalCache("g1")
- .selectOne(context)</pre></div></div><div class="section"
title="ObjectContext"><div class="titlepage"><div><div><h3 class="title"><a
name="objectcontext"></a>ObjectContext</h3></div></div></div><div
class="section" title="Callback-based Object Iterator"><div
class="titlepage"><div><div><h4 class="title"><a
name="d0e77"></a>Callback-based Object
Iterator</h4></div></div></div><p>ObjectContext now features a simpler way to
iterate over large result sets, based on callback interface that can be
+ .selectOne(context)</pre></div></div><div class="section"
title="ObjectContext"><div class="titlepage"><div><div><h3 class="title"><a
name="objectcontext"></a>ObjectContext</h3></div></div></div><div
class="section" title="Callback-based Object Iterator"><div
class="titlepage"><div><div><h4 class="title"><a
name="d0e84"></a>Callback-based Object
Iterator</h4></div></div></div><p>ObjectContext now features a simpler way to
iterate over large result sets, based on callback interface that can be
implemented with a
lambda:</p><pre
class="programlisting">SelectQuery<Artist> q = new
SelectQuery<Artist>(Artist.class);
context.iterate(q, (Artist a) -> {
// do something with the object...
...
-});</pre></div></div><div class="section" title="Generics in Expressions and
Queries"><div class="titlepage"><div><div><h3 class="title"><a
name="d0e84"></a>Generics in Expressions and
Queries</h3></div></div></div><p>We finished the work of "genericizing" Cayenne
APIs started in 3.1. Now all APIs dealing with persistent objects (Expressions,
- Queries, ObjectContext, etc.) support generics
of Persistent object type or attribute property type.</p></div><div
class="section" title="Property API"><div class="titlepage"><div><div><h3
class="title"><a name="d0e89"></a>Property
API</h3></div></div></div><p>Persistent superclasses (_MyEntity) now contain a
set of static Property<T> variables generated from the model. These
- metadata objects make possible to create
type-safe Expressions and other query parts.</p></div><div class="section"
title="Positional Parameter Bindings"><div class="titlepage"><div><div><h3
class="title"><a name="d0e94"></a>Positional Parameter Bindings
</h3></div></div></div><p>Expressions and SQLTemplate traditionally supported
binding of parameters by name as a map. Cayenne 4.0 introduces a very easy
+});</pre></div></div><div class="section" title="Generics in Expressions and
Queries"><div class="titlepage"><div><div><h3 class="title"><a
name="d0e91"></a>Generics in Expressions and
Queries</h3></div></div></div><p>We finished the work of "genericizing" Cayenne
APIs started in 3.1. Now all APIs dealing with persistent objects (Expressions,
+ Queries, ObjectContext, etc.) support generics
of Persistent object type or attribute property type.</p></div><div
class="section" title="Property API"><div class="titlepage"><div><div><h3
class="title"><a name="d0e96"></a>Property
API</h3></div></div></div><p>Persistent superclasses (_MyEntity) now contain a
set of static Property<T> variables generated from the model. These
+ metadata objects make possible to create
type-safe Expressions and other query parts.</p></div><div class="section"
title="Positional Parameter Bindings"><div class="titlepage"><div><div><h3
class="title"><a name="d0e101"></a>Positional Parameter Bindings
</h3></div></div></div><p>Expressions and SQLTemplate traditionally supported
binding of parameters by name as a map. Cayenne 4.0 introduces a very easy
form of positional bindings. It works with the
same named template format, only parameters are bound by position,
left-to-right.
Here we showing a more complex example with the
same parameter name being used more than once in the
query:</p><pre class="programlisting">// two
distinct names, 3 positional parameters.
@@ -48,7 +73,7 @@ context.iterate(q, (Artist a) -> {
Expression e = ExpressionFactory.exp(
"price = $price or averagePrice = $price and maxPrice = $maxPrice", 23,
50);</pre><p>This
API is supported in Expressions, SQLTemplate as
well as new SQLSelect and can be used interchnageably with named parameters
with a
- single template flavor.</p></div><div
class="section" title="Improved Transaction API"><div
class="titlepage"><div><div><h3 class="title"><a name="d0e102"></a>Improved
Transaction API</h3></div></div></div><p>Transaction factory is now setup via
DI (instead of being configured in the Modeler). There's a utility method on
ServerRuntime
+ single template flavor.</p></div><div
class="section" title="Improved Transaction API"><div
class="titlepage"><div><div><h3 class="title"><a name="d0e109"></a>Improved
Transaction API</h3></div></div></div><p>Transaction factory is now setup via
DI (instead of being configured in the Modeler). There's a utility method on
ServerRuntime
to perform multiple operations as one
transaction:</p><pre
class="programlisting">runtime.performInTransaction(() -> {
// ... do some changes
@@ -58,7 +83,7 @@ Expression e = ExpressionFactory.exp(
context.commitChanges();
return true;
-});</pre></div><div class="section" title="Transparent Database Cryptography
with "cayenne-crypto" Module"><div class="titlepage"><div><div><h3
class="title"><a name="d0e109"></a>Transparent Database Cryptography with
"cayenne-crypto" Module</h3></div></div></div><p>Cayenne includes a new module
called "cayenne-crypto" that enables transparent cryptography for designated
data columns. This is
+});</pre></div><div class="section" title="Transparent Database Cryptography
with "cayenne-crypto" Module"><div class="titlepage"><div><div><h3
class="title"><a name="d0e116"></a>Transparent Database Cryptography with
"cayenne-crypto" Module</h3></div></div></div><p>Cayenne includes a new module
called "cayenne-crypto" that enables transparent cryptography for designated
data columns. This is
a pretty cool feature that allows to enable
encryption/decryption of your sensitive data pretty much declaratively using
your
regular DB storage. Encrypted values can be
stored in (VAR)BINARY and (VAR)CHAR columns. Currently "cayenne-crypto" supports
AES/CBC/PKCS5Padding encryption (though other
cyphers can be added). It also supports encrypted data compression. Here is an
example
@@ -66,14 +91,14 @@ Expression e = ExpressionFactory.exp(
ServerRuntime:</p><pre
class="programlisting">Module cryptoExtensions = new CryptoModuleBuilder()
.keyStore("file:///mykeystore", "keystorepassword".toCharArray(),
"keyalias")
.compress()
- .build();</pre></div></div><div class="section"
title="CayenneModeler"><div class="titlepage"><div><div><h2 class="title"><a
name="cayenne-modeler"></a>CayenneModeler</h2></div></div></div><div
class="section" title="Improved UI"><div class="titlepage"><div><div><h3
class="title"><a name="d0e119"></a>Improved
UI</h3></div></div></div><p>CayenneModeler features a number of UI
improvements. Attributes and relationships are now edited in the same view (no
need to
- switch between the tabs). Project tree allows
to easily filter elements by type and quickly collapse the tree.</p></div><div
class="section" title="Dropped Support for Mapping Listeners"><div
class="titlepage"><div><div><h3 class="title"><a name="d0e124"></a>Dropped
Support for Mapping Listeners</h3></div></div></div><p>Managing listeners in
the DataMap XML model is counterproductive and confusing, so support for
listeners was removed from both
+ .build();</pre></div></div><div class="section"
title="CayenneModeler"><div class="titlepage"><div><div><h2 class="title"><a
name="cayenne-modeler"></a>CayenneModeler</h2></div></div></div><div
class="section" title="Improved UI"><div class="titlepage"><div><div><h3
class="title"><a name="d0e126"></a>Improved
UI</h3></div></div></div><p>CayenneModeler features a number of UI
improvements. Attributes and relationships are now edited in the same view (no
need to
+ switch between the tabs). Project tree allows
to easily filter elements by type and quickly collapse the tree.</p></div><div
class="section" title="Dropped Support for Mapping Listeners"><div
class="titlepage"><div><div><h3 class="title"><a name="d0e131"></a>Dropped
Support for Mapping Listeners</h3></div></div></div><p>Managing listeners in
the DataMap XML model is counterproductive and confusing, so support for
listeners was removed from both
the XML and the Modeler. If you previously had
listeners mapped in the model, annotate their callback methods, and perform
listener
registration in the code: </p><pre
class="programlisting">runtime.getDataDomain().addListener(myListener);</pre><p>Entity
callbacks on the
- other hand are managed in the Modeler as
before.</p></div></div><div class="section" title="Build Tools"><div
class="titlepage"><div><div><h2 class="title"><a name="build-tools"></a>Build
Tools</h2></div></div></div><div class="section" title="cdbimport"><div
class="titlepage"><div><div><h3 class="title"><a
name="d0e135"></a>cdbimport</h3></div></div></div><p>"cdbimport" has evolved
from an experiment to a full-featured production tool that significantly
reduces (and sometimes
+ other hand are managed in the Modeler as
before.</p></div></div><div class="section" title="Build Tools"><div
class="titlepage"><div><div><h2 class="title"><a name="build-tools"></a>Build
Tools</h2></div></div></div><div class="section" title="cdbimport"><div
class="titlepage"><div><div><h3 class="title"><a
name="d0e142"></a>cdbimport</h3></div></div></div><p>"cdbimport" has evolved
from an experiment to a full-featured production tool that significantly
reduces (and sometimes
eliminates) the need for manual maintenance of
the DataMaps in CayenneModeler. Two improvements made this possible. First,
smart
merge algorithm will ensure that custom changes
to the model are not overridden on subsequent runs of "cdbimport". Second, the
mechanism for specifing DB reverse-engineering
parameters, such as name filtering, is made much more powerful with many new
options.
E.g. we started supporting filters by catalogs
and schemas, table name filters can be added per catalog/schema or at the top
level,
- etc. Also configuration can be "inlined" in a
Maven pom.xml or specified as a separate file.</p></div><div class="section"
title="cgen"><div class="titlepage"><div><div><h3 class="title"><a
name="d0e140"></a>cgen</h3></div></div></div><p>As was mentioned above, cgen
now includes Property<T> static variables for expression building. It is
also made smarter about
+ etc. Also configuration can be "inlined" in a
Maven pom.xml or specified as a separate file.</p></div><div class="section"
title="cgen"><div class="titlepage"><div><div><h3 class="title"><a
name="d0e147"></a>cgen</h3></div></div></div><p>As was mentioned above, cgen
now includes Property<T> static variables for expression building. It is
also made smarter about
its defaults for "destDir" and
"superPkg".</p></div></div></div><div class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p"
href="index.html">Prev</a> </td><td width="20%"
align="center"> </td><td width="40%" align="right"> </td></tr><tr><td
width="40%" align="left" valign="top">Cayenne 4.0 New Features and Upgrade
Guide </td><td width="20%" align="center"><a accesskey="h"
href="index.html">Home</a></td><td width="40%" align="right"
valign="top"> </td></tr></table></div></body></html>
\ No newline at end of file
