Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

refresh the Javadoc overview page

This commit is contained in:
Gavin King 2022-07-04 11:33:33 +02:00
parent b2a1324814
commit 98f52855c1
1 changed files with 31 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
release/src/release/javadoc/overview.html
View File

@ -6,42 +6,44 @@
-->
<body>
<h2>Hibernate O/RM Aggregated JavaDocs</h2>
<h2>Hibernate ORM Aggregated Javadoc</h2>
Hibernate provides both<ul>
Hibernate provides:<ul>
<li>
a native API comprised centrally around {@link org.hibernate.SessionFactory} and {@link org.hibernate.Session}
a <em>native API</em> centered around {@link org.hibernate.SessionFactory} and
{@link org.hibernate.Session},
</li>
<li>
an implementation of the Java Persistence API (JPA).
See the latest <a href="http://jcp.org/en/jsr/detail?id=338">JPA JSR</a> for details.
an implementation of the <em>Java (or Jakarta) Persistence API</em> (JPA), and
</li>
<li>
a set of <em>mapping annotations</em> which augment the O/R mapping annotations defined by JPA,
and which may be used with either API.
</li>
</ul>
<p></p>
<h3>Native API</h3>
In addition to SessionFactory and Session, applications using the native API will often utilize the following
interfaces:<ul>
<li>{@link org.hibernate.cfg.Configuration}</li>
<li>{@link org.hibernate.Transaction}</li>
<li>{@link org.hibernate.query.Query}</li>
<li>{@link org.hibernate.Criteria}</li>
<li>{@link org.hibernate.criterion.Projection}</li>
<li>{@link org.hibernate.criterion.Projections}</li>
<li>{@link org.hibernate.criterion.Criterion}</li>
<li>{@link org.hibernate.criterion.Restrictions}</li>
<li>{@link org.hibernate.criterion.Order}</li>
<li>{@link org.hibernate.criterion.Example}</li>
Along with {@link org.hibernate.SessionFactory} and {@link org.hibernate.Session}, applications using
the native API will often make use of the following interfaces:<ul>
<li>{@link org.hibernate.cfg.Configuration} to configure and bootstrap Hibernate,</li>
<li>{@link org.hibernate.StatelessSession} for processes involving many entity instances,</li>
<li>{@link org.hibernate.Transaction} to control local transactions, and</li>
<li>{@link org.hibernate.query.Query} to execute HQL queries.</li>
</ul>
These interfaces are fully intended to be exposed to application code.
<p></p>
<h3>JPA</h3>
The JPA interfaces are all defined by the JPA specification. For details see {@link jakarta.persistence}.
Not that since 5.2 Hibernate extends JPA (e.g. SessionFactory extends EntityManagerFactory) rather
than wrapping it.
<p></p>
The JPA interfaces are defined by the JPA specification. For details see the latest
<a href="https://jakarta.ee/specifications/persistence/">specification</a> along with
{@link jakarta.persistence}.
<p>Note that since Hibernate 5.2, the native API extends the JPA API rather than wrapping it
(for example,<code>SessionFactory</code> extends <code>EntityManagerFactory</code>).</p>
<h3>Mapping annotations</h3>
See {@link org.hibernate.annotations}.
<h3>Note about package categories</h3>
Hibernate categorizes packages into a number of groups based on intended consumers:<ul>
@ -62,6 +64,7 @@ Hibernate categorizes packages into a number of groups based on intended consume
</ul>
<p></p>
Complete Hibernate documentation may be found online at <a href="http://hibernate.org/orm/documentation">http://hibernate.org/orm/documentation/</a>
Complete Hibernate documentation may be found online at
<a href="http://hibernate.org/orm/documentation">http://hibernate.org/orm/documentation/</a>.
</body>