HH-11186 - Add examples for all Hibernate annotations

Document Parent annotation
This commit is contained in:
Vlad Mihalcea 2017-04-19 15:22:22 +03:00
parent 7dd17e936f
commit ca52b38b1b
4 changed files with 178 additions and 2 deletions

View File

@ -1099,7 +1099,7 @@ like <<annotations-hibernate-collectiontype>>, <<annotations-hibernate-genericge
The https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/annotations/Parent.html[`@Parent`] annotation is used to specify that the current annotated embeddable attribute references back the owning entity.
//TODO: Add example
See the <<chapters/domain/basic_types.adoc#mapping-Parent,`@Parent` mapping>> section for more info.
[[annotations-hibernate-persister]]
==== `@Persister`

View File

@ -2069,7 +2069,7 @@ include::{sourcedir}/basic/TargetTest.java[tags=mapping-Target-persist-example]
When fetching the `City` entity, the `coordinates` property is mapped by the `@Target` expression:
[[mapping-Target-fetching-example]]
.`@Target` mapping usage
.`@Target` fetching example
====
[source, JAVA, indent=0]
----
@ -2083,3 +2083,41 @@ include::{extrasdir}/basic/mapping-Target-fetching-example.sql[]
====
Therefore, the `@Target` annotation is used to define a custom join association between the parent-child association.
[[mapping-Parent]]
==== `@Parent` mapping
The Hibernate-specific `@Parent` annotation allows you to reference the owner entity from within an embeddable.
[[mapping-Parent-example]]
.`@Parent` mapping usage
====
[source, JAVA, indent=0]
----
include::{sourcedir}/basic/ParentTest.java[tags=mapping-Parent-example]
----
====
Assuming we have persisted the following `City` entity:
[[mapping-Parent-persist-example]]
.`@Parent` persist example
====
[source, JAVA, indent=0]
----
include::{sourcedir}/basic/ParentTest.java[tags=mapping-Parent-persist-example]
----
====
When fetching the `City` entity, the `city` property of the embeddable type acts as a back reference to the owning parent entity:
[[mapping-Parent-fetching-example]]
.`@Parent` fetching example
====
[source, JAVA, indent=0]
----
include::{sourcedir}/basic/ParentTest.java[tags=mapping-Parent-fetching-example]
----
====
Therefore, the `@Parent` annotation is used to define the association between an embeddable type and the owning entity.

View File

@ -0,0 +1,137 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.userguide.mapping.basic;
import javax.persistence.Embeddable;
import javax.persistence.Embedded;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import org.hibernate.annotations.Parent;
import org.hibernate.annotations.Target;
import org.hibernate.jpa.test.BaseEntityManagerFunctionalTestCase;
import org.junit.Test;
import static org.hibernate.testing.transaction.TransactionUtil.doInJPA;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertSame;
/**
* @author Vlad Mihalcea
*/
public class ParentTest extends BaseEntityManagerFunctionalTestCase {
@Override
protected Class<?>[] getAnnotatedClasses() {
return new Class<?>[] {
City.class,
};
}
@Test
public void testLifecycle() {
//tag::mapping-Parent-persist-example[]
doInJPA( this::entityManagerFactory, entityManager -> {
City cluj = new City();
cluj.setName( "Cluj" );
cluj.setCoordinates( new GPS( 46.77120, 23.62360 ) );
entityManager.persist( cluj );
} );
//end::mapping-Parent-persist-example[]
//tag::mapping-Parent-fetching-example[]
doInJPA( this::entityManagerFactory, entityManager -> {
City cluj = entityManager.find( City.class, 1L );
assertSame( cluj, cluj.getCoordinates().getCity() );
} );
//end::mapping-Parent-fetching-example[]
}
//tag::mapping-Parent-example[]
@Embeddable
public static class GPS {
private double latitude;
private double longitude;
@Parent
private City city;
private GPS() {
}
public GPS(double latitude, double longitude) {
this.latitude = latitude;
this.longitude = longitude;
}
public double getLatitude() {
return latitude;
}
public double getLongitude() {
return longitude;
}
public City getCity() {
return city;
}
public void setCity(City city) {
this.city = city;
}
}
@Entity(name = "City")
public static class City {
@Id
@GeneratedValue
private Long id;
private String name;
@Embedded
@Target( GPS.class )
private GPS coordinates;
//Getters and setters omitted for brevity
//end::mapping-Parent-example[]
public Long getId() {
return id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public GPS getCoordinates() {
return coordinates;
}
public void setCoordinates(GPS coordinates) {
this.coordinates = coordinates;
}
//tag::mapping-Parent-example[]
}
//end::mapping-Parent-example[]
}

View File

@ -50,6 +50,7 @@ public class TargetTest extends BaseEntityManagerFunctionalTestCase {
doInJPA( this::entityManagerFactory, entityManager -> {
City cluj = entityManager.find( City.class, 1L );
assertEquals( 46.77120, cluj.getCoordinates().x(), 0.00001 );
assertEquals( 23.62360, cluj.getCoordinates().y(), 0.00001 );
} );