solr-4.5.1/docs/solr-solrj/org/apache/solr/common/params/TermVectorParams.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (version 1.6.0_27) on Thu Oct 17 21:45:04 EDT 2013 -->
   6 <meta http-equiv="Content-Type" content="text/html" charset="utf-8">
   7 <title>TermVectorParams (Solr 4.5.1 API)</title>
   8 <meta name="date" content="2013-10-17">
   9 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     if (location.href.indexOf('is-external=true') == -1) {
  14         parent.document.title="TermVectorParams (Solr 4.5.1 API)";
  15     }
  16 //-->
  17 </script>
  18 <noscript>
  19 <div>JavaScript is disabled on your browser.</div>
  20 </noscript>
  21 <!-- ========= START OF TOP NAVBAR ======= -->
  22 <div class="topNav"><a name="navbar_top">
  23 <!--   -->
  24 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  25 <!--   -->
  26 </a>
  27 <ul class="navList" title="Navigation">
  28 <li><a href="../../../../../overview-summary.html">Overview</a></li>
  29 <li><a href="package-summary.html">Package</a></li>
  30 <li class="navBarCell1Rev">Class</li>
  31 <li><a href="class-use/TermVectorParams.html">Use</a></li>
  32 <li><a href="package-tree.html">Tree</a></li>
  33 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  34 <li><a href="../../../../../help-doc.html">Help</a></li>
  35 </ul>
  36 </div>
  37 <div class="subNav">
  38 <ul class="navList">
  39 <li><a href="../../../../../org/apache/solr/common/params/TermsParams.TermsRegexpFlag.html" title="enum in org.apache.solr.common.params"><span class="strong">PREV CLASS</span></a></li>
  40 <li><a href="../../../../../org/apache/solr/common/params/UpdateParams.html" title="interface in org.apache.solr.common.params"><span class="strong">NEXT CLASS</span></a></li>
  41 </ul>
  42 <ul class="navList">
  43 <li><a href="../../../../../index.html?org/apache/solr/common/params/TermVectorParams.html" target="_top">FRAMES</a></li>
  44 <li><a href="TermVectorParams.html" target="_top">NO FRAMES</a></li>
  45 </ul>
  46 <ul class="navList" id="allclasses_navbar_top">
  47 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
  48 </ul>
  49 <div>
  50 <script type="text/javascript"><!--
  51   allClassesLink = document.getElementById("allclasses_navbar_top");
  52   if(window==top) {
  53     allClassesLink.style.display = "block";
  54   }
  55   else {
  56     allClassesLink.style.display = "none";
  57   }
  58   //-->
  59 </script>
  60 </div>
  61 <div>
  62 <ul class="subNavList">
  63 <li>SUMMARY:&nbsp;</li>
  64 <li>NESTED&nbsp;|&nbsp;</li>
  65 <li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
  66 <li>CONSTR&nbsp;|&nbsp;</li>
  67 <li>METHOD</li>
  68 </ul>
  69 <ul class="subNavList">
  70 <li>DETAIL:&nbsp;</li>
  71 <li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
  72 <li>CONSTR&nbsp;|&nbsp;</li>
  73 <li>METHOD</li>
  74 </ul>
  75 </div>
  76 <a name="skip-navbar_top">
  77 <!--   -->
  78 </a></div>
  79 <!-- ========= END OF TOP NAVBAR ========= -->
  80 <!-- ======== START OF CLASS DATA ======== -->
  81 <div class="header">
  82 <p class="subTitle">org.apache.solr.common.params</p>
  83 <h2 title="Interface TermVectorParams" class="title">Interface TermVectorParams</h2>
  84 </div>
  85 <div class="contentContainer">
  86 <div class="description">
  87 <ul class="blockList">
  88 <li class="blockList">
  89 <hr>
  90 <br>
  91 <pre>public interface <strong>TermVectorParams</strong></pre>
  92 </li>
  93 </ul>
  94 </div>
  95 <div class="summary">
  96 <ul class="blockList">
  97 <li class="blockList">
  98 <!-- =========== FIELD SUMMARY =========== -->
  99 <ul class="blockList">
 100 <li class="blockList"><a name="field_summary">
 101 <!--   -->
 102 </a>
 103 <h3>Field Summary</h3>
 104 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 105 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 106 <tr>
 107 <th class="colFirst" scope="col">Modifier and Type</th>
 108 <th class="colLast" scope="col">Field and Description</th>
 109 </tr>
 110 <tr class="altColor">
 111 <td class="colFirst"><code>static <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></td>
 112 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/TermVectorParams.html#ALL">ALL</a></strong></code>
 113 <div class="block">Return all the options: TF, positions, offsets, idf</div>
 114 </td>
 115 </tr>
 116 <tr class="rowColor">
 117 <td class="colFirst"><code>static <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></td>
 118 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/TermVectorParams.html#DF">DF</a></strong></code>
 119 <div class="block">Return IDF information.</div>
 120 </td>
 121 </tr>
 122 <tr class="altColor">
 123 <td class="colFirst"><code>static <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></td>
 124 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/TermVectorParams.html#DOC_IDS">DOC_IDS</a></strong></code>
 125 <div class="block">The Doc Ids (Lucene internal ids) of the docs to get the term vectors for</div>
 126 </td>
 127 </tr>
 128 <tr class="rowColor">
 129 <td class="colFirst"><code>static <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></td>
 130 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/TermVectorParams.html#FIELDS">FIELDS</a></strong></code>
 131 <div class="block">The fields to get term vectors for</div>
 132 </td>
 133 </tr>
 134 <tr class="altColor">
 135 <td class="colFirst"><code>static <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></td>
 136 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/TermVectorParams.html#OFFSETS">OFFSETS</a></strong></code>
 137 <div class="block">Return offset information, if available</div>
 138 </td>
 139 </tr>
 140 <tr class="rowColor">
 141 <td class="colFirst"><code>static <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></td>
 142 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/TermVectorParams.html#POSITIONS">POSITIONS</a></strong></code>
 143 <div class="block">Return Term Vector position information</div>
 144 </td>
 145 </tr>
 146 <tr class="altColor">
 147 <td class="colFirst"><code>static <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></td>
 148 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/TermVectorParams.html#TF">TF</a></strong></code>
 149 <div class="block">Return Term Frequency info</div>
 150 </td>
 151 </tr>
 152 <tr class="rowColor">
 153 <td class="colFirst"><code>static <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></td>
 154 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/TermVectorParams.html#TF_IDF">TF_IDF</a></strong></code>
 155 <div class="block">Return TF-IDF calculation, i.e.</div>
 156 </td>
 157 </tr>
 158 <tr class="altColor">
 159 <td class="colFirst"><code>static <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></td>
 160 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/TermVectorParams.html#TV_PREFIX">TV_PREFIX</a></strong></code>&nbsp;</td>
 161 </tr>
 162 </table>
 163 </li>
 164 </ul>
 165 </li>
 166 </ul>
 167 </div>
 168 <div class="details">
 169 <ul class="blockList">
 170 <li class="blockList">
 171 <!-- ============ FIELD DETAIL =========== -->
 172 <ul class="blockList">
 173 <li class="blockList"><a name="field_detail">
 174 <!--   -->
 175 </a>
 176 <h3>Field Detail</h3>
 177 <a name="TV_PREFIX">
 178 <!--   -->
 179 </a>
 180 <ul class="blockList">
 181 <li class="blockList">
 182 <h4>TV_PREFIX</h4>
 183 <pre>static final&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> TV_PREFIX</pre>
 184 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.TV_PREFIX">Constant Field Values</a></dd></dl>
 185 </li>
 186 </ul>
 187 <a name="TF">
 188 <!--   -->
 189 </a>
 190 <ul class="blockList">
 191 <li class="blockList">
 192 <h4>TF</h4>
 193 <pre>static final&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> TF</pre>
 194 <div class="block">Return Term Frequency info</div>
 195 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.TF">Constant Field Values</a></dd></dl>
 196 </li>
 197 </ul>
 198 <a name="POSITIONS">
 199 <!--   -->
 200 </a>
 201 <ul class="blockList">
 202 <li class="blockList">
 203 <h4>POSITIONS</h4>
 204 <pre>static final&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> POSITIONS</pre>
 205 <div class="block">Return Term Vector position information</div>
 206 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.POSITIONS">Constant Field Values</a></dd></dl>
 207 </li>
 208 </ul>
 209 <a name="OFFSETS">
 210 <!--   -->
 211 </a>
 212 <ul class="blockList">
 213 <li class="blockList">
 214 <h4>OFFSETS</h4>
 215 <pre>static final&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> OFFSETS</pre>
 216 <div class="block">Return offset information, if available</div>
 217 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.OFFSETS">Constant Field Values</a></dd></dl>
 218 </li>
 219 </ul>
 220 <a name="DF">
 221 <!--   -->
 222 </a>
 223 <ul class="blockList">
 224 <li class="blockList">
 225 <h4>DF</h4>
 226 <pre>static final&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> DF</pre>
 227 <div class="block">Return IDF information.  May be expensive</div>
 228 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.DF">Constant Field Values</a></dd></dl>
 229 </li>
 230 </ul>
 231 <a name="TF_IDF">
 232 <!--   -->
 233 </a>
 234 <ul class="blockList">
 235 <li class="blockList">
 236 <h4>TF_IDF</h4>
 237 <pre>static final&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> TF_IDF</pre>
 238 <div class="block">Return TF-IDF calculation, i.e. (tf / idf).  May be expensive.</div>
 239 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.TF_IDF">Constant Field Values</a></dd></dl>
 240 </li>
 241 </ul>
 242 <a name="ALL">
 243 <!--   -->
 244 </a>
 245 <ul class="blockList">
 246 <li class="blockList">
 247 <h4>ALL</h4>
 248 <pre>static final&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> ALL</pre>
 249 <div class="block">Return all the options: TF, positions, offsets, idf</div>
 250 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.ALL">Constant Field Values</a></dd></dl>
 251 </li>
 252 </ul>
 253 <a name="FIELDS">
 254 <!--   -->
 255 </a>
 256 <ul class="blockList">
 257 <li class="blockList">
 258 <h4>FIELDS</h4>
 259 <pre>static final&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> FIELDS</pre>
 260 <div class="block">The fields to get term vectors for</div>
 261 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.FIELDS">Constant Field Values</a></dd></dl>
 262 </li>
 263 </ul>
 264 <a name="DOC_IDS">
 265 <!--   -->
 266 </a>
 267 <ul class="blockListLast">
 268 <li class="blockList">
 269 <h4>DOC_IDS</h4>
 270 <pre>static final&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> DOC_IDS</pre>
 271 <div class="block">The Doc Ids (Lucene internal ids) of the docs to get the term vectors for</div>
 272 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.DOC_IDS">Constant Field Values</a></dd></dl>
 273 </li>
 274 </ul>
 275 </li>
 276 </ul>
 277 </li>
 278 </ul>
 279 </div>
 280 </div>
 281 <!-- ========= END OF CLASS DATA ========= -->
 282 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 283 <div class="bottomNav"><a name="navbar_bottom">
 284 <!--   -->
 285 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
 286 <!--   -->
 287 </a>
 288 <ul class="navList" title="Navigation">
 289 <li><a href="../../../../../overview-summary.html">Overview</a></li>
 290 <li><a href="package-summary.html">Package</a></li>
 291 <li class="navBarCell1Rev">Class</li>
 292 <li><a href="class-use/TermVectorParams.html">Use</a></li>
 293 <li><a href="package-tree.html">Tree</a></li>
 294 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 295 <li><a href="../../../../../help-doc.html">Help</a></li>
 296 </ul>
 297 </div>
 298 <div class="subNav">
 299 <ul class="navList">
 300 <li><a href="../../../../../org/apache/solr/common/params/TermsParams.TermsRegexpFlag.html" title="enum in org.apache.solr.common.params"><span class="strong">PREV CLASS</span></a></li>
 301 <li><a href="../../../../../org/apache/solr/common/params/UpdateParams.html" title="interface in org.apache.solr.common.params"><span class="strong">NEXT CLASS</span></a></li>
 302 </ul>
 303 <ul class="navList">
 304 <li><a href="../../../../../index.html?org/apache/solr/common/params/TermVectorParams.html" target="_top">FRAMES</a></li>
 305 <li><a href="TermVectorParams.html" target="_top">NO FRAMES</a></li>
 306 </ul>
 307 <ul class="navList" id="allclasses_navbar_bottom">
 308 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
 309 </ul>
 310 <div>
 311 <script type="text/javascript"><!--
 312   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 313   if(window==top) {
 314     allClassesLink.style.display = "block";
 315   }
 316   else {
 317     allClassesLink.style.display = "none";
 318   }
 319   //-->
 320 </script>
 321 </div>
 322 <div>
 323 <ul class="subNavList">
 324 <li>SUMMARY:&nbsp;</li>
 325 <li>NESTED&nbsp;|&nbsp;</li>
 326 <li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
 327 <li>CONSTR&nbsp;|&nbsp;</li>
 328 <li>METHOD</li>
 329 </ul>
 330 <ul class="subNavList">
 331 <li>DETAIL:&nbsp;</li>
 332 <li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
 333 <li>CONSTR&nbsp;|&nbsp;</li>
 334 <li>METHOD</li>
 335 </ul>
 336 </div>
 337 <a name="skip-navbar_bottom">
 338 <!--   -->
 339 </a></div>
 340 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 341 <p class="legalCopy"><small>
 342           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 343           <script src='../../../../../prettify.js' type='text/javascript'></script>
 344           <script type='text/javascript'>
 345             (function(){
 346               var oldonload = window.onload;
 347               if (typeof oldonload != 'function') {
 348                 window.onload = prettyPrint;
 349               } else {
 350                 window.onload = function() {
 351                   oldonload();
 352                   prettyPrint();
 353                 }
 354               }
 355             })();
 356           </script>
 357         </small></p>
 358 </body>
 359 </html>