Scripts should expose whether they use the _score or not

Changes related to elastic#12695

Author: imotov

src/main/java/org/elasticsearch/examples/nativescript/script/CosineSimilarityScoreScript.java

@@ -47,11 +47,6 @@ public class CosineSimilarityScoreScript extends AbstractSearchScript {
 
     final static public String SCRIPT_NAME = "cosine_sim_script_score";
 
-    @Override
-    public void setScorer(Scorer scorer) {
-        // ignore
-    }
-
     /**
      * Factory that is registered in
      * {@link org.elasticsearch.examples.nativescript.plugin.NativeScriptExamplesPlugin#onModule(org.elasticsearch.script.ScriptModule)}
@@ -70,6 +65,16 @@ public static class Factory implements NativeScriptFactory {
         public ExecutableScript newScript(@Nullable Map<String, Object> params) throws ScriptException {
             return new CosineSimilarityScoreScript(params);
         }
+
+        /**
+         * Indicates if document scores may be needed by the produced scripts.
+         *
+         * @return {@code true} if scores are needed.
+         */
+        @Override
+        public boolean needsScores() {
+            return false;
+        }
     }
 
     /**

src/main/java/org/elasticsearch/examples/nativescript/script/IsPrimeSearchScript.java

@@ -60,6 +60,17 @@ public ExecutableScript newScript(@Nullable Map<String, Object> params) {
             int certainty = params == null ? 10 : XContentMapValues.nodeIntegerValue(params.get("certainty"), 10);
             return new IsPrimeSearchScript(fieldName, certainty);
         }
+
+        /**
+         * Indicates if document scores may be needed by the produced scripts.
+         *
+         * @return {@code true} if scores are needed.
+         */
+        @Override
+        public boolean needsScores() {
+            return false;
+        }
+
     }
 
     private final String fieldName;

src/main/java/org/elasticsearch/examples/nativescript/script/LanguageModelScoreScript.java

@@ -49,11 +49,6 @@ public class LanguageModelScoreScript extends AbstractSearchScript {
 
     final static public String SCRIPT_NAME = "language_model_script_score";
 
-    @Override
-    public void setScorer(Scorer scorer) {
-        // ignore
-    }
-
     /**
      * Factory that is registered in
      * {@link org.elasticsearch.examples.nativescript.plugin.NativeScriptExamplesPlugin#onModule(org.elasticsearch.script.ScriptModule)}
@@ -72,6 +67,13 @@ public static class Factory implements NativeScriptFactory {
         public ExecutableScript newScript(@Nullable Map<String, Object> params) {
             return new LanguageModelScoreScript(params);
         }
+
+
+        @Override
+        public boolean needsScores() {
+            return false;
+        }
+
     }
 
     /**

src/main/java/org/elasticsearch/examples/nativescript/script/LookupScript.java

@@ -106,6 +106,17 @@ public ExecutableScript newScript(@Nullable Map<String, Object> params) {
             }
             return new LookupScript(node.client(), logger, cache, lookupIndex, lookupType, field);
         }
+
+        /**
+         * Indicates if document scores may be needed by the produced scripts.
+         *
+         * @return {@code true} if scores are needed.
+         */
+        @Override
+        public boolean needsScores() {
+            return false;
+        }
+
     }
 
     private final String lookupIndex;

src/main/java/org/elasticsearch/examples/nativescript/script/PhraseScoreScript.java

@@ -44,11 +44,6 @@ public class PhraseScoreScript extends AbstractSearchScript {
 
     final static public String SCRIPT_NAME = "phrase_script_score";
 
-    @Override
-    public void setScorer(Scorer scorer) {
-        // ignore
-    }
-
     /**
      * Factory that is registered in
      * {@link org.elasticsearch.examples.nativescript.plugin.NativeScriptExamplesPlugin#onModule(org.elasticsearch.script.ScriptModule)}
@@ -67,6 +62,16 @@ public static class Factory implements NativeScriptFactory {
         public ExecutableScript newScript(@Nullable Map<String, Object> params) {
             return new PhraseScoreScript(params);
         }
+
+        /**
+         * Indicates if document scores may be needed by the produced scripts.
+         *
+         * @return {@code true} if scores are needed.
+         */
+        @Override
+        public boolean needsScores() {
+            return false;
+        }
     }
 
     /**

src/main/java/org/elasticsearch/examples/nativescript/script/PopularityScoreScriptFactory.java

@@ -42,6 +42,15 @@ public ExecutableScript newScript(@Nullable Map<String, Object> params) {
         return new PopularityScoreScript(fieldName);
     }
 
+    /**
+     * Indicates if document scores may be needed by the produced scripts.
+     *
+     * @return {@code true} if scores are needed.
+     */
+    @Override
+    public boolean needsScores() {
+        return true;
+    }
 
     /**
      * This script takes a numeric value from the field specified in the parameter field. And calculates boost

src/main/java/org/elasticsearch/examples/nativescript/script/RandomSortScriptFactory.java

@@ -55,6 +55,16 @@ public ExecutableScript newScript(@Nullable Map<String, Object> params) {
         }
     }
 
+    /**
+     * Indicates if document scores may be needed by the produced scripts.
+     *
+     * @return {@code true} if scores are needed.
+     */
+    @Override
+    public boolean needsScores() {
+        return false;
+    }
+
     private static class RandomSortScript extends AbstractLongSearchScript {
         private final Random random;
 
@@ -66,11 +76,6 @@ private RandomSortScript() {
         public long runAsLong() {
             return random.nextLong();
         }
-
-        @Override
-        public void setScorer(Scorer scorer) {
-            // we are not using it - ignore
-        }
     }
 
     private static class PseudoRandomSortScript extends AbstractLongSearchScript {
@@ -100,10 +105,5 @@ public long runAsLong() {
                 return -1;
             }
         }
-
-        @Override
-        public void setScorer(Scorer scorer) {
-            // we are not using it - ignore
-        }
     }
 }

src/main/java/org/elasticsearch/examples/nativescript/script/TFIDFScoreScript.java

@@ -43,11 +43,6 @@ public class TFIDFScoreScript extends AbstractSearchScript {
 
     final static public String SCRIPT_NAME = "tfidf_script_score";
 
-    @Override
-    public void setScorer(Scorer scorer) {
-        // ignore
-    }
-
     /**
      * Factory that is registered in
      * {@link org.elasticsearch.examples.nativescript.plugin.NativeScriptExamplesPlugin#onModule(org.elasticsearch.script.ScriptModule)}
@@ -66,6 +61,16 @@ public static class Factory implements NativeScriptFactory {
         public ExecutableScript newScript(@Nullable Map<String, Object> params) {
             return new TFIDFScoreScript(params);
         }
+
+        /**
+         * Indicates if document scores may be needed by the produced scripts.
+         *
+         * @return {@code true} if scores are needed.
+         */
+        @Override
+        public boolean needsScores() {
+            return false;
+        }
     }
 
     /**