source: sandbox/expresso-solr/solr/docs/api/org/apache/solr/highlight/SolrFragListBuilder.html @ 7588

Revision 7588, 14.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:24 EDT 2012 -->
6<META http-equiv="Content-Type" content="text/html; charset=utf-8">
7<TITLE>
8SolrFragListBuilder (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="SolrFragListBuilder (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/SolrFragListBuilder.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/highlight/SolrFormatter.html" title="interface in org.apache.solr.highlight"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/highlight/SolrFragmenter.html" title="interface in org.apache.solr.highlight"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../index.html?org/apache/solr/highlight/SolrFragListBuilder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="SolrFragListBuilder.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.highlight</FONT>
92<BR>
93Interface SolrFragListBuilder</H2>
94<DL>
95<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></DD>
96</DL>
97<DL>
98<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/solr/highlight/SimpleFragListBuilder.html" title="class in org.apache.solr.highlight">SimpleFragListBuilder</A>, <A HREF="../../../../org/apache/solr/highlight/SingleFragListBuilder.html" title="class in org.apache.solr.highlight">SingleFragListBuilder</A>, <A HREF="../../../../org/apache/solr/highlight/WeightedFragListBuilder.html" title="class in org.apache.solr.highlight">WeightedFragListBuilder</A></DD>
99</DL>
100<HR>
101<DL>
102<DT><PRE>public interface <B>SolrFragListBuilder</B><DT>extends <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></DL>
103</PRE>
104
105<P>
106<HR>
107
108<P>
109<!-- ======== NESTED CLASS SUMMARY ======== -->
110
111<A NAME="nested_class_summary"><!-- --></A>
112<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
113<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
114<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
115<B>Nested Class Summary</B></FONT></TH>
116</TR>
117</TABLE>
118&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
121<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>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
125</TR>
126</TABLE>
127&nbsp;
128
129<!-- ========== METHOD SUMMARY =========== -->
130
131<A NAME="method_summary"><!-- --></A>
132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
133<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
134<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
135<B>Method Summary</B></FONT></TH>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139<CODE>&nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/vectorhighlight/FragListBuilder.html?is-external=true" title="class or interface in org.apache.lucene.search.vectorhighlight">FragListBuilder</A></CODE></FONT></TD>
140<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrFragListBuilder.html#getFragListBuilder(org.apache.solr.common.params.SolrParams)">getFragListBuilder</A></B>(<A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a FragListBuilder.</TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>&nbsp;void</CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrFragListBuilder.html#init(org.apache.solr.common.util.NamedList)">init</A></B>(<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;args)</CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>init</code> will be called just once, immediately after creation.</TD>
152</TR>
153</TABLE>
154&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
155<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
156<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
157<TH ALIGN="left"><B>Methods 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>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getCategory()">getCategory</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">getDescription</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDocs()">getDocs</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getName()">getName</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">getSource</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getStatistics()">getStatistics</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getVersion()">getVersion</A></CODE></TD>
161</TR>
162</TABLE>
163&nbsp;
164<P>
165
166<!-- ============ METHOD DETAIL ========== -->
167
168<A NAME="method_detail"><!-- --></A>
169<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
171<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
172<B>Method Detail</B></FONT></TH>
173</TR>
174</TABLE>
175
176<A NAME="init(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
177init</H3>
178<PRE>
179void <B>init</B>(<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&nbsp;args)</PRE>
180<DL>
181<DD><code>init</code> will be called just once, immediately after creation.
182 <p>The args are user-level initialization parameters that
183 may be specified when declaring a request handler in
184 solrconfig.xml
185<P>
186<DD><DL>
187<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></DL>
188</DD>
189<DD><DL>
190</DL>
191</DD>
192</DL>
193<HR>
194
195<A NAME="getFragListBuilder(org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
196getFragListBuilder</H3>
197<PRE>
198<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/vectorhighlight/FragListBuilder.html?is-external=true" title="class or interface in org.apache.lucene.search.vectorhighlight">FragListBuilder</A> <B>getFragListBuilder</B>(<A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</PRE>
199<DL>
200<DD>Return a FragListBuilder.
201<P>
202<DD><DL>
203</DL>
204</DD>
205<DD><DL>
206<DT><B>Parameters:</B><DD><CODE>params</CODE> - The params controlling Highlighting
207<DT><B>Returns:</B><DD>An appropriate FragListBuilder.</DL>
208</DD>
209</DL>
210<!-- ========= END OF CLASS DATA ========= -->
211<HR>
212
213
214<!-- ======= START OF BOTTOM NAVBAR ====== -->
215<A NAME="navbar_bottom"><!-- --></A>
216<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
217<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
218<TR>
219<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
220<A NAME="navbar_bottom_firstrow"><!-- --></A>
221<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
222  <TR ALIGN="center" VALIGN="top">
223  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
224  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
225  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
226  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SolrFragListBuilder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
227  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
228  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
229  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
230  </TR>
231</TABLE>
232</TD>
233<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
234</EM>
235</TD>
236</TR>
237
238<TR>
239<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
240&nbsp;<A HREF="../../../../org/apache/solr/highlight/SolrFormatter.html" title="interface in org.apache.solr.highlight"><B>PREV CLASS</B></A>&nbsp;
241&nbsp;<A HREF="../../../../org/apache/solr/highlight/SolrFragmenter.html" title="interface in org.apache.solr.highlight"><B>NEXT CLASS</B></A></FONT></TD>
242<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
243  <A HREF="../../../../index.html?org/apache/solr/highlight/SolrFragListBuilder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
244&nbsp;<A HREF="SolrFragListBuilder.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
245&nbsp;<SCRIPT type="text/javascript">
246  <!--
247  if(window==top) {
248    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
249  }
250  //-->
251</SCRIPT>
252<NOSCRIPT>
253  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
254</NOSCRIPT>
255
256
257</FONT></TD>
258</TR>
259<TR>
260<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
261  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
262<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
263DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
264</TR>
265</TABLE>
266<A NAME="skip-navbar_bottom"></A>
267<!-- ======== END OF BOTTOM NAVBAR ======= -->
268
269<HR>
270
271          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
272          <script src='../../../../prettify.js' type='text/javascript'></script>
273          <script type='text/javascript'>
274            (function(){
275              var oldonload = window.onload;
276              if (typeof oldonload != 'function') {
277                window.onload = prettyPrint;
278              } else {
279                window.onload = function() {
280                  oldonload();
281                  prettyPrint();
282                }
283              }
284            })();
285          </script>
286       
287</BODY>
288</HTML>
Note: See TracBrowser for help on using the repository browser.