solr/docs/solr-core/org/apache/solr/handler/component/TermVectorComponent.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_45) on Mon Apr 29 15:10:33 CEST 2013 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=utf-8">
   7 <TITLE>
   8 TermVectorComponent (Solr 4.3.0 API)
   9 </TITLE>
  10
  11 <META NAME="date" CONTENT="2013-04-29">
  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="TermVectorComponent (Solr 4.3.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/TermVectorComponent.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/handler/component/TermsComponent.TermsHelper.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A>&nbsp;
  59 &nbsp;NEXT CLASS</FONT></TD>
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  61   <A HREF="../../../../../index.html?org/apache/solr/handler/component/TermVectorComponent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  62 &nbsp;<A HREF="TermVectorComponent.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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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.handler.component</FONT>
  92 <BR>
  93 Class TermVectorComponent</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 "><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">org.apache.solr.handler.component.SearchComponent</A>
  97       <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.handler.component.TermVectorComponent</B>
  98 </PRE>
  99 <DL>
 100 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A>, <A HREF="../../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A>, <A HREF="../../../../../org/apache/solr/util/plugin/SolrCoreAware.html" title="interface in org.apache.solr.util.plugin">SolrCoreAware</A></DD>
 101 </DL>
 102 <HR>
 103 <DL>
 104 <DT><PRE>public class <B>TermVectorComponent</B><DT>extends <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A><DT>implements <A HREF="../../../../../org/apache/solr/util/plugin/SolrCoreAware.html" title="interface in org.apache.solr.util.plugin">SolrCoreAware</A></DL>
 105 </PRE>
 106
 107 <P>
 108 Return term vectors for the documents in a query result set.
 109  <p/>
 110  Info available:
 111  term, frequency, position, offset, IDF.
 112  <p/>
 113  <b>Note</b> Returning IDF can be expensive.
 114
 115  <pre class="prettyprint">
 116  &lt;searchComponent name="tvComponent" class="solr.TermVectorComponent"/&gt;
 117
 118  &lt;requestHandler name="/terms" class="solr.SearchHandler"&gt;
 119    &lt;lst name="defaults"&gt;
 120      &lt;bool name="tv"&gt;true&lt;/bool&gt;
 121    &lt;/lst&gt;
 122    &lt;arr name="last-component"&gt;
 123      &lt;str&gt;tvComponent&lt;/str&gt;
 124    &lt;/arr&gt;
 125  &lt;/requestHandler&gt;</pre>
 126 <P>
 127
 128 <P>
 129 <HR>
 130
 131 <P>
 132 <!-- ======== NESTED CLASS SUMMARY ======== -->
 133
 134 <A NAME="nested_class_summary"><!-- --></A>
 135 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 136 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 137 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 138 <B>Nested Class Summary</B></FONT></TH>
 139 </TR>
 140 </TABLE>
 141 &nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
 142 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 143 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 144 <TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.apache.solr.core.<A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></B></TH>
 145 </TR>
 146 <TR BGCOLOR="white" CLASS="TableRowColor">
 147 <TD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
 148 </TR>
 149 </TABLE>
 150 &nbsp;
 151 <!-- =========== FIELD SUMMARY =========== -->
 152
 153 <A NAME="field_summary"><!-- --></A>
 154 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 155 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 156 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 157 <B>Field Summary</B></FONT></TH>
 158 </TR>
 159 <TR BGCOLOR="white" CLASS="TableRowColor">
 160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 161 <CODE>static&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>
 162 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermVectorComponent.html#COMPONENT_NAME">COMPONENT_NAME</A></B></CODE>
 163
 164 <BR>
 165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 166 </TR>
 167 <TR BGCOLOR="white" CLASS="TableRowColor">
 168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 169 <CODE>protected &nbsp;<A HREF="../../../../../../solr-solrj/org/apache/solr/common/util/NamedList.html?is-external=true" title="class or interface in org.apache.solr.common.util">NamedList</A></CODE></FONT></TD>
 170 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermVectorComponent.html#initParams">initParams</A></B></CODE>
 171
 172 <BR>
 173 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 174 </TR>
 175 <TR BGCOLOR="white" CLASS="TableRowColor">
 176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 177 <CODE>static&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>
 178 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermVectorComponent.html#TERM_VECTORS">TERM_VECTORS</A></B></CODE>
 179
 180 <BR>
 181 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 182 </TR>
 183 </TABLE>
 184 &nbsp;
 185 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 186
 187 <A NAME="constructor_summary"><!-- --></A>
 188 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 189 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 190 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 191 <B>Constructor Summary</B></FONT></TH>
 192 </TR>
 193 <TR BGCOLOR="white" CLASS="TableRowColor">
 194 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermVectorComponent.html#TermVectorComponent()">TermVectorComponent</A></B>()</CODE>
 195
 196 <BR>
 197 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 198 </TR>
 199 </TABLE>
 200 &nbsp;
 201 <!-- ========== METHOD SUMMARY =========== -->
 202
 203 <A NAME="method_summary"><!-- --></A>
 204 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 205 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 206 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 207 <B>Method Summary</B></FONT></TH>
 208 </TR>
 209 <TR BGCOLOR="white" CLASS="TableRowColor">
 210 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 211 <CODE>&nbsp;void</CODE></FONT></TD>
 212 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermVectorComponent.html#finishStage(org.apache.solr.handler.component.ResponseBuilder)">finishStage</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)</CODE>
 213
 214 <BR>
 215 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called after all responses have been received for this stage.</TD>
 216 </TR>
 217 <TR BGCOLOR="white" CLASS="TableRowColor">
 218 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 219 <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>
 220 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermVectorComponent.html#getDescription()">getDescription</A></B>()</CODE>
 221
 222 <BR>
 223 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Simple one or two line description</TD>
 224 </TR>
 225 <TR BGCOLOR="white" CLASS="TableRowColor">
 226 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 227 <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>
 228 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermVectorComponent.html#getSource()">getSource</A></B>()</CODE>
 229
 230 <BR>
 231 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CVS Source, SVN Source, etc</TD>
 232 </TR>
 233 <TR BGCOLOR="white" CLASS="TableRowColor">
 234 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 235 <CODE>&nbsp;void</CODE></FONT></TD>
 236 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermVectorComponent.html#inform(org.apache.solr.core.SolrCore)">inform</A></B>(<A HREF="../../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</CODE>
 237
 238 <BR>
 239 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 240 </TR>
 241 <TR BGCOLOR="white" CLASS="TableRowColor">
 242 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 243 <CODE>&nbsp;void</CODE></FONT></TD>
 244 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermVectorComponent.html#init(org.apache.solr.common.util.NamedList)">init</A></B>(<A HREF="../../../../../../solr-solrj/org/apache/solr/common/util/NamedList.html?is-external=true" title="class or interface in org.apache.solr.common.util">NamedList</A>&nbsp;args)</CODE>
 245
 246 <BR>
 247 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 248 </TR>
 249 <TR BGCOLOR="white" CLASS="TableRowColor">
 250 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 251 <CODE>&nbsp;void</CODE></FONT></TD>
 252 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermVectorComponent.html#prepare(org.apache.solr.handler.component.ResponseBuilder)">prepare</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)</CODE>
 253
 254 <BR>
 255 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prepare the response.</TD>
 256 </TR>
 257 <TR BGCOLOR="white" CLASS="TableRowColor">
 258 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 259 <CODE>&nbsp;void</CODE></FONT></TD>
 260 <TD><CODE><B><A HREF="../../../../../org/apache/solr/handler/component/TermVectorComponent.html#process(org.apache.solr.handler.component.ResponseBuilder)">process</A></B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)</CODE>
 261
 262 <BR>
 263 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process the request for this component</TD>
 264 </TR>
 265 </TABLE>
 266 &nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.handler.component.SearchComponent"><!-- --></A>
 267 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 268 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 269 <TH ALIGN="left"><B>Methods inherited from class org.apache.solr.handler.component.<A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></B></TH>
 270 </TR>
 271 <TR BGCOLOR="white" CLASS="TableRowColor">
 272 <TD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#distributedProcess(org.apache.solr.handler.component.ResponseBuilder)">distributedProcess</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getCategory()">getCategory</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getDocs()">getDocs</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getName()">getName</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getStatistics()">getStatistics</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getVersion()">getVersion</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#handleResponses(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.ShardRequest)">handleResponses</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#modifyRequest(org.apache.solr.handler.component.ResponseBuilder, org.apache.solr.handler.component.SearchComponent, org.apache.solr.handler.component.ShardRequest)">modifyRequest</A>, <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#setName(java.lang.String)">setName</A></CODE></TD>
 273 </TR>
 274 </TABLE>
 275 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 276 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 277 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 278 <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>
 279 </TR>
 280 <TR BGCOLOR="white" CLASS="TableRowColor">
 281 <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>
 282 </TR>
 283 </TABLE>
 284 &nbsp;
 285 <P>
 286
 287 <!-- ============ FIELD DETAIL =========== -->
 288
 289 <A NAME="field_detail"><!-- --></A>
 290 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 291 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 292 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 293 <B>Field Detail</B></FONT></TH>
 294 </TR>
 295 </TABLE>
 296
 297 <A NAME="COMPONENT_NAME"><!-- --></A><H3>
 298 COMPONENT_NAME</H3>
 299 <PRE>
 300 public static final <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>COMPONENT_NAME</B></PRE>
 301 <DL>
 302 <DL>
 303 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.component.TermVectorComponent.COMPONENT_NAME">Constant Field Values</A></DL>
 304 </DL>
 305 <HR>
 306
 307 <A NAME="initParams"><!-- --></A><H3>
 308 initParams</H3>
 309 <PRE>
 310 protected <A HREF="../../../../../../solr-solrj/org/apache/solr/common/util/NamedList.html?is-external=true" title="class or interface in org.apache.solr.common.util">NamedList</A> <B>initParams</B></PRE>
 311 <DL>
 312 <DL>
 313 </DL>
 314 </DL>
 315 <HR>
 316
 317 <A NAME="TERM_VECTORS"><!-- --></A><H3>
 318 TERM_VECTORS</H3>
 319 <PRE>
 320 public static final <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>TERM_VECTORS</B></PRE>
 321 <DL>
 322 <DL>
 323 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.handler.component.TermVectorComponent.TERM_VECTORS">Constant Field Values</A></DL>
 324 </DL>
 325
 326 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 327
 328 <A NAME="constructor_detail"><!-- --></A>
 329 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 330 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 331 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 332 <B>Constructor Detail</B></FONT></TH>
 333 </TR>
 334 </TABLE>
 335
 336 <A NAME="TermVectorComponent()"><!-- --></A><H3>
 337 TermVectorComponent</H3>
 338 <PRE>
 339 public <B>TermVectorComponent</B>()</PRE>
 340 <DL>
 341 </DL>
 342
 343 <!-- ============ METHOD DETAIL ========== -->
 344
 345 <A NAME="method_detail"><!-- --></A>
 346 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 347 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 348 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 349 <B>Method Detail</B></FONT></TH>
 350 </TR>
 351 </TABLE>
 352
 353 <A NAME="process(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
 354 process</H3>
 355 <PRE>
 356 public void <B>process</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)
 357              throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
 358 <DL>
 359 <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#process(org.apache.solr.handler.component.ResponseBuilder)">SearchComponent</A></CODE></B></DD>
 360 <DD>Process the request for this component
 361 <P>
 362 <DD><DL>
 363 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#process(org.apache.solr.handler.component.ResponseBuilder)">process</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 364 </DD>
 365 <DD><DL>
 366 <DT><B>Parameters:</B><DD><CODE>rb</CODE> - The <A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component"><CODE>ResponseBuilder</CODE></A>
 367 <DT><B>Throws:</B>
 368 <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If there is a low-level I/O error.</DL>
 369 </DD>
 370 </DL>
 371 <HR>
 372
 373 <A NAME="prepare(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
 374 prepare</H3>
 375 <PRE>
 376 public void <B>prepare</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)
 377              throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
 378 <DL>
 379 <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#prepare(org.apache.solr.handler.component.ResponseBuilder)">SearchComponent</A></CODE></B></DD>
 380 <DD>Prepare the response.  Guaranteed to be called before any SearchComponent <A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#process(org.apache.solr.handler.component.ResponseBuilder)"><CODE>SearchComponent.process(org.apache.solr.handler.component.ResponseBuilder)</CODE></A> method.
 381  Called for every incoming request.
 382
 383  The place to do initialization that is request dependent.
 384 <P>
 385 <DD><DL>
 386 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#prepare(org.apache.solr.handler.component.ResponseBuilder)">prepare</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 387 </DD>
 388 <DD><DL>
 389 <DT><B>Parameters:</B><DD><CODE>rb</CODE> - The <A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component"><CODE>ResponseBuilder</CODE></A>
 390 <DT><B>Throws:</B>
 391 <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If there is a low-level I/O error.</DL>
 392 </DD>
 393 </DL>
 394 <HR>
 395
 396 <A NAME="finishStage(org.apache.solr.handler.component.ResponseBuilder)"><!-- --></A><H3>
 397 finishStage</H3>
 398 <PRE>
 399 public void <B>finishStage</B>(<A HREF="../../../../../org/apache/solr/handler/component/ResponseBuilder.html" title="class in org.apache.solr.handler.component">ResponseBuilder</A>&nbsp;rb)</PRE>
 400 <DL>
 401 <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#finishStage(org.apache.solr.handler.component.ResponseBuilder)">SearchComponent</A></CODE></B></DD>
 402 <DD>Called after all responses have been received for this stage.
 403  Useful when different requests are sent to each shard.
 404 <P>
 405 <DD><DL>
 406 <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#finishStage(org.apache.solr.handler.component.ResponseBuilder)">finishStage</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 407 </DD>
 408 <DD><DL>
 409 </DL>
 410 </DD>
 411 </DL>
 412 <HR>
 413
 414 <A NAME="init(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
 415 init</H3>
 416 <PRE>
 417 public void <B>init</B>(<A HREF="../../../../../../solr-solrj/org/apache/solr/common/util/NamedList.html?is-external=true" title="class or interface in org.apache.solr.common.util">NamedList</A>&nbsp;args)</PRE>
 418 <DL>
 419 <DD><DL>
 420 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 421 </DD>
 422 <DD><DL>
 423 </DL>
 424 </DD>
 425 </DL>
 426 <HR>
 427
 428 <A NAME="inform(org.apache.solr.core.SolrCore)"><!-- --></A><H3>
 429 inform</H3>
 430 <PRE>
 431 public void <B>inform</B>(<A HREF="../../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;core)</PRE>
 432 <DL>
 433 <DD><DL>
 434 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/util/plugin/SolrCoreAware.html#inform(org.apache.solr.core.SolrCore)">inform</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/util/plugin/SolrCoreAware.html" title="interface in org.apache.solr.util.plugin">SolrCoreAware</A></CODE></DL>
 435 </DD>
 436 <DD><DL>
 437 </DL>
 438 </DD>
 439 </DL>
 440 <HR>
 441
 442 <A NAME="getSource()"><!-- --></A><H3>
 443 getSource</H3>
 444 <PRE>
 445 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>getSource</B>()</PRE>
 446 <DL>
 447 <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">SolrInfoMBean</A></CODE></B></DD>
 448 <DD>CVS Source, SVN Source, etc
 449 <P>
 450 <DD><DL>
 451 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">getSource</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getSource()">getSource</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 452 </DD>
 453 <DD><DL>
 454 </DL>
 455 </DD>
 456 </DL>
 457 <HR>
 458
 459 <A NAME="getDescription()"><!-- --></A><H3>
 460 getDescription</H3>
 461 <PRE>
 462 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>getDescription</B>()</PRE>
 463 <DL>
 464 <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">SolrInfoMBean</A></CODE></B></DD>
 465 <DD>Simple one or two line description
 466 <P>
 467 <DD><DL>
 468 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">getDescription</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html#getDescription()">getDescription</A></CODE> in class <CODE><A HREF="../../../../../org/apache/solr/handler/component/SearchComponent.html" title="class in org.apache.solr.handler.component">SearchComponent</A></CODE></DL>
 469 </DD>
 470 <DD><DL>
 471 </DL>
 472 </DD>
 473 </DL>
 474 <!-- ========= END OF CLASS DATA ========= -->
 475 <HR>
 476
 477
 478 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 479 <A NAME="navbar_bottom"><!-- --></A>
 480 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 481 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 482 <TR>
 483 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 484 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 485 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 486   <TR ALIGN="center" VALIGN="top">
 487   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 488   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 489   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 490   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TermVectorComponent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 491   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 492   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 493   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 494   </TR>
 495 </TABLE>
 496 </TD>
 497 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 498 </EM>
 499 </TD>
 500 </TR>
 501
 502 <TR>
 503 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 504 &nbsp;<A HREF="../../../../../org/apache/solr/handler/component/TermsComponent.TermsHelper.html" title="class in org.apache.solr.handler.component"><B>PREV CLASS</B></A>&nbsp;
 505 &nbsp;NEXT CLASS</FONT></TD>
 506 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 507   <A HREF="../../../../../index.html?org/apache/solr/handler/component/TermVectorComponent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 508 &nbsp;<A HREF="TermVectorComponent.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 509 &nbsp;<SCRIPT type="text/javascript">
 510   <!--
 511   if(window==top) {
 512     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 513   }
 514   //-->
 515 </SCRIPT>
 516 <NOSCRIPT>
 517   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 518 </NOSCRIPT>
 519
 520
 521 </FONT></TD>
 522 </TR>
 523 <TR>
 524 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 525   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 526 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 527 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 528 </TR>
 529 </TABLE>
 530 <A NAME="skip-navbar_bottom"></A>
 531 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 532
 533 <HR>
 534
 535           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 536           <script src='../../../../../prettify.js' type='text/javascript'></script>
 537           <script type='text/javascript'>
 538             (function(){
 539               var oldonload = window.onload;
 540               if (typeof oldonload != 'function') {
 541                 window.onload = prettyPrint;
 542               } else {
 543                 window.onload = function() {
 544                   oldonload();
 545                   prettyPrint();
 546                 }
 547               }
 548             })();
 549           </script>
 550
 551 </BODY>
 552 </HTML>