1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (build 1.6.0_30) on Tue Nov 19 11:16:53 CET 2013 -->
6 <META http-equiv="Content-Type" content="text/html; charset=utf-8">
8 ScoreAugmenter (Solr 4.6.0 API)
11 <META NAME="date" CONTENT="2013-11-19">
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
15 <SCRIPT type="text/javascript">
16 function windowTitle()
18 if (location.href.indexOf('is-external=true') == -1) {
19 parent.document.title="ScoreAugmenter (Solr 4.6.0 API)";
28 <BODY BGCOLOR="white" onload="windowTitle();">
32 <!-- ========= START OF TOP NAVBAR ======= -->
33 <A NAME="navbar_top"><!-- --></A>
34 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
37 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38 <A NAME="navbar_top_firstrow"><!-- --></A>
39 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40 <TR ALIGN="center" VALIGN="top">
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ScoreAugmenter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58 <A HREF="../../../../../org/apache/solr/response/transform/RenameFieldTransformer.html" title="class in org.apache.solr.response.transform"><B>PREV CLASS</B></A>
59 <A HREF="../../../../../org/apache/solr/response/transform/ShardAugmenterFactory.html" title="class in org.apache.solr.response.transform"><B>NEXT CLASS</B></A></FONT></TD>
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61 <A HREF="../../../../../index.html?org/apache/solr/response/transform/ScoreAugmenter.html" target="_top"><B>FRAMES</B></A>
62 <A HREF="ScoreAugmenter.html" target="_top"><B>NO FRAMES</B></A>
63 <SCRIPT type="text/javascript">
66 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
71 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.solr.response.transform.TransformerWithContext">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
84 <A NAME="skip-navbar_top"></A>
85 <!-- ========= END OF TOP NAVBAR ========= -->
88 <!-- ======== START OF CLASS DATA ======== -->
91 org.apache.solr.response.transform</FONT>
93 Class ScoreAugmenter</H2>
95 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html" title="class in org.apache.solr.response.transform">org.apache.solr.response.transform.DocTransformer</A>
97 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/solr/response/transform/TransformerWithContext.html" title="class in org.apache.solr.response.transform">org.apache.solr.response.transform.TransformerWithContext</A>
98 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.response.transform.ScoreAugmenter</B>
102 <DT><PRE>public class <B>ScoreAugmenter</B><DT>extends <A HREF="../../../../../org/apache/solr/response/transform/TransformerWithContext.html" title="class in org.apache.solr.response.transform">TransformerWithContext</A></DL>
106 Simple Augmenter that adds the score
111 <DT><B>Since:</B></DT>
117 <!-- =========== FIELD SUMMARY =========== -->
119 <A NAME="field_summary"><!-- --></A>
120 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
121 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
122 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
123 <B>Field Summary</B></FONT></TH>
126 <A NAME="fields_inherited_from_class_org.apache.solr.response.transform.TransformerWithContext"><!-- --></A>
127 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
128 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
129 <TH ALIGN="left"><B>Fields inherited from class org.apache.solr.response.transform.<A HREF="../../../../../org/apache/solr/response/transform/TransformerWithContext.html" title="class in org.apache.solr.response.transform">TransformerWithContext</A></B></TH>
131 <TR BGCOLOR="white" CLASS="TableRowColor">
132 <TD><CODE><A HREF="../../../../../org/apache/solr/response/transform/TransformerWithContext.html#context">context</A></CODE></TD>
136 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
138 <A NAME="constructor_summary"><!-- --></A>
139 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
141 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
142 <B>Constructor Summary</B></FONT></TH>
144 <TR BGCOLOR="white" CLASS="TableRowColor">
145 <TD><CODE><B><A HREF="../../../../../org/apache/solr/response/transform/ScoreAugmenter.html#ScoreAugmenter(java.lang.String)">ScoreAugmenter</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> display)</CODE>
148 </TD>
152 <!-- ========== METHOD SUMMARY =========== -->
154 <A NAME="method_summary"><!-- --></A>
155 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
156 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
157 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
158 <B>Method Summary</B></FONT></TH>
160 <TR BGCOLOR="white" CLASS="TableRowColor">
161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162 <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
163 <TD><CODE><B><A HREF="../../../../../org/apache/solr/response/transform/ScoreAugmenter.html#getName()">getName</A></B>()</CODE>
166 </TD>
168 <TR BGCOLOR="white" CLASS="TableRowColor">
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170 <CODE> void</CODE></FONT></TD>
171 <TD><CODE><B><A HREF="../../../../../org/apache/solr/response/transform/ScoreAugmenter.html#transform(org.apache.solr.common.SolrDocument, int)">transform</A></B>(<A HREF="../../../../../../solr-solrj/org/apache/solr/common/SolrDocument.html?is-external=true" title="class or interface in org.apache.solr.common">SolrDocument</A> doc,
172 int docid)</CODE>
175 This is where implementations do the actual work</TD>
178 <A NAME="methods_inherited_from_class_org.apache.solr.response.transform.TransformerWithContext"><!-- --></A>
179 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
180 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
181 <TH ALIGN="left"><B>Methods inherited from class org.apache.solr.response.transform.<A HREF="../../../../../org/apache/solr/response/transform/TransformerWithContext.html" title="class in org.apache.solr.response.transform">TransformerWithContext</A></B></TH>
183 <TR BGCOLOR="white" CLASS="TableRowColor">
184 <TD><CODE><A HREF="../../../../../org/apache/solr/response/transform/TransformerWithContext.html#setContext(org.apache.solr.response.transform.TransformContext)">setContext</A></CODE></TD>
187 <A NAME="methods_inherited_from_class_org.apache.solr.response.transform.DocTransformer"><!-- --></A>
188 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
189 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
190 <TH ALIGN="left"><B>Methods inherited from class org.apache.solr.response.transform.<A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html" title="class in org.apache.solr.response.transform">DocTransformer</A></B></TH>
192 <TR BGCOLOR="white" CLASS="TableRowColor">
193 <TD><CODE><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html#toString()">toString</A></CODE></TD>
196 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
197 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
198 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
199 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
201 <TR BGCOLOR="white" CLASS="TableRowColor">
202 <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
208 <!-- ========= CONSTRUCTOR DETAIL ======== -->
210 <A NAME="constructor_detail"><!-- --></A>
211 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
212 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
213 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
214 <B>Constructor Detail</B></FONT></TH>
218 <A NAME="ScoreAugmenter(java.lang.String)"><!-- --></A><H3>
221 public <B>ScoreAugmenter</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> display)</PRE>
225 <!-- ============ METHOD DETAIL ========== -->
227 <A NAME="method_detail"><!-- --></A>
228 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
229 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
230 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
231 <B>Method Detail</B></FONT></TH>
235 <A NAME="getName()"><!-- --></A><H3>
238 public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE>
241 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html#getName()">getName</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html" title="class in org.apache.solr.response.transform">DocTransformer</A></CODE></DL>
245 <DT><B>Returns:</B><DD>The name of the transformer</DL>
250 <A NAME="transform(org.apache.solr.common.SolrDocument, int)"><!-- --></A><H3>
253 public void <B>transform</B>(<A HREF="../../../../../../solr-solrj/org/apache/solr/common/SolrDocument.html?is-external=true" title="class or interface in org.apache.solr.common">SolrDocument</A> doc,
254 int docid)</PRE>
256 <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html#transform(org.apache.solr.common.SolrDocument, int)">DocTransformer</A></CODE></B></DD>
257 <DD>This is where implementations do the actual work
260 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html#transform(org.apache.solr.common.SolrDocument, int)">transform</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/response/transform/DocTransformer.html" title="class in org.apache.solr.response.transform">DocTransformer</A></CODE></DL>
263 <DT><B>Parameters:</B><DD><CODE>doc</CODE> - The document to alter<DD><CODE>docid</CODE> - The Lucene internal doc id</DL>
266 <!-- ========= END OF CLASS DATA ========= -->
270 <!-- ======= START OF BOTTOM NAVBAR ====== -->
271 <A NAME="navbar_bottom"><!-- --></A>
272 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
273 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
275 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
276 <A NAME="navbar_bottom_firstrow"><!-- --></A>
277 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
278 <TR ALIGN="center" VALIGN="top">
279 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
280 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
281 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
282 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ScoreAugmenter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
283 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
284 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
285 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
289 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
295 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
296 <A HREF="../../../../../org/apache/solr/response/transform/RenameFieldTransformer.html" title="class in org.apache.solr.response.transform"><B>PREV CLASS</B></A>
297 <A HREF="../../../../../org/apache/solr/response/transform/ShardAugmenterFactory.html" title="class in org.apache.solr.response.transform"><B>NEXT CLASS</B></A></FONT></TD>
298 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
299 <A HREF="../../../../../index.html?org/apache/solr/response/transform/ScoreAugmenter.html" target="_top"><B>FRAMES</B></A>
300 <A HREF="ScoreAugmenter.html" target="_top"><B>NO FRAMES</B></A>
301 <SCRIPT type="text/javascript">
304 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
309 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
316 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
317 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.solr.response.transform.TransformerWithContext">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
318 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
319 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
322 <A NAME="skip-navbar_bottom"></A>
323 <!-- ======== END OF BOTTOM NAVBAR ======= -->
327 <i>Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.</i>
328 <script src='../../../../../prettify.js' type='text/javascript'></script>
329 <script type='text/javascript'>
331 var oldonload = window.onload;
332 if (typeof oldonload != 'function') {
333 window.onload = prettyPrint;
335 window.onload = function() {