feat(dynamic facets): facet ordering support (#747)

Author: aallam

algoliasearch-core/src/main/java/com/algolia/search/models/indexing/SearchResult.java

@@ -1,5 +1,6 @@
 package com.algolia.search.models.indexing;
 
+import com.algolia.search.models.rules.RenderingContent;
 import com.algolia.search.util.AlgoliaUtils;
 import com.fasterxml.jackson.annotation.JsonSetter;
 import java.io.Serializable;
@@ -31,6 +32,7 @@ public class SearchResult<T> implements Serializable {
   private Boolean exhaustiveNbHits;
   private Integer appliedRelevancyStrictness;
   private Integer nbSortedHits;
+  private RenderingContent renderingContent;
 
   public Explain getExplain() {
     return explain;
@@ -131,6 +133,15 @@ public SearchResult<T> setQueryAfterRemoval(String queryAfterRemoval) {
     return this;
   }
 
+  public RenderingContent getRenderingContent() {
+    return renderingContent;
+  }
+
+  public SearchResult<T> setRenderingContent(RenderingContent renderingContent) {
+    this.renderingContent = renderingContent;
+    return this;
+  }
+
   private Long offset;
   private Long length;
   private String parsedQuery;
@@ -384,6 +395,9 @@ public String toString() {
         + '\''
         + ", nbSortedHits="
         + nbSortedHits
+        + '\''
+        + ", renderingContent="
+        + renderingContent
         + '}';
   }
 }

algoliasearch-core/src/main/java/com/algolia/search/models/rules/ConsequenceParams.java

@@ -84,6 +84,16 @@ public ConsequenceParams setAutomaticOptionalFacetFilters(
     return this;
   }
 
+  public RenderingContent getRenderingContent() {
+    return renderingContent;
+  }
+
+  public ConsequenceParams setRenderingContent(RenderingContent renderingContent) {
+    this.renderingContent = renderingContent;
+    return this;
+  }
+
+  private RenderingContent renderingContent;
   private ConsequenceQuery query;
 
   @JsonDeserialize(using = AutomaticFacetFilterDeserializer.class)

algoliasearch-core/src/main/java/com/algolia/search/models/rules/FacetOrdering.java

@@ -0,0 +1,56 @@
+package com.algolia.search.models.rules;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import java.io.Serializable;
+import java.util.Map;
+import java.util.Objects;
+
+/** Facets and facets values ordering rules container. */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class FacetOrdering implements Serializable {
+  private FacetsOrder facets;
+  private Map<String, FacetValuesOrder> values;
+
+  public FacetOrdering() {}
+
+  public FacetOrdering(FacetsOrder facets, Map<String, FacetValuesOrder> values) {
+    this.facets = facets;
+    this.values = values;
+  }
+
+  public FacetsOrder getFacets() {
+    return facets;
+  }
+
+  public FacetOrdering setFacets(FacetsOrder facets) {
+    this.facets = facets;
+    return this;
+  }
+
+  public Map<String, FacetValuesOrder> getValues() {
+    return values;
+  }
+
+  public FacetOrdering setValues(Map<String, FacetValuesOrder> values) {
+    this.values = values;
+    return this;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (!(o instanceof FacetOrdering)) return false;
+    FacetOrdering that = (FacetOrdering) o;
+    return Objects.equals(facets, that.facets) && Objects.equals(values, that.values);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(facets, values);
+  }
+
+  @Override
+  public String toString() {
+    return "FacetOrdering{" + "facets=" + facets + ", values=" + values + '}';
+  }
+}

algoliasearch-core/src/main/java/com/algolia/search/models/rules/FacetValuesOrder.java

@@ -0,0 +1,63 @@
+package com.algolia.search.models.rules;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import java.io.Serializable;
+import java.util.List;
+import java.util.Objects;
+
+/** Facet values ordering rule container. */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class FacetValuesOrder implements Serializable {
+  private List<String> order;
+  private String sortRemainingBy;
+
+  public FacetValuesOrder() {}
+
+  public FacetValuesOrder(List<String> order, String sortRemainingBy) {
+    this.order = order;
+    this.sortRemainingBy = sortRemainingBy;
+  }
+
+  public List<String> getOrder() {
+    return order;
+  }
+
+  public FacetValuesOrder setOrder(List<String> order) {
+    this.order = order;
+    return this;
+  }
+
+  public String getSortRemainingBy() {
+    return sortRemainingBy;
+  }
+
+  public FacetValuesOrder setSortRemainingBy(String sortRemainingBy) {
+    this.sortRemainingBy = sortRemainingBy;
+    return this;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (!(o instanceof FacetValuesOrder)) return false;
+    FacetValuesOrder that = (FacetValuesOrder) o;
+    return Objects.equals(order, that.order)
+        && Objects.equals(sortRemainingBy, that.sortRemainingBy);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(order, sortRemainingBy);
+  }
+
+  @Override
+  public String toString() {
+    return "FacetValuesOrder{"
+        + "order="
+        + order
+        + ", sortRemainingBy='"
+        + sortRemainingBy
+        + '\''
+        + '}';
+  }
+}

algoliasearch-core/src/main/java/com/algolia/search/models/rules/FacetsOrder.java

@@ -0,0 +1,45 @@
+package com.algolia.search.models.rules;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import java.io.Serializable;
+import java.util.List;
+import java.util.Objects;
+
+/** Define or override the way facet attributes are displayed. */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class FacetsOrder implements Serializable {
+  private List<String> order;
+
+  public FacetsOrder() {}
+
+  public FacetsOrder(List<String> order) {
+    this.order = order;
+  }
+
+  public List<String> getOrder() {
+    return order;
+  }
+
+  public FacetsOrder setOrder(List<String> order) {
+    this.order = order;
+    return this;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (!(o instanceof FacetsOrder)) return false;
+    FacetsOrder that = (FacetsOrder) o;
+    return Objects.equals(order, that.order);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(order);
+  }
+
+  @Override
+  public String toString() {
+    return "FacetsOrder{" + "order=" + order + '}';
+  }
+}

algoliasearch-core/src/main/java/com/algolia/search/models/rules/RenderingContent.java

@@ -0,0 +1,47 @@
+package com.algolia.search.models.rules;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import java.io.Serializable;
+import java.util.Objects;
+
+/**
+ * Content defining how the search interface should be rendered. This is set via the settings for a
+ * default value and can be overridden via rules.
+ */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class RenderingContent implements Serializable {
+  private FacetOrdering facetOrdering;
+
+  public RenderingContent() {}
+
+  public RenderingContent(FacetOrdering facetOrdering) {
+    this.facetOrdering = facetOrdering;
+  }
+
+  public FacetOrdering getFacetOrdering() {
+    return facetOrdering;
+  }
+
+  public RenderingContent setFacetOrdering(FacetOrdering facetOrdering) {
+    this.facetOrdering = facetOrdering;
+    return this;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (!(o instanceof RenderingContent)) return false;
+    RenderingContent that = (RenderingContent) o;
+    return Objects.equals(facetOrdering, that.facetOrdering);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(facetOrdering);
+  }
+
+  @Override
+  public String toString() {
+    return "RenderingContent{" + "facetOrdering=" + facetOrdering + '}';
+  }
+}

algoliasearch-core/src/main/java/com/algolia/search/models/settings/IndexSettings.java

@@ -1,6 +1,13 @@
 package com.algolia.search.models.settings;
 
-import com.fasterxml.jackson.annotation.*;
+import com.algolia.search.models.rules.RenderingContent;
+import com.fasterxml.jackson.annotation.JsonAnyGetter;
+import com.fasterxml.jackson.annotation.JsonAnySetter;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonSetter;
 import java.io.Serializable;
 import java.util.HashMap;
 import java.util.List;
@@ -104,6 +111,9 @@ public class IndexSettings implements Serializable {
   /* Virtual Indices */
   protected Integer relevancyStrictness;
 
+  /* Facets Ordering */
+  private RenderingContent renderingContent;
+
   public List<String> getAttributesForFaceting() {
     return attributesForFaceting;
   }
@@ -712,6 +722,15 @@ public IndexSettings setRelevancyStrictness(Integer relevancyStrictness) {
     return this;
   }
 
+  public RenderingContent getRenderingContent() {
+    return renderingContent;
+  }
+
+  public IndexSettings setRenderingContent(RenderingContent renderingContent) {
+    this.renderingContent = renderingContent;
+    return this;
+  }
+
   @Override
   public String toString() {
     return "IndexSettings{"
@@ -826,6 +845,9 @@ public String toString() {
         + '\''
         + ", decompoundQuery="
         + decompoundQuery
+        + '\''
+        + ", renderingContent="
+        + renderingContent
         + '}';
   }
 }