Merge pull request #254 from rosette-api/rlpnc-7455-use-gender-property-for-pairwise-matching

rlpnc-7455 Use gender property for pairwise matching

Author: fhasanaj

model/src/main/java/com/basistech/rosette/apimodel/Gender.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2022 Basis Technology Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basistech.rosette.apimodel;
+
+public enum Gender {
+
+    FEMALE(0.99),
+    NONBINARY(0.5),
+    MALE(0.01);
+
+    private final double value;
+
+    Gender(double value) {
+        this.value = value;
+    }
+
+    public double getValue() {
+        return value;
+    }
+}

model/src/main/java/com/basistech/rosette/apimodel/Name.java

@@ -51,8 +51,15 @@ public class Name {
      */
     LanguageCode language;
 
+
+    /**
+     * @return gender of the name, {@link Gender}
+     */
+    Gender gender;
+
+
     /**
-     * Default constructor for lombok
+     * Default constructor for lombok (gender is optional)
      *
      * @param name
      * @param entityType
@@ -64,6 +71,24 @@ public Name(String name, String entityType, ISO15924 script, LanguageCode langua
         this.entityType = entityType;
         this.script = script;
         this.language = language;
+        this.gender = null;
+    }
+
+    /**
+     * Default constructor for lombok with gender
+     *
+     * @param name
+     * @param entityType
+     * @param script
+     * @param language
+     * @param gender
+     */
+    public Name(String name, String entityType, ISO15924 script, LanguageCode language, Gender gender) {
+        this.text = name;
+        this.entityType = entityType;
+        this.script = script;
+        this.language = language;
+        this.gender = gender;
     }
 
     /**
@@ -77,5 +102,6 @@ public Name(String name) {
         this.entityType = "PERSON";
         this.script = ISO15924.Zyyy;
         this.language = LanguageCode.UNKNOWN;
+        this.gender = null;
     }
 }