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

Revision 7588, 16.5 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>
8ShardParams (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="ShardParams (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/ShardParams.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/RequiredSolrParams.html" title="class in org.apache.solr.common.params"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/solr/common/params/SolrParams.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/ShardParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="ShardParams.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 ShardParams</H2>
94<HR>
95<DL>
96<DT><PRE>public interface <B>ShardParams</B></DL>
97</PRE>
98
99<P>
100Parameters used for distributed search.
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/ShardParams.html#IDS">IDS</A></B></CODE>
119
120<BR>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;IDs of the shard documents</TD>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125<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>
126<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#IS_SHARD">IS_SHARD</A></B></CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;whether the request goes to a shard</TD>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133<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>
134<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARD_URL">SHARD_URL</A></B></CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The requested URL for this shard</TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<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>
142<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS">SHARDS</A></B></CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the shards to use (distributed configuration)</TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149<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>
150<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_INFO">SHARDS_INFO</A></B></CODE>
151
152<BR>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Request detailed match info for each shard (true/false)</TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<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>
158<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_QT">SHARDS_QT</A></B></CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Request Handler for shard requests</TD>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<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>
166<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_ROWS">SHARDS_ROWS</A></B></CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;per-shard start and rows</TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173<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>
174<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_START">SHARDS_START</A></B></CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
178</TR>
179<TR BGCOLOR="white" CLASS="TableRowColor">
180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181<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>
182<TD><CODE><B><A HREF="../../../../../org/apache/solr/common/params/ShardParams.html#SHARDS_TOLERANT">SHARDS_TOLERANT</A></B></CODE>
183
184<BR>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Should things fail if there is an error? (true/false)</TD>
186</TR>
187</TABLE>
188&nbsp;
189<P>
190
191<!-- ============ FIELD DETAIL =========== -->
192
193<A NAME="field_detail"><!-- --></A>
194<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
195<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
196<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
197<B>Field Detail</B></FONT></TH>
198</TR>
199</TABLE>
200
201<A NAME="SHARDS"><!-- --></A><H3>
202SHARDS</H3>
203<PRE>
204static 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>SHARDS</B></PRE>
205<DL>
206<DD>the shards to use (distributed configuration)
207<P>
208<DL>
209<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS">Constant Field Values</A></DL>
210</DL>
211<HR>
212
213<A NAME="SHARDS_ROWS"><!-- --></A><H3>
214SHARDS_ROWS</H3>
215<PRE>
216static 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>SHARDS_ROWS</B></PRE>
217<DL>
218<DD>per-shard start and rows
219<P>
220<DL>
221<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_ROWS">Constant Field Values</A></DL>
222</DL>
223<HR>
224
225<A NAME="SHARDS_START"><!-- --></A><H3>
226SHARDS_START</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>SHARDS_START</B></PRE>
229<DL>
230<DL>
231<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_START">Constant Field Values</A></DL>
232</DL>
233<HR>
234
235<A NAME="IDS"><!-- --></A><H3>
236IDS</H3>
237<PRE>
238static 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>IDS</B></PRE>
239<DL>
240<DD>IDs of the shard documents
241<P>
242<DL>
243<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.IDS">Constant Field Values</A></DL>
244</DL>
245<HR>
246
247<A NAME="IS_SHARD"><!-- --></A><H3>
248IS_SHARD</H3>
249<PRE>
250static 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>IS_SHARD</B></PRE>
251<DL>
252<DD>whether the request goes to a shard
253<P>
254<DL>
255<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.IS_SHARD">Constant Field Values</A></DL>
256</DL>
257<HR>
258
259<A NAME="SHARD_URL"><!-- --></A><H3>
260SHARD_URL</H3>
261<PRE>
262static 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>SHARD_URL</B></PRE>
263<DL>
264<DD>The requested URL for this shard
265<P>
266<DL>
267<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARD_URL">Constant Field Values</A></DL>
268</DL>
269<HR>
270
271<A NAME="SHARDS_QT"><!-- --></A><H3>
272SHARDS_QT</H3>
273<PRE>
274static 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>SHARDS_QT</B></PRE>
275<DL>
276<DD>The Request Handler for shard requests
277<P>
278<DL>
279<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_QT">Constant Field Values</A></DL>
280</DL>
281<HR>
282
283<A NAME="SHARDS_INFO"><!-- --></A><H3>
284SHARDS_INFO</H3>
285<PRE>
286static 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>SHARDS_INFO</B></PRE>
287<DL>
288<DD>Request detailed match info for each shard (true/false)
289<P>
290<DL>
291<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_INFO">Constant Field Values</A></DL>
292</DL>
293<HR>
294
295<A NAME="SHARDS_TOLERANT"><!-- --></A><H3>
296SHARDS_TOLERANT</H3>
297<PRE>
298static 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>SHARDS_TOLERANT</B></PRE>
299<DL>
300<DD>Should things fail if there is an error? (true/false)
301<P>
302<DL>
303<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.solr.common.params.ShardParams.SHARDS_TOLERANT">Constant Field Values</A></DL>
304</DL>
305<!-- ========= END OF CLASS DATA ========= -->
306<HR>
307
308
309<!-- ======= START OF BOTTOM NAVBAR ====== -->
310<A NAME="navbar_bottom"><!-- --></A>
311<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
312<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
313<TR>
314<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
315<A NAME="navbar_bottom_firstrow"><!-- --></A>
316<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
317  <TR ALIGN="center" VALIGN="top">
318  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
319  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
320  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
321  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ShardParams.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
322  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
323  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
324  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
325  </TR>
326</TABLE>
327</TD>
328<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
329</EM>
330</TD>
331</TR>
332
333<TR>
334<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
335&nbsp;<A HREF="../../../../../org/apache/solr/common/params/RequiredSolrParams.html" title="class in org.apache.solr.common.params"><B>PREV CLASS</B></A>&nbsp;
336&nbsp;<A HREF="../../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params"><B>NEXT CLASS</B></A></FONT></TD>
337<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
338  <A HREF="../../../../../index.html?org/apache/solr/common/params/ShardParams.html" target="_top"><B>FRAMES</B></A>  &nbsp;
339&nbsp;<A HREF="ShardParams.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
340&nbsp;<SCRIPT type="text/javascript">
341  <!--
342  if(window==top) {
343    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
344  }
345  //-->
346</SCRIPT>
347<NOSCRIPT>
348  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
349</NOSCRIPT>
350
351
352</FONT></TD>
353</TR>
354<TR>
355<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
356  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
357<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
358DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
359</TR>
360</TABLE>
361<A NAME="skip-navbar_bottom"></A>
362<!-- ======== END OF BOTTOM NAVBAR ======= -->
363
364<HR>
365
366          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
367          <script src='../../../../../prettify.js' type='text/javascript'></script>
368          <script type='text/javascript'>
369            (function(){
370              var oldonload = window.onload;
371              if (typeof oldonload != 'function') {
372                window.onload = prettyPrint;
373              } else {
374                window.onload = function() {
375                  oldonload();
376                  prettyPrint();
377                }
378              }
379            })();
380          </script>
381       
382</BODY>
383</HTML>
Note: See TracBrowser for help on using the repository browser.