Implement business key equality

zanata · Mar 12, 2014 · 1c89e83 · 1c89e83
1 parent 0c0d2b8
commit 1c89e83
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 8 deletions.
diff --git a/zanata-model/src/main/java/org/zanata/model/AccountKeyBase.java b/zanata-model/src/main/java/org/zanata/model/AccountKeyBase.java
@@ -38,7 +38,7 @@
 @Setter
 @Getter
 @Access(AccessType.FIELD)
-public class AccountKeyBase {
+public abstract class AccountKeyBase {
     @NotEmpty
     @Size(min = 32, max = 32)
     @Id

diff --git a/zanata-model/src/main/java/org/zanata/model/HAccount.java b/zanata-model/src/main/java/org/zanata/model/HAccount.java
@@ -77,8 +77,7 @@
 @Getter
 @Access(AccessType.FIELD)
 @ToString(callSuper = true, of = "username")
-@EqualsAndHashCode(callSuper = true, of = { "enabled", "passwordHash",
-        "username", "apiKey" })
+@EqualsAndHashCode(of = "username", callSuper = false)
 public class HAccount extends ModelEntityBase implements Serializable {
     private static final long serialVersionUID = 1L;
 

diff --git a/zanata-model/src/main/java/org/zanata/model/HPersonEmailValidationKey.java b/zanata-model/src/main/java/org/zanata/model/HPersonEmailValidationKey.java
@@ -35,11 +35,13 @@
 import javax.persistence.Temporal;
 import javax.persistence.TemporalType;
 
+import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 import lombok.ToString;
 
+import org.hibernate.annotations.NaturalId;
 import org.hibernate.validator.constraints.Email;
 import org.hibernate.validator.constraints.NotEmpty;
 
@@ -49,6 +51,7 @@
 @ToString
 @NoArgsConstructor
 @Access(AccessType.FIELD)
+@EqualsAndHashCode(of = "keyHash", callSuper = false)
 public class HPersonEmailValidationKey implements Serializable {
     private static final long serialVersionUID = 1L;
 
@@ -57,6 +60,7 @@ public class HPersonEmailValidationKey implements Serializable {
     private Long id;
 
     @Column(nullable = false, unique = true)
+    @NaturalId
     private String keyHash;
 
     @ManyToOne(optional = false)

diff --git a/zanata-model/src/main/java/org/zanata/model/HTextFlow.java b/zanata-model/src/main/java/org/zanata/model/HTextFlow.java
@@ -49,6 +49,7 @@
 import javax.validation.constraints.Size;
 
 import lombok.AccessLevel;
+import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
@@ -91,6 +92,7 @@
 @Getter
 @NoArgsConstructor
 @Access(javax.persistence.AccessType.FIELD)
+@EqualsAndHashCode(of = { "resId", "document" }, callSuper = false)
 @ToString(of = { "resId", "revision", "comment", "obsolete" })
 @Slf4j
 public class HTextFlow extends HTextContainer implements Serializable,

diff --git a/zanata-model/src/main/java/org/zanata/model/ModelEntityBase.java b/zanata-model/src/main/java/org/zanata/model/ModelEntityBase.java
@@ -24,6 +24,7 @@
 import java.io.IOException;
 import java.io.Serializable;
 import java.util.Date;
+
 import javax.persistence.Access;
 import javax.persistence.AccessType;
 import javax.persistence.Column;
@@ -42,16 +43,14 @@
 import org.slf4j.LoggerFactory;
 
 import lombok.AccessLevel;
-import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.Setter;
 
 @MappedSuperclass
 @Access(AccessType.FIELD)
-@EqualsAndHashCode(exclude = "versionNum")
 @Getter
 @Setter
-public class ModelEntityBase implements Serializable, HashableState {
+public abstract class ModelEntityBase implements Serializable, HashableState {
     private static final long serialVersionUID = -6139220551322868743L;
 
     @Id
@@ -71,6 +70,20 @@ public class ModelEntityBase implements Serializable, HashableState {
     @Column(nullable = false)
     protected Integer versionNum;
 
+    /**
+     * Subclasses should implement business key equality/hashCode (suggestion:
+     * use NaturalId/unique/immutable fields, not the generated ID)
+     */
+    @Override
+    public abstract boolean equals(Object obj);
+
+    /**
+     * Subclasses should implement business key equality/hashCode (suggestion:
+     * use NaturalId/unique/immutable fields, not the generated ID)
+     */
+    @Override
+    public abstract int hashCode();
+
     @SuppressWarnings("unused")
     @PrePersist
     private void onPersist() {

diff --git a/zanata-model/src/main/java/org/zanata/model/tm/TransMemoryUnit.java b/zanata-model/src/main/java/org/zanata/model/tm/TransMemoryUnit.java
@@ -42,6 +42,7 @@
 import lombok.NoArgsConstructor;
 import lombok.ToString;
 
+import org.hibernate.annotations.NaturalId;
 import org.hibernate.search.annotations.Field;
 import org.hibernate.search.annotations.Indexed;
 import org.hibernate.search.annotations.IndexedEmbedded;
@@ -56,8 +57,7 @@
  *         href="mailto:camunoz@redhat.com">camunoz@redhat.com</a>
  */
 @Entity
-@EqualsAndHashCode(callSuper = true, of = { "transUnitId", "sourceLanguage",
-        "translationMemory" })
+@EqualsAndHashCode(of = { "translationMemory", "uniqueId" }, callSuper = false)
 @ToString(exclude = "translationMemory")
 @Data
 @NoArgsConstructor
@@ -96,9 +96,11 @@ public TransMemoryUnit(TransMemory tm, String uniqueId, String transUnitId,
 
     @ManyToOne(optional = false, fetch = FetchType.LAZY)
     @JoinColumn(name = "tm_id", nullable = false)
+    @NaturalId
     private TransMemory translationMemory;
 
     @Column(name = "unique_id", nullable = false)
+    @NaturalId
     private String uniqueId;
 
     @Column(nullable = true)