source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/common/params/TermVectorParams.html @ 7588

Revision 7588, 16.4 KB checked in by adir, 11 years ago (diff)

Ticket #000 - Adicionando a integracao de buscas com Solr na base a ser isnerida na comunidade

Line 
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_24) on Mon Jun 25 15:26:26 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8TermVectorParams (Solr 4.0.0-ALPHA API)
9</TITLE>
10
11<META NAME="date" CONTENT="2012-06-25">
12
13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15<SCRIPT type="text/javascript">
16function windowTitle()
17{
18    if (location.href.indexOf('is-external=true') == -1) {
19        parent.document.title="TermVectorParams (Solr 4.0.0-ALPHA 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/TermVectorParams.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/common/params/TermsParams.TermsRegexpFlag.html" title="enum in org.apache.solr.common.params"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/common/params/UpdateParams.html" title="interface in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/solr/common/params/TermVectorParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="TermVectorParams.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;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</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">
91org.apache.solr.common.params</FONT>
92<BR>
93Interface TermVectorParams</H2>
94<HR>
95<DL>
96<DT><PRE>public interface <B>TermVectorParams</B></DL>
97</PRE>
98
99<P>
100<HR>
101
102<P>
103<!-- =========== FIELD SUMMARY =========== -->
104
105<A NAME="field_summary"><!-- --></A>
106<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
107<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
108<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
109<B>Field Summary</B></FONT></TH>
110</TR>
111<TR BGCOLOR="white" CLASS="TableRowColor">
112<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
113<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>
114<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/TermVectorParams.html#ALL">ALL</A></B></CODE>
115
116<BR>
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return all the options: TF, positions, offsets, idf</TD>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
121<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>
122<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/TermVectorParams.html#DF">DF</A></B></CODE>
123
124<BR>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return IDF information.</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129<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>
130<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/TermVectorParams.html#DOC_IDS">DOC_IDS</A></B></CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Doc Ids (Lucene internal ids) of the docs to get the term vectors for</TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<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>
138<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/TermVectorParams.html#FIELDS">FIELDS</A></B></CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The fields to get term vectors for</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<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>
146<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/TermVectorParams.html#OFFSETS">OFFSETS</A></B></CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return offset information, if available</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<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>
154<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/TermVectorParams.html#POSITIONS">POSITIONS</A></B></CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return Term Vector position information</TD>
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/common/params/TermVectorParams.html#TF">TF</A></B></CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return Term Frequency info</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<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>
170<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/TermVectorParams.html#TF_IDF">TF_IDF</A></B></CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return TF-IDF calculation, i.e.</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/common/params/TermVectorParams.html#TV_PREFIX">TV_PREFIX</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<P>
186
187<!-- ============ FIELD DETAIL =========== -->
188
189<A NAME="field_detail"><!-- --></A>
190<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
191<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
192<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
193<B>Field Detail</B></FONT></TH>
194</TR>
195</TABLE>
196
197<A NAME="TV_PREFIX"><!-- --></A><H3>
198TV_PREFIX</H3>
199<PRE>
200static 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>TV_PREFIX</B></PRE>
201<DL>
202<DL>
203<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.TV_PREFIX">Constant Field Values</A></DL>
204</DL>
205<HR>
206
207<A NAME="TF"><!-- --></A><H3>
208TF</H3>
209<PRE>
210static 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>TF</B></PRE>
211<DL>
212<DD>Return Term Frequency info
213<P>
214<DL>
215<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.TF">Constant Field Values</A></DL>
216</DL>
217<HR>
218
219<A NAME="POSITIONS"><!-- --></A><H3>
220POSITIONS</H3>
221<PRE>
222static 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>POSITIONS</B></PRE>
223<DL>
224<DD>Return Term Vector position information
225<P>
226<DL>
227<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.POSITIONS">Constant Field Values</A></DL>
228</DL>
229<HR>
230
231<A NAME="OFFSETS"><!-- --></A><H3>
232OFFSETS</H3>
233<PRE>
234static 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>OFFSETS</B></PRE>
235<DL>
236<DD>Return offset information, if available
237<P>
238<DL>
239<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.OFFSETS">Constant Field Values</A></DL>
240</DL>
241<HR>
242
243<A NAME="DF"><!-- --></A><H3>
244DF</H3>
245<PRE>
246static 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>DF</B></PRE>
247<DL>
248<DD>Return IDF information.  May be expensive
249<P>
250<DL>
251<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.DF">Constant Field Values</A></DL>
252</DL>
253<HR>
254
255<A NAME="TF_IDF"><!-- --></A><H3>
256TF_IDF</H3>
257<PRE>
258static 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>TF_IDF</B></PRE>
259<DL>
260<DD>Return TF-IDF calculation, i.e. (tf / idf).  May be expensive.
261<P>
262<DL>
263<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.TF_IDF">Constant Field Values</A></DL>
264</DL>
265<HR>
266
267<A NAME="ALL"><!-- --></A><H3>
268ALL</H3>
269<PRE>
270static 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>ALL</B></PRE>
271<DL>
272<DD>Return all the options: TF, positions, offsets, idf
273<P>
274<DL>
275<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.ALL">Constant Field Values</A></DL>
276</DL>
277<HR>
278
279<A NAME="FIELDS"><!-- --></A><H3>
280FIELDS</H3>
281<PRE>
282static 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>FIELDS</B></PRE>
283<DL>
284<DD>The fields to get term vectors for
285<P>
286<DL>
287<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.FIELDS">Constant Field Values</A></DL>
288</DL>
289<HR>
290
291<A NAME="DOC_IDS"><!-- --></A><H3>
292DOC_IDS</H3>
293<PRE>
294static 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>DOC_IDS</B></PRE>
295<DL>
296<DD>The Doc Ids (Lucene internal ids) of the docs to get the term vectors for
297<P>
298<DL>
299<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.TermVectorParams.DOC_IDS">Constant Field Values</A></DL>
300</DL>
301<!-- ========= END OF CLASS DATA ========= -->
302<HR>
303
304
305<!-- ======= START OF BOTTOM NAVBAR ====== -->
306<A NAME="navbar_bottom"><!-- --></A>
307<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
308<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
309<TR>
310<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
311<A NAME="navbar_bottom_firstrow"><!-- --></A>
312<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
313  <TR ALIGN="center" VALIGN="top">
314  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
315  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
316  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
317  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TermVectorParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
318  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
319  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
320  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
321  </TR>
322</TABLE>
323</TD>
324<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
325</EM>
326</TD>
327</TR>
328
329<TR>
330<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
331&nbsp;<A HREF="../../../../../org/apache/solr/common/params/TermsParams.TermsRegexpFlag.html" title="enum in org.apache.solr.common.params"><B>PREV CLASS</B></A>&nbsp;
332&nbsp;<A HREF="../../../../../org/apache/solr/common/params/UpdateParams.html" title="interface in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD>
333<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
334  <A HREF="../../../../../index.html?org/apache/solr/common/params/TermVectorParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
335&nbsp;<A HREF="TermVectorParams.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
336&nbsp;<SCRIPT type="text/javascript">
337  <!--
338  if(window==top) {
339    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
340  }
341  //-->
342</SCRIPT>
343<NOSCRIPT>
344  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
345</NOSCRIPT>
346
347
348</FONT></TD>
349</TR>
350<TR>
351<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
352  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
353<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
354DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
355</TR>
356</TABLE>
357<A NAME="skip-navbar_bottom"></A>
358<!-- ======== END OF BOTTOM NAVBAR ======= -->
359
360<HR>
361
362          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
363          <script src='../../../../../prettify.js' type='text/javascript'></script>
364          <script type='text/javascript'>
365            (function(){
366              var oldonload = window.onload;
367              if (typeof oldonload != 'function') {
368                window.onload = prettyPrint;
369              } else {
370                window.onload = function() {
371                  oldonload();
372                  prettyPrint();
373                }
374              }
375            })();
376          </script>
377       
378</BODY>
379</HTML>
Note: See TracBrowser for help on using the repository browser.