solr-4.6.0/docs/solr-core/org/apache/solr/search/FieldParams.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.6.0_30) on Tue Nov 19 11:16:54 CET 2013 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=utf-8">
   7 <TITLE>
   8 FieldParams (Solr 4.6.0 API)
   9 </TITLE>
  10
  11 <META NAME="date" CONTENT="2013-11-19">
  12
  13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
  14
  15 <SCRIPT type="text/javascript">
  16 function windowTitle()
  17 {
  18     if (location.href.indexOf('is-external=true') == -1) {
  19         parent.document.title="FieldParams (Solr 4.6.0 API)";
  20     }
  21 }
  22 </SCRIPT>
  23 <NOSCRIPT>
  24 </NOSCRIPT>
  25
  26 </HEAD>
  27
  28 <BODY BGCOLOR="white" onload="windowTitle();">
  29 <HR>
  30
  31
  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="">
  36 <TR>
  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>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FieldParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  48   </TR>
  49 </TABLE>
  50 </TD>
  51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  52 </EM>
  53 </TD>
  54 </TR>
  55
  56 <TR>
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  58 &nbsp;<A HREF="../../../../org/apache/solr/search/FastLRUCache.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
  59 &nbsp;<A HREF="../../../../org/apache/solr/search/FieldQParserPlugin.html" title="class in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD>
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  61   <A HREF="../../../../index.html?org/apache/solr/search/FieldParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  62 &nbsp;<A HREF="FieldParams.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  63 &nbsp;<SCRIPT type="text/javascript">
  64   <!--
  65   if(window==top) {
  66     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  67   }
  68   //-->
  69 </SCRIPT>
  70 <NOSCRIPT>
  71   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  72 </NOSCRIPT>
  73
  74
  75 </FONT></TD>
  76 </TR>
  77 <TR>
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  82 </TR>
  83 </TABLE>
  84 <A NAME="skip-navbar_top"></A>
  85 <!-- ========= END OF TOP NAVBAR ========= -->
  86
  87 <HR>
  88 <!-- ======== START OF CLASS DATA ======== -->
  89 <H2>
  90 <FONT SIZE="-1">
  91 org.apache.solr.search</FONT>
  92 <BR>
  93 Class FieldParams</H2>
  94 <PRE>
  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 "><B>org.apache.solr.search.FieldParams</B>
  97 </PRE>
  98 <HR>
  99 <DL>
 100 <DT><PRE>public class <B>FieldParams</B><DT>extends <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></DL>
 101 </PRE>
 102
 103 <P>
 104 A class to hold "phrase slop" and "boost" parameters for pf, pf2, pf3 parameters
 105 <P>
 106
 107 <P>
 108 <HR>
 109
 110 <P>
 111
 112 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 113
 114 <A NAME="constructor_summary"><!-- --></A>
 115 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 117 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 118 <B>Constructor Summary</B></FONT></TH>
 119 </TR>
 120 <TR BGCOLOR="white" CLASS="TableRowColor">
 121 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/FieldParams.html#FieldParams(java.lang.String, int, int, float)">FieldParams</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>&nbsp;field,
 122             int&nbsp;wordGrams,
 123             int&nbsp;slop,
 124             float&nbsp;boost)</CODE>
 125
 126 <BR>
 127 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 128 </TR>
 129 </TABLE>
 130 &nbsp;
 131 <!-- ========== METHOD SUMMARY =========== -->
 132
 133 <A NAME="method_summary"><!-- --></A>
 134 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 135 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 136 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 137 <B>Method Summary</B></FONT></TH>
 138 </TR>
 139 <TR BGCOLOR="white" CLASS="TableRowColor">
 140 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 141 <CODE>&nbsp;float</CODE></FONT></TD>
 142 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/FieldParams.html#getBoost()">getBoost</A></B>()</CODE>
 143
 144 <BR>
 145 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 146 </TR>
 147 <TR BGCOLOR="white" CLASS="TableRowColor">
 148 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 149 <CODE>&nbsp;<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>
 150 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/FieldParams.html#getField()">getField</A></B>()</CODE>
 151
 152 <BR>
 153 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 154 </TR>
 155 <TR BGCOLOR="white" CLASS="TableRowColor">
 156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 157 <CODE>&nbsp;int</CODE></FONT></TD>
 158 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/FieldParams.html#getSlop()">getSlop</A></B>()</CODE>
 159
 160 <BR>
 161 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 162 </TR>
 163 <TR BGCOLOR="white" CLASS="TableRowColor">
 164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 165 <CODE>&nbsp;int</CODE></FONT></TD>
 166 <TD><CODE><B><A HREF="../../../../org/apache/solr/search/FieldParams.html#getWordGrams()">getWordGrams</A></B>()</CODE>
 167
 168 <BR>
 169 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 170 </TR>
 171 </TABLE>
 172 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 173 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 174 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 175 <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>
 176 </TR>
 177 <TR BGCOLOR="white" CLASS="TableRowColor">
 178 <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#toString()" title="class or interface in java.lang">toString</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>
 179 </TR>
 180 </TABLE>
 181 &nbsp;
 182 <P>
 183
 184 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 185
 186 <A NAME="constructor_detail"><!-- --></A>
 187 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 188 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 189 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 190 <B>Constructor Detail</B></FONT></TH>
 191 </TR>
 192 </TABLE>
 193
 194 <A NAME="FieldParams(java.lang.String, int, int, float)"><!-- --></A><H3>
 195 FieldParams</H3>
 196 <PRE>
 197 public <B>FieldParams</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>&nbsp;field,
 198                    int&nbsp;wordGrams,
 199                    int&nbsp;slop,
 200                    float&nbsp;boost)</PRE>
 201 <DL>
 202 </DL>
 203
 204 <!-- ============ METHOD DETAIL ========== -->
 205
 206 <A NAME="method_detail"><!-- --></A>
 207 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 208 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 209 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 210 <B>Method Detail</B></FONT></TH>
 211 </TR>
 212 </TABLE>
 213
 214 <A NAME="getWordGrams()"><!-- --></A><H3>
 215 getWordGrams</H3>
 216 <PRE>
 217 public int <B>getWordGrams</B>()</PRE>
 218 <DL>
 219 <DD><DL>
 220 </DL>
 221 </DD>
 222 </DL>
 223 <HR>
 224
 225 <A NAME="getSlop()"><!-- --></A><H3>
 226 getSlop</H3>
 227 <PRE>
 228 public int <B>getSlop</B>()</PRE>
 229 <DL>
 230 <DD><DL>
 231 </DL>
 232 </DD>
 233 </DL>
 234 <HR>
 235
 236 <A NAME="getBoost()"><!-- --></A><H3>
 237 getBoost</H3>
 238 <PRE>
 239 public float <B>getBoost</B>()</PRE>
 240 <DL>
 241 <DD><DL>
 242 </DL>
 243 </DD>
 244 </DL>
 245 <HR>
 246
 247 <A NAME="getField()"><!-- --></A><H3>
 248 getField</H3>
 249 <PRE>
 250 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>getField</B>()</PRE>
 251 <DL>
 252 <DD><DL>
 253 </DL>
 254 </DD>
 255 </DL>
 256 <!-- ========= END OF CLASS DATA ========= -->
 257 <HR>
 258
 259
 260 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 261 <A NAME="navbar_bottom"><!-- --></A>
 262 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 263 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 264 <TR>
 265 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 266 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 267 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 268   <TR ALIGN="center" VALIGN="top">
 269   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 270   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 271   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 272   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FieldParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 273   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 274   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 275   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 276   </TR>
 277 </TABLE>
 278 </TD>
 279 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 280 </EM>
 281 </TD>
 282 </TR>
 283
 284 <TR>
 285 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 286 &nbsp;<A HREF="../../../../org/apache/solr/search/FastLRUCache.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
 287 &nbsp;<A HREF="../../../../org/apache/solr/search/FieldQParserPlugin.html" title="class in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD>
 288 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 289   <A HREF="../../../../index.html?org/apache/solr/search/FieldParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 290 &nbsp;<A HREF="FieldParams.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 291 &nbsp;<SCRIPT type="text/javascript">
 292   <!--
 293   if(window==top) {
 294     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 295   }
 296   //-->
 297 </SCRIPT>
 298 <NOSCRIPT>
 299   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 300 </NOSCRIPT>
 301
 302
 303 </FONT></TD>
 304 </TR>
 305 <TR>
 306 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 307   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 308 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 309 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 310 </TR>
 311 </TABLE>
 312 <A NAME="skip-navbar_bottom"></A>
 313 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 314
 315 <HR>
 316
 317           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 318           <script src='../../../../prettify.js' type='text/javascript'></script>
 319           <script type='text/javascript'>
 320             (function(){
 321               var oldonload = window.onload;
 322               if (typeof oldonload != 'function') {
 323                 window.onload = prettyPrint;
 324               } else {
 325                 window.onload = function() {
 326                   oldonload();
 327                   prettyPrint();
 328                 }
 329               }
 330             })();
 331           </script>
 332
 333 </BODY>
 334 </HTML>