Skip to content

TRUNK-5950: RelationshipType Domain - Switching from Hibernate Mappings to Annotations #5570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shivvani-r wants to merge 3 commits into
base: master
Choose a base branch
from
+26 −63
Open

TRUNK-5950: RelationshipType Domain - Switching from Hibernate Mappings to Annotations #5570

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f87ad6b
TRUNK-5950: RelationshipType Domain - Switching from Hibernate Mappin…
shivvani-r Dec 6, 2025
6d20cc8
Fix schema validation by making 'name' column read-only
shivvani-r Dec 7, 2025
5d4694c
Switch to standard JPA GenerationType.IDENTITY
shivvani-r Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion api/src/main/java/org/openmrs/RelationshipType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,15 @@
*/
package org.openmrs;

import jakarta.persistence.AttributeOverride;
import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.Id;
import jakarta.persistence.Table;
import org.codehaus.jackson.annotate.JsonIgnore;
import org.hibernate.annotations.GenericGenerator;
import org.hibernate.annotations.Parameter;
import org.hibernate.envers.Audited;

/**
Expand All @@ -33,21 +41,39 @@
* In English, we run into a tricky RelationshipType with aunts and uncles. We have chosen to define
* them as aunt/uncle-niece/nephew.
*/
@Entity
@Table(name = "relationship_type")
@Audited
/**
* The 'name' property is inherited from BaseChangeableOpenmrsMetadata, but the
* relationship_type table does not have a 'name' column. It uses 'a_is_to_b'
* and 'b_is_to_a' instead.
* * We map 'name' to 'a_is_to_b' (read-only) to satisfy the Hibernate requirement
* for the inherited field without breaking the legacy schema.
*/
@AttributeOverride(name = "name", column = @Column(name = "a_is_to_b", length = 50, insertable = false, updatable = false))
public class RelationshipType extends BaseChangeableOpenmrsMetadata{

public static final long serialVersionUID = 4223L;

// Fields

@Id
@Column(name = "relationship_type_id")
@GeneratedValue(generator = "native")
@GenericGenerator(name = "native", strategy = "native", parameters = {
Copy link
Member

@dkayiwa dkayiwa Dec 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let us just use Identity as done here: https://github.com/openmrs/openmrs-core/blob/master/api/src/main/java/org/openmrs/Diagnosis.java#L56

Copy link
Author

@shivvani-r shivvani-r Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the pointer! I've switched it to GenerationType.IDENTITY and confirmed that the tests still pass.

@Parameter(name = "sequence", value = "relationship_type_relationship_type_id_seq") })
private Integer relationshipTypeId;

@Column(name = "a_is_to_b", nullable = false, length = 50)
private String aIsToB;

@Column (name = "b_is_to_a", nullable = false, length = 50)
private String bIsToA;

@Column (nullable = false)
private Integer weight = 0;

@Column (nullable = false)
private Boolean preferred = false;

// Constructors
Expand Down
3 changes: 2 additions & 1 deletion api/src/main/resources/hibernate.cfg.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@
<mapping resource="org/openmrs/api/db/hibernate/Role.hbm.xml" />
<mapping resource="org/openmrs/api/db/hibernate/Patient.hbm.xml" />
<mapping resource="org/openmrs/api/db/hibernate/PatientProgramAttribute.hbm.xml" />
<mapping resource="org/openmrs/api/db/hibernate/RelationshipType.hbm.xml" />
<mapping resource="org/openmrs/api/db/hibernate/Order.hbm.xml" />
<mapping resource="org/openmrs/api/db/hibernate/OrderAttribute.hbm.xml" />
<mapping resource="org/openmrs/api/db/hibernate/OrderAttributeType.hbm.xml" />
Expand Down Expand Up @@ -75,6 +74,8 @@
<!-- These mappings are required because of references in Obs & Concept -->
<mapping class="org.openmrs.ObsReferenceRange"/>
<mapping class="org.openmrs.ConceptReferenceRange"/>

<mapping class="org.openmrs.RelationshipType"/>
Copy link
Contributor

@suubi-joshua suubi-joshua Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shivvani-r Is this necessary,

</session-factory>

</hibernate-configuration>
61 changes: 0 additions & 61 deletions api/src/main/resources/org/openmrs/api/db/hibernate/RelationshipType.hbm.xml
View file
Open in desktop

This file was deleted.

Loading