You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ro...@apache.org on 2016/06/29 08:32:05 UTC
[1/3] lucene-solr:branch_6x: LUCENE-7360: Explanation.toHtml() is
deprecated
Repository: lucene-solr
Updated Branches:
refs/heads/branch_6x eaabb9dc7 -> d33ad81d6
refs/heads/master 4070bdd8d -> f3dcd467f
LUCENE-7360: Explanation.toHtml() is deprecated
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/d33ad81d
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/d33ad81d
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/d33ad81d
Branch: refs/heads/branch_6x
Commit: d33ad81d69ed8f96a2e7b8b00f4616c979378cd4
Parents: eaabb9d
Author: Alan Woodward <ro...@apache.org>
Authored: Wed Jun 29 09:08:16 2016 +0100
Committer: Alan Woodward <ro...@apache.org>
Committed: Wed Jun 29 09:13:15 2016 +0100
----------------------------------------------------------------------
lucene/CHANGES.txt | 2 ++
.../org/apache/lucene/search/Explanation.java | 1 +
.../transform/ExplainAugmenterFactory.java | 22 +++++++++++++++++++-
3 files changed, 24 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/d33ad81d/lucene/CHANGES.txt
----------------------------------------------------------------------
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index f6ec714..912e601 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -71,6 +71,8 @@ Other
* LUCENE-7346: Update forbiddenapis to version 2.2.
(Uwe Schindler)
+
+* LUCENE-7360: Explanation.toHtml() is deprecated. (Alan Woodward)
======================= Lucene 6.1.0 =======================
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/d33ad81d/lucene/core/src/java/org/apache/lucene/search/Explanation.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/search/Explanation.java b/lucene/core/src/java/org/apache/lucene/search/Explanation.java
index 70bf8bc..3e5951a 100644
--- a/lucene/core/src/java/org/apache/lucene/search/Explanation.java
+++ b/lucene/core/src/java/org/apache/lucene/search/Explanation.java
@@ -123,6 +123,7 @@ public final class Explanation {
/** Render an explanation as HTML. */
+ @Deprecated
public String toHtml() {
StringBuilder buffer = new StringBuilder();
buffer.append("<ul>\n");
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/d33ad81d/solr/core/src/java/org/apache/solr/response/transform/ExplainAugmenterFactory.java
----------------------------------------------------------------------
diff --git a/solr/core/src/java/org/apache/solr/response/transform/ExplainAugmenterFactory.java b/solr/core/src/java/org/apache/solr/response/transform/ExplainAugmenterFactory.java
index 71e4094..f9e1ec6 100644
--- a/solr/core/src/java/org/apache/solr/response/transform/ExplainAugmenterFactory.java
+++ b/solr/core/src/java/org/apache/solr/response/transform/ExplainAugmenterFactory.java
@@ -70,6 +70,26 @@ public class ExplainAugmenterFactory extends TransformerFactory
return new ExplainAugmenter( field, style );
}
+ /** Render an explanation as HTML. */
+ public static String toHtml(Explanation explanation) {
+ StringBuilder buffer = new StringBuilder();
+ buffer.append("<ul>\n");
+
+ buffer.append("<li>");
+ buffer.append(explanation.getValue()).append(" = ").append(explanation.getDescription());
+ buffer.append("<br />\n");
+
+ Explanation[] details = explanation.getDetails();
+ for (int i = 0 ; i < details.length; i++) {
+ buffer.append(toHtml(details[i]));
+ }
+
+ buffer.append("</li>\n");
+ buffer.append("</ul>\n");
+
+ return buffer.toString();
+ }
+
static class ExplainAugmenter extends DocTransformer {
final String name;
final Style style;
@@ -95,7 +115,7 @@ public class ExplainAugmenterFactory extends TransformerFactory
doc.setField( name, SolrPluginUtils.explanationToNamedList(exp) );
}
else if( style == Style.html ) {
- doc.setField( name, exp.toHtml() );
+ doc.setField( name, toHtml(exp));
}
else {
doc.setField( name, exp.toString() );
[3/3] lucene-solr:master: LUCENE-7360: Remove Explanation.toHtml()
Posted by ro...@apache.org.
LUCENE-7360: Remove Explanation.toHtml()
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/f3dcd467
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/f3dcd467
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/f3dcd467
Branch: refs/heads/master
Commit: f3dcd467ff391ae7988cbc0576cc2c1bdb5caaa5
Parents: 23119db
Author: Alan Woodward <ro...@apache.org>
Authored: Wed Jun 29 09:16:13 2016 +0100
Committer: Alan Woodward <ro...@apache.org>
Committed: Wed Jun 29 09:16:13 2016 +0100
----------------------------------------------------------------------
lucene/CHANGES.txt | 2 ++
lucene/MIGRATE.txt | 4 ++++
.../org/apache/lucene/search/Explanation.java | 23 +-------------------
3 files changed, 7 insertions(+), 22 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/f3dcd467/lucene/CHANGES.txt
----------------------------------------------------------------------
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index 14455ba..22f86b2 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -15,6 +15,8 @@ Other
* LUCENE-6968: LSH Filter (Tommaso Teofili, Andy Hind, Cao Manh Dat)
+* LUCENE-7360: Remove Explanation.toHtml() (Alan Woodward)
+
======================= Lucene 6.2.0 =======================
New Features
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/f3dcd467/lucene/MIGRATE.txt
----------------------------------------------------------------------
diff --git a/lucene/MIGRATE.txt b/lucene/MIGRATE.txt
index d9cfefb..2c9bc9c 100644
--- a/lucene/MIGRATE.txt
+++ b/lucene/MIGRATE.txt
@@ -14,3 +14,7 @@ yielding better compression ratios. In case you would still like to compress on
top of the codec, you can do it on the application side by using the utility
classes from the java.util.zip package.
+## Explanation.toHtml() removed (LUCENE-7360)
+
+Clients wishing to render Explanations as HTML should implement their own
+utilities for this.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/f3dcd467/lucene/core/src/java/org/apache/lucene/search/Explanation.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/search/Explanation.java b/lucene/core/src/java/org/apache/lucene/search/Explanation.java
index 3e5951a..818f83f 100644
--- a/lucene/core/src/java/org/apache/lucene/search/Explanation.java
+++ b/lucene/core/src/java/org/apache/lucene/search/Explanation.java
@@ -120,26 +120,5 @@ public final class Explanation {
return buffer.toString();
}
-
-
- /** Render an explanation as HTML. */
- @Deprecated
- public String toHtml() {
- StringBuilder buffer = new StringBuilder();
- buffer.append("<ul>\n");
-
- buffer.append("<li>");
- buffer.append(getSummary());
- buffer.append("<br />\n");
-
- Explanation[] details = getDetails();
- for (int i = 0 ; i < details.length; i++) {
- buffer.append(details[i].toHtml());
- }
-
- buffer.append("</li>\n");
- buffer.append("</ul>\n");
-
- return buffer.toString();
- }
+
}
[2/3] lucene-solr:master: LUCENE-7360: Explanation.toHtml() is
deprecated
Posted by ro...@apache.org.
LUCENE-7360: Explanation.toHtml() is deprecated
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/23119db3
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/23119db3
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/23119db3
Branch: refs/heads/master
Commit: 23119db3606732986d31c6e44ec26fbbde79ef75
Parents: 4070bdd
Author: Alan Woodward <ro...@apache.org>
Authored: Wed Jun 29 09:08:16 2016 +0100
Committer: Alan Woodward <ro...@apache.org>
Committed: Wed Jun 29 09:13:29 2016 +0100
----------------------------------------------------------------------
lucene/CHANGES.txt | 2 ++
.../org/apache/lucene/search/Explanation.java | 1 +
.../transform/ExplainAugmenterFactory.java | 22 +++++++++++++++++++-
3 files changed, 24 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/23119db3/lucene/CHANGES.txt
----------------------------------------------------------------------
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index e0f11c3..14455ba 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -81,6 +81,8 @@ Other
* LUCENE-7346: Update forbiddenapis to version 2.2.
(Uwe Schindler)
+
+* LUCENE-7360: Explanation.toHtml() is deprecated. (Alan Woodward)
======================= Lucene 6.1.0 =======================
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/23119db3/lucene/core/src/java/org/apache/lucene/search/Explanation.java
----------------------------------------------------------------------
diff --git a/lucene/core/src/java/org/apache/lucene/search/Explanation.java b/lucene/core/src/java/org/apache/lucene/search/Explanation.java
index 70bf8bc..3e5951a 100644
--- a/lucene/core/src/java/org/apache/lucene/search/Explanation.java
+++ b/lucene/core/src/java/org/apache/lucene/search/Explanation.java
@@ -123,6 +123,7 @@ public final class Explanation {
/** Render an explanation as HTML. */
+ @Deprecated
public String toHtml() {
StringBuilder buffer = new StringBuilder();
buffer.append("<ul>\n");
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/23119db3/solr/core/src/java/org/apache/solr/response/transform/ExplainAugmenterFactory.java
----------------------------------------------------------------------
diff --git a/solr/core/src/java/org/apache/solr/response/transform/ExplainAugmenterFactory.java b/solr/core/src/java/org/apache/solr/response/transform/ExplainAugmenterFactory.java
index 71e4094..f9e1ec6 100644
--- a/solr/core/src/java/org/apache/solr/response/transform/ExplainAugmenterFactory.java
+++ b/solr/core/src/java/org/apache/solr/response/transform/ExplainAugmenterFactory.java
@@ -70,6 +70,26 @@ public class ExplainAugmenterFactory extends TransformerFactory
return new ExplainAugmenter( field, style );
}
+ /** Render an explanation as HTML. */
+ public static String toHtml(Explanation explanation) {
+ StringBuilder buffer = new StringBuilder();
+ buffer.append("<ul>\n");
+
+ buffer.append("<li>");
+ buffer.append(explanation.getValue()).append(" = ").append(explanation.getDescription());
+ buffer.append("<br />\n");
+
+ Explanation[] details = explanation.getDetails();
+ for (int i = 0 ; i < details.length; i++) {
+ buffer.append(toHtml(details[i]));
+ }
+
+ buffer.append("</li>\n");
+ buffer.append("</ul>\n");
+
+ return buffer.toString();
+ }
+
static class ExplainAugmenter extends DocTransformer {
final String name;
final Style style;
@@ -95,7 +115,7 @@ public class ExplainAugmenterFactory extends TransformerFactory
doc.setField( name, SolrPluginUtils.explanationToNamedList(exp) );
}
else if( style == Style.html ) {
- doc.setField( name, exp.toHtml() );
+ doc.setField( name, toHtml(exp));
}
else {
doc.setField( name, exp.toString() );