epotyom commented on code in PR #13568: URL: https://github.com/apache/lucene/pull/13568#discussion_r1692974080
########## lucene/sandbox/src/java/org/apache/lucene/sandbox/facet/ComparableUtils.java: ########## @@ -0,0 +1,179 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.lucene.sandbox.facet; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import org.apache.lucene.sandbox.facet.ordinals.OrdToComparable; +import org.apache.lucene.sandbox.facet.ordinals.OrdinalGetter; +import org.apache.lucene.sandbox.facet.recorders.CountFacetRecorder; +import org.apache.lucene.sandbox.facet.recorders.LongAggregationsFacetRecorder; +import org.apache.lucene.util.InPlaceMergeSorter; + +/** + * Collection of static methods to provide most common comparables for sandbox faceting. You can + * also use it as an example for creating your own {@link OrdToComparable} to enable custom facets + * top-n and sorting. + */ +public class ComparableUtils { + private ComparableUtils() {} + + private static class SkeletalOrdGetter implements OrdinalGetter { + int ord; + + @Override + public int getOrd() { + return ord; + } + } + + /** {@link OrdToComparable} that can be used to sort by ords (ascending). */ + public static OrdToComparable<ComparableOrd> ordToComparableOrd() { + return new OrdToComparable<>() { + @Override + public ComparableOrd getComparable(int ord, ComparableOrd reuse) { + if (reuse == null) { + reuse = new ComparableOrd(); + } + reuse.ord = ord; + return reuse; + } + }; + } + + /** Used for {@link #ordToComparableOrd} result. */ + public static class ComparableOrd extends SkeletalOrdGetter implements Comparable<ComparableOrd> { + @Override + public int compareTo(ComparableOrd o) { + return Integer.compare(o.ord, ord); + } + } + + /** + * {@link OrdToComparable} that can be used to sort ordinals by count (descending) with ord as a + * tie-break (ascending) using provided {@link CountFacetRecorder}. + */ + public static OrdToComparable<ComparableIntOrd> ordToComparableCountOrd( + CountFacetRecorder recorder) { + return new OrdToComparable<>() { + @Override + public ComparableIntOrd getComparable(int ord, ComparableIntOrd reuse) { + if (reuse == null) { + reuse = new ComparableIntOrd(); + } + reuse.ord = ord; + reuse.rank = recorder.getCount(ord); + return reuse; + } + }; + } + + /** Used for {@link #ordToComparableCountOrd} result. */ + public static class ComparableIntOrd extends SkeletalOrdGetter + implements Comparable<ComparableIntOrd> { + private ComparableIntOrd() {} + + private int rank; + + @Override + public int compareTo(ComparableIntOrd o) { + int cmp = Integer.compare(rank, o.rank); + if (cmp == 0) { + cmp = Integer.compare(o.ord, ord); + } + return cmp; + } + } + + /** + * {@link OrdToComparable} to sort ordinals by long aggregation (descending) with tie-break by + * count (descending) with ordinal as a tie-break (ascending) using provided {@link + * CountFacetRecorder} and {@link LongAggregationsFacetRecorder}. + */ + public static OrdToComparable<ComparableLongIntOrd> ordToComparableRankCountOrd( + CountFacetRecorder countRecorder, + LongAggregationsFacetRecorder longAggregationsFacetRecorder, + int aggregationId) { + return new OrdToComparable<>() { + @Override + public ComparableLongIntOrd getComparable(int ord, ComparableLongIntOrd reuse) { + if (reuse == null) { + reuse = new ComparableLongIntOrd(); + } + reuse.ord = ord; + reuse.secondaryRank = countRecorder.getCount(ord); + reuse.primaryRank = longAggregationsFacetRecorder.getRecordedValue(ord, aggregationId); + return reuse; + } + }; + } + + /** Used for {@link #ordToComparableRankCountOrd} result. */ + public static class ComparableLongIntOrd extends SkeletalOrdGetter + implements Comparable<ComparableLongIntOrd> { + private ComparableLongIntOrd() {} + ; Review Comment: Oh, another one - sorry🪳 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
