Publish

1 files changed, 30 insertions, 0 deletions

diff --git a/container-search/src/main/java/com/yahoo/search/result/HitOrderer.java b/container-search/src/main/java/com/yahoo/search/result/HitOrderer.java
new file mode 100644
index 00000000000..5982a93d86a
--- /dev/null
+++ b/container-search/src/main/java/com/yahoo/search/result/HitOrderer.java
@@ -0,0 +1,30 @@
+// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
+package com.yahoo.search.result;
+
+import java.util.Comparator;
+import java.util.List;
+
+/**
+ * A class capable of ordering a list of hits
+ *
+ * @author <a href="mailto:bratseth@yahoo-inc.com">Jon S Bratseth</a>
+ */
+
+public abstract class HitOrderer {
+
+    /** Orders the given list of hits */
+    public abstract void order(List<Hit> hits);
+
+    /**
+     * Returns the Comparator that this HitOrderer uses internally to
+     * sort hits. Returns null if no Comparator is used.
+     * <p>
+     * This default implementation returns null.
+     *
+     * @return the Comparator used to order hits, or null
+     */
+    public Comparator<Hit> getComparator() {
+        return null;
+    }
+
+}