source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/search/ExtendedQuery.html @ 7588

Revision 7588, 12.1 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:25 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8ExtendedQuery (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="ExtendedQuery (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/ExtendedQuery.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/search/ExtendedDismaxQParserPlugin.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/search/ExtendedQueryBase.html" title="class in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../index.html?org/apache/solr/search/ExtendedQuery.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="ExtendedQuery.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;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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">
91org.apache.solr.search</FONT>
92<BR>
93Interface ExtendedQuery</H2>
94<DL>
95<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/solr/search/PostFilter.html" title="interface in org.apache.solr.search">PostFilter</A></DD>
96</DL>
97<DL>
98<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/solr/search/ExtendedQueryBase.html" title="class in org.apache.solr.search">ExtendedQueryBase</A>, <A HREF="../../../../org/apache/solr/search/FunctionRangeQuery.html" title="class in org.apache.solr.search">FunctionRangeQuery</A>, <A HREF="../../../../org/apache/solr/search/SolrConstantScoreQuery.html" title="class in org.apache.solr.search">SolrConstantScoreQuery</A>, <A HREF="../../../../org/apache/solr/search/WrappedQuery.html" title="class in org.apache.solr.search">WrappedQuery</A></DD>
99</DL>
100<HR>
101<DL>
102<DT><PRE>public interface <B>ExtendedQuery</B></DL>
103</PRE>
104
105<P>
106The ExtendedQuery interface provides extra metadata to a query.
107  Implementations of ExtendedQuery must also extend Query.
108<P>
109
110<P>
111<HR>
112
113<P>
114
115<!-- ========== METHOD SUMMARY =========== -->
116
117<A NAME="method_summary"><!-- --></A>
118<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
119<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
120<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
121<B>Method Summary</B></FONT></TH>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125<CODE>&nbsp;boolean</CODE></FONT></TD>
126<TD><CODE><B><A HREF="../../../../org/apache/solr/search/ExtendedQuery.html#getCache()">getCache</A></B>()</CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Should this query be cached in the query cache or filter cache.</TD>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133<CODE>&nbsp;boolean</CODE></FONT></TD>
134<TD><CODE><B><A HREF="../../../../org/apache/solr/search/ExtendedQuery.html#getCacheSep()">getCacheSep</A></B>()</CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, the clauses of this boolean query should be cached separately.</TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>&nbsp;int</CODE></FONT></TD>
142<TD><CODE><B><A HREF="../../../../org/apache/solr/search/ExtendedQuery.html#getCost()">getCost</A></B>()</CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the cost of this query, used to order checking of filters that are not cached.</TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149<CODE>&nbsp;void</CODE></FONT></TD>
150<TD><CODE><B><A HREF="../../../../org/apache/solr/search/ExtendedQuery.html#setCache(boolean)">setCache</A></B>(boolean&nbsp;cache)</CODE>
151
152<BR>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<CODE>&nbsp;void</CODE></FONT></TD>
158<TD><CODE><B><A HREF="../../../../org/apache/solr/search/ExtendedQuery.html#setCacheSep(boolean)">setCacheSep</A></B>(boolean&nbsp;cacheSep)</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<CODE>&nbsp;void</CODE></FONT></TD>
166<TD><CODE><B><A HREF="../../../../org/apache/solr/search/ExtendedQuery.html#setCost(int)">setCost</A></B>(int&nbsp;cost)</CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
170</TR>
171</TABLE>
172&nbsp;
173<P>
174
175<!-- ============ METHOD DETAIL ========== -->
176
177<A NAME="method_detail"><!-- --></A>
178<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
179<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
180<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
181<B>Method Detail</B></FONT></TH>
182</TR>
183</TABLE>
184
185<A NAME="getCache()"><!-- --></A><H3>
186getCache</H3>
187<PRE>
188boolean <B>getCache</B>()</PRE>
189<DL>
190<DD>Should this query be cached in the query cache or filter cache.
191<P>
192<DD><DL>
193</DL>
194</DD>
195</DL>
196<HR>
197
198<A NAME="setCache(boolean)"><!-- --></A><H3>
199setCache</H3>
200<PRE>
201void <B>setCache</B>(boolean&nbsp;cache)</PRE>
202<DL>
203<DD><DL>
204</DL>
205</DD>
206</DL>
207<HR>
208
209<A NAME="getCost()"><!-- --></A><H3>
210getCost</H3>
211<PRE>
212int <B>getCost</B>()</PRE>
213<DL>
214<DD>Returns the cost of this query, used to order checking of filters that are not cached.
215 If getCache()==false && getCost()>=100 && this instanceof PostFilter, then
216 the PostFilter interface will be used for filtering.
217<P>
218<DD><DL>
219</DL>
220</DD>
221</DL>
222<HR>
223
224<A NAME="setCost(int)"><!-- --></A><H3>
225setCost</H3>
226<PRE>
227void <B>setCost</B>(int&nbsp;cost)</PRE>
228<DL>
229<DD><DL>
230</DL>
231</DD>
232</DL>
233<HR>
234
235<A NAME="getCacheSep()"><!-- --></A><H3>
236getCacheSep</H3>
237<PRE>
238boolean <B>getCacheSep</B>()</PRE>
239<DL>
240<DD>If true, the clauses of this boolean query should be cached separately. This is not yet implemented.
241<P>
242<DD><DL>
243</DL>
244</DD>
245</DL>
246<HR>
247
248<A NAME="setCacheSep(boolean)"><!-- --></A><H3>
249setCacheSep</H3>
250<PRE>
251void <B>setCacheSep</B>(boolean&nbsp;cacheSep)</PRE>
252<DL>
253<DD><DL>
254</DL>
255</DD>
256</DL>
257<!-- ========= END OF CLASS DATA ========= -->
258<HR>
259
260
261<!-- ======= START OF BOTTOM NAVBAR ====== -->
262<A NAME="navbar_bottom"><!-- --></A>
263<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
264<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
265<TR>
266<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
267<A NAME="navbar_bottom_firstrow"><!-- --></A>
268<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
269  <TR ALIGN="center" VALIGN="top">
270  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
271  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
272  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
273  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ExtendedQuery.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
274  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
275  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
276  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
277  </TR>
278</TABLE>
279</TD>
280<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
281</EM>
282</TD>
283</TR>
284
285<TR>
286<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
287&nbsp;<A HREF="../../../../org/apache/solr/search/ExtendedDismaxQParserPlugin.html" title="class in org.apache.solr.search"><B>PREV CLASS</B></A>&nbsp;
288&nbsp;<A HREF="../../../../org/apache/solr/search/ExtendedQueryBase.html" title="class in org.apache.solr.search"><B>NEXT CLASS</B></A></FONT></TD>
289<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
290  <A HREF="../../../../index.html?org/apache/solr/search/ExtendedQuery.html" target="_top"><B>FRAMES</B></A>  &nbsp;
291&nbsp;<A HREF="ExtendedQuery.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
292&nbsp;<SCRIPT type="text/javascript">
293  <!--
294  if(window==top) {
295    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
296  }
297  //-->
298</SCRIPT>
299<NOSCRIPT>
300  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
301</NOSCRIPT>
302
303
304</FONT></TD>
305</TR>
306<TR>
307<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
308  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
309<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
310DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
311</TR>
312</TABLE>
313<A NAME="skip-navbar_bottom"></A>
314<!-- ======== END OF BOTTOM NAVBAR ======= -->
315
316<HR>
317
318          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
319          <script src='../../../../prettify.js' type='text/javascript'></script>
320          <script type='text/javascript'>
321            (function(){
322              var oldonload = window.onload;
323              if (typeof oldonload != 'function') {
324                window.onload = prettyPrint;
325              } else {
326                window.onload = function() {
327                  oldonload();
328                  prettyPrint();
329                }
330              }
331            })();
332          </script>
333       
334</BODY>
335</HTML>
Note: See TracBrowser for help on using the repository browser.