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

Revision 7588, 15.0 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>
8QueryElevationParams (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="QueryElevationParams (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/QueryElevationParams.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/MultiMapSolrParams.html" title="class in org.apache.solr.common.params"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/common/params/RequiredSolrParams.html" title="class 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/QueryElevationParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="QueryElevationParams.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 QueryElevationParams</H2>
94<HR>
95<DL>
96<DT><PRE>public interface <B>QueryElevationParams</B></DL>
97</PRE>
98
99<P>
100Parameters used with the QueryElevationComponent
101<P>
102
103<P>
104<HR>
105
106<P>
107<!-- =========== FIELD SUMMARY =========== -->
108
109<A NAME="field_summary"><!-- --></A>
110<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
111<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
112<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
113<B>Field Summary</B></FONT></TH>
114</TR>
115<TR BGCOLOR="white" CLASS="TableRowColor">
116<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
117<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>
118<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/QueryElevationParams.html#EDITORIAL_MARKER_FIELD_NAME">EDITORIAL_MARKER_FIELD_NAME</A></B></CODE>
119
120<BR>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the field that editorial results will be written out as when using the QueryElevationComponent, which
122 automatically configures the EditorialMarkerFactory.</TD>
123</TR>
124<TR BGCOLOR="white" CLASS="TableRowColor">
125<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
126<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>
127<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/QueryElevationParams.html#ENABLE">ENABLE</A></B></CODE>
128
129<BR>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
131</TR>
132<TR BGCOLOR="white" CLASS="TableRowColor">
133<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134<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>
135<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/QueryElevationParams.html#EXCLUDE_MARKER_FIELD_NAME">EXCLUDE_MARKER_FIELD_NAME</A></B></CODE>
136
137<BR>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the field that excluded editorial results will be written out as when using the QueryElevationComponent, which
139 automatically configures the EditorialMarkerFactory.</TD>
140</TR>
141<TR BGCOLOR="white" CLASS="TableRowColor">
142<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143<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>
144<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/QueryElevationParams.html#EXCLUSIVE">EXCLUSIVE</A></B></CODE>
145
146<BR>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151<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>
152<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/QueryElevationParams.html#FORCE_ELEVATION">FORCE_ELEVATION</A></B></CODE>
153
154<BR>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159<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>
160<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/QueryElevationParams.html#MARK_EXCLUDES">MARK_EXCLUDES</A></B></CODE>
161
162<BR>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Instead of removing excluded items from the results, passing in this parameter allows you to get back the excluded items, but to mark them
164 as excluded.</TD>
165</TR>
166</TABLE>
167&nbsp;
168<P>
169
170<!-- ============ FIELD DETAIL =========== -->
171
172<A NAME="field_detail"><!-- --></A>
173<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
174<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
175<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
176<B>Field Detail</B></FONT></TH>
177</TR>
178</TABLE>
179
180<A NAME="ENABLE"><!-- --></A><H3>
181ENABLE</H3>
182<PRE>
183static 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>ENABLE</B></PRE>
184<DL>
185<DL>
186<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.QueryElevationParams.ENABLE">Constant Field Values</A></DL>
187</DL>
188<HR>
189
190<A NAME="EXCLUSIVE"><!-- --></A><H3>
191EXCLUSIVE</H3>
192<PRE>
193static 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>EXCLUSIVE</B></PRE>
194<DL>
195<DL>
196<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.QueryElevationParams.EXCLUSIVE">Constant Field Values</A></DL>
197</DL>
198<HR>
199
200<A NAME="FORCE_ELEVATION"><!-- --></A><H3>
201FORCE_ELEVATION</H3>
202<PRE>
203static 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>FORCE_ELEVATION</B></PRE>
204<DL>
205<DL>
206<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.QueryElevationParams.FORCE_ELEVATION">Constant Field Values</A></DL>
207</DL>
208<HR>
209
210<A NAME="EDITORIAL_MARKER_FIELD_NAME"><!-- --></A><H3>
211EDITORIAL_MARKER_FIELD_NAME</H3>
212<PRE>
213static 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>EDITORIAL_MARKER_FIELD_NAME</B></PRE>
214<DL>
215<DD>The name of the field that editorial results will be written out as when using the QueryElevationComponent, which
216 automatically configures the EditorialMarkerFactory.  The default name is "elevated"
217 <br/>
218 See http://wiki.apache.org/solr/DocTransformers
219<P>
220<DL>
221<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.QueryElevationParams.EDITORIAL_MARKER_FIELD_NAME">Constant Field Values</A></DL>
222</DL>
223<HR>
224
225<A NAME="EXCLUDE_MARKER_FIELD_NAME"><!-- --></A><H3>
226EXCLUDE_MARKER_FIELD_NAME</H3>
227<PRE>
228static 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>EXCLUDE_MARKER_FIELD_NAME</B></PRE>
229<DL>
230<DD>The name of the field that excluded editorial results will be written out as when using the QueryElevationComponent, which
231 automatically configures the EditorialMarkerFactory.  The default name is "excluded".  This is only used
232 when <A HREF="../../../../../org/apache/solr/common/params/QueryElevationParams.html#MARK_EXCLUDES"><CODE>MARK_EXCLUDES</CODE></A> is set to true at query time.
233 <br/>
234 See http://wiki.apache.org/solr/DocTransformers
235<P>
236<DL>
237<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.QueryElevationParams.EXCLUDE_MARKER_FIELD_NAME">Constant Field Values</A></DL>
238</DL>
239<HR>
240
241<A NAME="MARK_EXCLUDES"><!-- --></A><H3>
242MARK_EXCLUDES</H3>
243<PRE>
244static 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>MARK_EXCLUDES</B></PRE>
245<DL>
246<DD>Instead of removing excluded items from the results, passing in this parameter allows you to get back the excluded items, but to mark them
247 as excluded.
248<P>
249<DL>
250<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.QueryElevationParams.MARK_EXCLUDES">Constant Field Values</A></DL>
251</DL>
252<!-- ========= END OF CLASS DATA ========= -->
253<HR>
254
255
256<!-- ======= START OF BOTTOM NAVBAR ====== -->
257<A NAME="navbar_bottom"><!-- --></A>
258<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
259<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
260<TR>
261<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
262<A NAME="navbar_bottom_firstrow"><!-- --></A>
263<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
264  <TR ALIGN="center" VALIGN="top">
265  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
266  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
267  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
268  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/QueryElevationParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
269  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
270  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
271  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
272  </TR>
273</TABLE>
274</TD>
275<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
276</EM>
277</TD>
278</TR>
279
280<TR>
281<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
282&nbsp;<A HREF="../../../../../org/apache/solr/common/params/MultiMapSolrParams.html" title="class in org.apache.solr.common.params"><B>PREV CLASS</B></A>&nbsp;
283&nbsp;<A HREF="../../../../../org/apache/solr/common/params/RequiredSolrParams.html" title="class in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD>
284<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
285  <A HREF="../../../../../index.html?org/apache/solr/common/params/QueryElevationParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
286&nbsp;<A HREF="QueryElevationParams.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
287&nbsp;<SCRIPT type="text/javascript">
288  <!--
289  if(window==top) {
290    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
291  }
292  //-->
293</SCRIPT>
294<NOSCRIPT>
295  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
296</NOSCRIPT>
297
298
299</FONT></TD>
300</TR>
301<TR>
302<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
303  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
304<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
305DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
306</TR>
307</TABLE>
308<A NAME="skip-navbar_bottom"></A>
309<!-- ======== END OF BOTTOM NAVBAR ======= -->
310
311<HR>
312
313          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
314          <script src='../../../../../prettify.js' type='text/javascript'></script>
315          <script type='text/javascript'>
316            (function(){
317              var oldonload = window.onload;
318              if (typeof oldonload != 'function') {
319                window.onload = prettyPrint;
320              } else {
321                window.onload = function() {
322                  oldonload();
323                  prettyPrint();
324                }
325              }
326            })();
327          </script>
328       
329</BODY>
330</HTML>
Note: See TracBrowser for help on using the repository browser.