Split Field model into distinct Feature and Entity objects (#655)

* Split Field model into distinct Feature and Entity objects

* Remove TFX fields for entities in testdata

* Split Field model into distinct Feature and Entity objects

* Index jointables

* Explicitly name tables, remove redundant constructor

* Integrate labels

* Fix code comments

* Change FeatureSetId to int

* Retrieve featuresets from repository so that ids are consistent

* Add uniqueness constraint to FeatureSets, fix tests

* Remove feature and entity references

core/src/main/java/feast/core/job/JobUpdateTask.java

@@ -16,6 +16,7 @@
  */
 package feast.core.job;
 
+import com.google.common.collect.Sets;
 import feast.core.log.Action;
 import feast.core.log.AuditLogger;
 import feast.core.log.Resource;
@@ -35,7 +36,6 @@
 import java.util.concurrent.Future;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
-import java.util.stream.Collectors;
 import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
 
@@ -102,10 +102,8 @@ public Job call() {
   }
 
   boolean featureSetsChangedFor(Job job) {
-    Set<String> existingFeatureSetsPopulatedByJob =
-        job.getFeatureSets().stream().map(FeatureSet::getId).collect(Collectors.toSet());
-    Set<String> newFeatureSetsPopulatedByJob =
-        featureSets.stream().map(FeatureSet::getId).collect(Collectors.toSet());
+    Set<FeatureSet> existingFeatureSetsPopulatedByJob = Sets.newHashSet(job.getFeatureSets());
+    Set<FeatureSet> newFeatureSetsPopulatedByJob = Sets.newHashSet(featureSets);
 
     return !newFeatureSetsPopulatedByJob.equals(existingFeatureSetsPopulatedByJob);
   }

core/src/main/java/feast/core/model/Entity.java

@@ -0,0 +1,73 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright 2018-2019 The Feast Authors
+ *
+ * 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
+ *
+ *     https://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 feast.core.model;
+
+import feast.core.FeatureSetProto.EntitySpec;
+import feast.types.ValueProto.ValueType;
+import java.util.Objects;
+import javax.persistence.*;
+import lombok.Getter;
+import lombok.Setter;
+
+/** Feast entity object. Contains name and type of the entity. */
+@Getter
+@Setter
+@javax.persistence.Entity
+@Table(
+    name = "entities",
+    uniqueConstraints = @UniqueConstraint(columnNames = {"name", "feature_set_id"}))
+public class Entity {
+
+  @Id @GeneratedValue private Long id;
+
+  private String name;
+
+  @ManyToOne(fetch = FetchType.LAZY)
+  private FeatureSet featureSet;
+
+  /** Data type of the entity. String representation of {@link ValueType} * */
+  private String type;
+
+  public Entity() {}
+
+  private Entity(String name, ValueType.Enum type) {
+    this.setName(name);
+    this.setType(type.toString());
+  }
+
+  public static Entity fromProto(EntitySpec entitySpec) {
+    Entity entity = new Entity(entitySpec.getName(), entitySpec.getValueType());
+    return entity;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    Entity entity = (Entity) o;
+    return getName().equals(entity.getName()) && getType().equals(entity.getType());
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(super.hashCode(), getName(), getType());
+  }
+}

core/src/main/java/feast/core/model/Feature.java

@@ -0,0 +1,194 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright 2018-2019 The Feast Authors
+ *
+ * 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
+ *
+ *     https://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 feast.core.model;
+
+import feast.core.FeatureSetProto.FeatureSpec;
+import feast.core.util.TypeConversion;
+import feast.types.ValueProto.ValueType;
+import java.util.Arrays;
+import java.util.Map;
+import java.util.Objects;
+import javax.persistence.*;
+import javax.persistence.Entity;
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * Feature belonging to a featureset. Contains name, type as well as domain metadata about the
+ * feature.
+ */
+@Getter
+@Setter
+@Entity
+@Table(
+    name = "features",
+    uniqueConstraints = @UniqueConstraint(columnNames = {"name", "feature_set_id"}))
+public class Feature {
+
+  @Id @GeneratedValue private Long id;
+
+  private String name;
+
+  @ManyToOne(fetch = FetchType.LAZY)
+  private FeatureSet featureSet;
+
+  /** Data type of the feature. String representation of {@link ValueType} * */
+  private String type;
+
+  // Labels for this feature
+  @Column(name = "labels", columnDefinition = "text")
+  private String labels;
+
+  // Presence constraints (refer to proto feast.core.FeatureSet.FeatureSpec)
+  // Only one of them can be set.
+  private byte[] presence;
+  private byte[] groupPresence;
+
+  // Shape type (refer to proto feast.core.FeatureSet.FeatureSpec)
+  // Only one of them can be set.
+  private byte[] shape;
+  private byte[] valueCount;
+
+  // Domain info for the values (refer to proto feast.core.FeatureSet.FeatureSpec)
+  // Only one of them can be set.
+  private String domain;
+  private byte[] intDomain;
+  private byte[] floatDomain;
+  private byte[] stringDomain;
+  private byte[] boolDomain;
+  private byte[] structDomain;
+  private byte[] naturalLanguageDomain;
+  private byte[] imageDomain;
+  private byte[] midDomain;
+  private byte[] urlDomain;
+  private byte[] timeDomain;
+  private byte[] timeOfDayDomain;
+
+  public Feature() {}
+
+  private Feature(String name, ValueType.Enum type) {
+    this.setName(name);
+    this.setType(type.toString());
+  }
+
+  public static Feature fromProto(FeatureSpec featureSpec) {
+    Feature feature = new Feature(featureSpec.getName(), featureSpec.getValueType());
+    feature.labels = TypeConversion.convertMapToJsonString(featureSpec.getLabelsMap());
+
+    switch (featureSpec.getPresenceConstraintsCase()) {
+      case PRESENCE:
+        feature.setPresence(featureSpec.getPresence().toByteArray());
+        break;
+      case GROUP_PRESENCE:
+        feature.setGroupPresence(featureSpec.getGroupPresence().toByteArray());
+        break;
+      case PRESENCECONSTRAINTS_NOT_SET:
+        break;
+    }
+
+    switch (featureSpec.getShapeTypeCase()) {
+      case SHAPE:
+        feature.setShape(featureSpec.getShape().toByteArray());
+        break;
+      case VALUE_COUNT:
+        feature.setValueCount(featureSpec.getValueCount().toByteArray());
+        break;
+      case SHAPETYPE_NOT_SET:
+        break;
+    }
+
+    switch (featureSpec.getDomainInfoCase()) {
+      case DOMAIN:
+        feature.setDomain(featureSpec.getDomain());
+        break;
+      case INT_DOMAIN:
+        feature.setIntDomain(featureSpec.getIntDomain().toByteArray());
+        break;
+      case FLOAT_DOMAIN:
+        feature.setFloatDomain(featureSpec.getFloatDomain().toByteArray());
+        break;
+      case STRING_DOMAIN:
+        feature.setStringDomain(featureSpec.getStringDomain().toByteArray());
+        break;
+      case BOOL_DOMAIN:
+        feature.setBoolDomain(featureSpec.getBoolDomain().toByteArray());
+        break;
+      case STRUCT_DOMAIN:
+        feature.setStructDomain(featureSpec.getStructDomain().toByteArray());
+        break;
+      case NATURAL_LANGUAGE_DOMAIN:
+        feature.setNaturalLanguageDomain(featureSpec.getNaturalLanguageDomain().toByteArray());
+        break;
+      case IMAGE_DOMAIN:
+        feature.setImageDomain(featureSpec.getImageDomain().toByteArray());
+        break;
+      case MID_DOMAIN:
+        feature.setMidDomain(featureSpec.getMidDomain().toByteArray());
+        break;
+      case URL_DOMAIN:
+        feature.setUrlDomain(featureSpec.getUrlDomain().toByteArray());
+        break;
+      case TIME_DOMAIN:
+        feature.setTimeDomain(featureSpec.getTimeDomain().toByteArray());
+        break;
+      case TIME_OF_DAY_DOMAIN:
+        feature.setTimeOfDayDomain(featureSpec.getTimeOfDayDomain().toByteArray());
+        break;
+      case DOMAININFO_NOT_SET:
+        break;
+    }
+    return feature;
+  }
+
+  public Map<String, String> getLabels() {
+    return TypeConversion.convertJsonStringToMap(this.labels);
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    Feature feature = (Feature) o;
+    return Objects.equals(getName(), feature.getName())
+        && Objects.equals(labels, feature.labels)
+        && Arrays.equals(getPresence(), feature.getPresence())
+        && Arrays.equals(getGroupPresence(), feature.getGroupPresence())
+        && Arrays.equals(getShape(), feature.getShape())
+        && Arrays.equals(getValueCount(), feature.getValueCount())
+        && Objects.equals(getDomain(), feature.getDomain())
+        && Arrays.equals(getIntDomain(), feature.getIntDomain())
+        && Arrays.equals(getFloatDomain(), feature.getFloatDomain())
+        && Arrays.equals(getStringDomain(), feature.getStringDomain())
+        && Arrays.equals(getBoolDomain(), feature.getBoolDomain())
+        && Arrays.equals(getStructDomain(), feature.getStructDomain())
+        && Arrays.equals(getNaturalLanguageDomain(), feature.getNaturalLanguageDomain())
+        && Arrays.equals(getImageDomain(), feature.getImageDomain())
+        && Arrays.equals(getMidDomain(), feature.getMidDomain())
+        && Arrays.equals(getUrlDomain(), feature.getUrlDomain())
+        && Arrays.equals(getTimeDomain(), feature.getTimeDomain())
+        && Arrays.equals(getTimeDomain(), feature.getTimeOfDayDomain());
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(super.hashCode(), getName(), getType(), getLabels());
+  }
+}