Skip to content
Permalink
Browse files

Add an interface to be implemented by native scripts to be able to ex…

…plain the score
  • Loading branch information
hibnico authored and kimchy committed Jul 5, 2012
1 parent 07b523b commit 9ceb9a564619117a1e35e2fad02b9a0a1ef3870f
@@ -27,6 +27,7 @@
import org.elasticsearch.common.lucene.search.function.FunctionScoreQuery;
import org.elasticsearch.common.lucene.search.function.ScoreFunction;
import org.elasticsearch.common.xcontent.XContentParser;
import org.elasticsearch.script.ExplanableSearchScript;
import org.elasticsearch.script.SearchScript;

import java.io.IOException;
@@ -131,8 +132,15 @@ public float factor(int docId) {

@Override
public Explanation explainScore(int docId, Explanation subQueryExpl) {
float score = score(docId, subQueryExpl.getValue());
Explanation exp = new Explanation(score, "script score function: product of:");
Explanation exp;
if (script instanceof ExplanableSearchScript) {
script.setNextDocId(docId);
script.setNextScore(subQueryExpl.getValue());
exp = ((ExplanableSearchScript) script).explain();
} else {
float score = score(docId, subQueryExpl.getValue());
exp = new Explanation(score, "script score function: product of:");
}
exp.addDetail(subQueryExpl);
return exp;
}
@@ -0,0 +1,35 @@
/*
* Licensed to Elastic Search under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. Elastic Search 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.elasticsearch.script;

import org.apache.lucene.search.Explanation;

/**
* To be implemented by {@link SearchScript} which can provided an {@link Explanation} of the score
*/
public interface ExplanableSearchScript {

/**
* Build the explanation of the current document being scored
*
* @return
*/
Explanation explain();

}
@@ -26,6 +26,8 @@

/**
* A search script.
*
* @see ExplanableSearchScript for script which can explain a score
*/
public interface SearchScript extends ExecutableScript {

0 comments on commit 9ceb9a5

Please sign in to comment.
You can’t perform that action at this time.