Skip to content

[Backport 2.19-dev] Followup: Change ComparableLinkedHashMap to compare Key than Value #4655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LantaoJin merged 1 commit into from
Oct 24, 2025
Merged

[Backport 2.19-dev] Followup: Change ComparableLinkedHashMap to compare Key than Value #4655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions core/src/main/java/org/opensearch/sql/data/utils/ComparableLinkedHashMap.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,29 @@ private int compareRecursive(
if (!thisHasNext) return -1;
if (!otherHasNext) return 1;

V thisValue = thisIterator.next().getValue();
V otherValue = otherIterator.next().getValue();
int comparison = compareValues(thisValue, otherValue);
Map.Entry<K, V> thisEntry = thisIterator.next();
Map.Entry<K, V> otherEntry = otherIterator.next();
K thisKey = thisEntry.getKey();
K otherKey = otherEntry.getKey();
V thisValue = thisEntry.getValue();
V otherValue = otherEntry.getValue();
int comparison = compareKV(thisKey, otherKey, thisValue, otherValue);
if (comparison != 0) return comparison;
return compareRecursive(thisIterator, otherIterator);
}

@SuppressWarnings("unchecked")
private int compareValues(V value1, V value2) {
private int compareKV(K key1, K key2, V value1, V value2) {
int keyCompare;
if (key1 instanceof Comparable) {
keyCompare = ((Comparable<K>) key1).compareTo(key2);
} else {
keyCompare = key1.toString().compareTo(key2.toString());
}
if (keyCompare != 0) {
return keyCompare;
}

if (value1 == null && value2 == null) return 0;
if (value1 == null) return -1;
if (value2 == null) return 1;
Expand Down
75 changes: 43 additions & 32 deletions core/src/test/java/org/opensearch/sql/utils/ComparableLinkedHashMapTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,26 @@ public void testOneEmptyMap() {
assertTrue(map2.compareTo(map1) > 0);
}

@Test
public void testDifferentKeys() {
ComparableLinkedHashMap<String, Integer> map1 = new ComparableLinkedHashMap<>();
map1.put("a", 1);

ComparableLinkedHashMap<String, Integer> map2 = new ComparableLinkedHashMap<>();
map2.put("b", 1);

assertTrue(map1.compareTo(map2) < 0);
}

@Test
public void testEqualMaps() {
ComparableLinkedHashMap<String, Integer> map1 = new ComparableLinkedHashMap<>();
map1.put("a", 1);
map1.put("b", 2);

ComparableLinkedHashMap<String, Integer> map2 = new ComparableLinkedHashMap<>();
map2.put("c", 1);
map2.put("d", 2);
map2.put("a", 1);
map2.put("b", 2);

assertEquals(0, map1.compareTo(map2));
}
Expand All @@ -54,8 +65,8 @@ public void testDifferentFirstValue() {
map1.put("b", 2);

ComparableLinkedHashMap<String, Integer> map2 = new ComparableLinkedHashMap<>();
map2.put("c", 3);
map2.put("d", 2);
map2.put("a", 3);
map2.put("b", 2);

assertTrue(map1.compareTo(map2) < 0);
assertTrue(map2.compareTo(map1) > 0);
Expand All @@ -69,9 +80,9 @@ public void testDifferentLaterValue() {
map1.put("c", 3);

ComparableLinkedHashMap<String, Integer> map2 = new ComparableLinkedHashMap<>();
map2.put("d", 1);
map2.put("e", 3);
map2.put("f", 3);
map2.put("a", 1);
map2.put("b", 3);
map2.put("c", 3);

assertTrue(map1.compareTo(map2) < 0);
assertTrue(map2.compareTo(map1) > 0);
Expand All @@ -84,7 +95,7 @@ public void testDifferentSizes() {
map1.put("b", 2);

ComparableLinkedHashMap<String, Integer> map2 = new ComparableLinkedHashMap<>();
map2.put("c", 1);
map2.put("a", 1);

assertTrue(map1.compareTo(map2) > 0);
assertTrue(map2.compareTo(map1) < 0);
Expand All @@ -97,15 +108,15 @@ public void testNullValues() {
map1.put("b", 2);

ComparableLinkedHashMap<String, Integer> map2 = new ComparableLinkedHashMap<>();
map2.put("c", 1);
map2.put("d", 2);
map2.put("a", 1);
map2.put("b", 2);

assertTrue(map1.compareTo(map2) < 0);
assertTrue(map2.compareTo(map1) > 0);

ComparableLinkedHashMap<String, Integer> map3 = new ComparableLinkedHashMap<>();
map3.put("e", null);
map3.put("f", 2);
map3.put("a", null);
map3.put("b", 2);

assertEquals(0, map1.compareTo(map3));
}
Expand All @@ -130,8 +141,8 @@ public String toString() {
map1.put("b", new Person("Bob"));

ComparableLinkedHashMap<String, Person> map2 = new ComparableLinkedHashMap<>();
map2.put("c", new Person("Alice"));
map2.put("d", new Person("Charlie"));
map2.put("a", new Person("Alice"));
map2.put("b", new Person("Charlie"));

assertTrue(map1.compareTo(map2) < 0);
assertTrue(map2.compareTo(map1) > 0);
Expand All @@ -144,14 +155,14 @@ public void testMixedTypes() {
map1.put("b", "test");

ComparableLinkedHashMap<String, Object> map2 = new ComparableLinkedHashMap<>();
map2.put("c", 1);
map2.put("d", "test");
map2.put("a", 1);
map2.put("b", "test");

assertEquals(0, map1.compareTo(map2));

ComparableLinkedHashMap<String, Object> map3 = new ComparableLinkedHashMap<>();
map3.put("e", 1);
map3.put("f", "test2");
map3.put("a", 1);
map3.put("b", "test2");

assertTrue(map1.compareTo(map3) < 0);
assertTrue(map3.compareTo(map1) > 0);
Expand All @@ -166,12 +177,12 @@ public void testWithTreeSet() {
map1.put("b", 2);

ComparableLinkedHashMap<String, Integer> map2 = new ComparableLinkedHashMap<>();
map2.put("c", 1);
map2.put("d", 3);
map2.put("a", 1);
map2.put("b", 3);

ComparableLinkedHashMap<String, Integer> map3 = new ComparableLinkedHashMap<>();
map3.put("e", 0);
map3.put("f", 4);
map3.put("a", 0);
map3.put("b", 4);

set.add(map2);
set.add(map1);
Expand All @@ -182,14 +193,14 @@ public void testWithTreeSet() {
ComparableLinkedHashMap<String, Integer> second = iterator.next();
ComparableLinkedHashMap<String, Integer> third = iterator.next();

assertEquals(Integer.valueOf(0), first.get("e"));
assertEquals(Integer.valueOf(4), first.get("f"));
assertEquals(Integer.valueOf(0), first.get("a"));
assertEquals(Integer.valueOf(4), first.get("b"));

assertEquals(Integer.valueOf(1), second.get("a"));
assertEquals(Integer.valueOf(2), second.get("b"));

assertEquals(Integer.valueOf(1), third.get("c"));
assertEquals(Integer.valueOf(3), third.get("d"));
assertEquals(Integer.valueOf(1), third.get("a"));
assertEquals(Integer.valueOf(3), third.get("b"));

assertEquals(3, set.size());
}
Expand All @@ -203,7 +214,7 @@ public void testWithComparator() {
map1.put("a", 5);

ComparableLinkedHashMap<String, Integer> map2 = new ComparableLinkedHashMap<>();
map2.put("b", 3);
map2.put("a", 3);

assertTrue(comparator.compare(map1, map2) > 0);
assertTrue(comparator.compare(map2, map1) < 0);
Expand All @@ -221,7 +232,7 @@ public void testEqualValuesDifferentKeys() {
map2.put("e", 2);
map2.put("f", 3);

assertEquals(0, map1.compareTo(map2));
assertTrue(map1.compareTo(map2) < 0);
}

@Test
Expand All @@ -231,8 +242,8 @@ public void testDifferentOrder() {
map1.put("b", 2);

ComparableLinkedHashMap<String, Integer> map2 = new ComparableLinkedHashMap<>();
map2.put("c", 2);
map2.put("d", 1);
map2.put("a", 2);
map2.put("b", 1);

assertTrue(map1.compareTo(map2) < 0);
assertTrue(map2.compareTo(map1) > 0);
Expand All @@ -247,12 +258,12 @@ public void testLargeMaps() {

ComparableLinkedHashMap<String, Integer> map2 = new ComparableLinkedHashMap<>();
for (int i = 0; i < 100; i++) {
map2.put("differentKey" + i, i);
map2.put("key" + i, i);
}

assertEquals(0, map1.compareTo(map2));

map2.put("differentKey99", 100);
map2.put("key", 100);
assertTrue(map1.compareTo(map2) < 0);
}
}
Loading