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

Revision 7588, 44.9 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>
8DefaultSolrHighlighter (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="DefaultSolrHighlighter (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/DefaultSolrHighlighter.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/DefaultEncoder.html" title="class in org.apache.solr.highlight"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/highlight/GapFragmenter.html" title="class 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/DefaultSolrHighlighter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="DefaultSolrHighlighter.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;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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>
93Class DefaultSolrHighlighter</H2>
94<PRE>
95<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html" title="class in org.apache.solr.highlight">org.apache.solr.highlight.SolrHighlighter</A>
97      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.highlight.DefaultSolrHighlighter</B>
98</PRE>
99<DL>
100<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/solr/util/plugin/PluginInfoInitialized.html" title="interface in org.apache.solr.util.plugin">PluginInfoInitialized</A></DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public class <B>DefaultSolrHighlighter</B><DT>extends <A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html" title="class in org.apache.solr.highlight">SolrHighlighter</A><DT>implements <A HREF="../../../../org/apache/solr/util/plugin/PluginInfoInitialized.html" title="interface in org.apache.solr.util.plugin">PluginInfoInitialized</A></DL>
105</PRE>
106
107<P>
108<DL>
109<DT><B>Since:</B></DT>
110  <DD>solr 1.3</DD>
111</DL>
112<HR>
113
114<P>
115<!-- =========== FIELD SUMMARY =========== -->
116
117<A NAME="field_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>Field 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>static&nbsp;org.slf4j.Logger</CODE></FONT></TD>
126<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#log">log</A></B></CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
130</TR>
131</TABLE>
132&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.highlight.SolrHighlighter"><!-- --></A>
133<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
134<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
135<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.highlight.<A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html" title="class in org.apache.solr.highlight">SolrHighlighter</A></B></TH>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD><CODE><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#boundaryScanners">boundaryScanners</A>, <A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#encoders">encoders</A>, <A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#formatters">formatters</A>, <A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#fragListBuilders">fragListBuilders</A>, <A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#fragmenters">fragmenters</A>, <A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#fragmentsBuilders">fragmentsBuilders</A></CODE></TD>
139</TR>
140</TABLE>
141&nbsp;
142<!-- ======== CONSTRUCTOR SUMMARY ======== -->
143
144<A NAME="constructor_summary"><!-- --></A>
145<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
146<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
147<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
148<B>Constructor Summary</B></FONT></TH>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#DefaultSolrHighlighter()">DefaultSolrHighlighter</A></B>()</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#DefaultSolrHighlighter(org.apache.solr.core.SolrCore)">DefaultSolrHighlighter</A></B>(<A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;solrCore)</CODE>
158
159<BR>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
161</TR>
162</TABLE>
163&nbsp;
164<!-- ========== METHOD SUMMARY =========== -->
165
166<A NAME="method_summary"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
169<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
170<B>Method Summary</B></FONT></TH>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174<CODE>&nbsp;<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&gt;</CODE></FONT></TD>
175<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#doHighlighting(org.apache.solr.search.DocList, org.apache.lucene.search.Query, org.apache.solr.request.SolrQueryRequest, java.lang.String[])">doHighlighting</A></B>(<A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A>&nbsp;docs,
176               <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
177               <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
178               <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>[]&nbsp;defaultFields)</CODE>
179
180<BR>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Generates a list of Highlighted query fragments for each item in a list
182 of documents, or returns null if highlighting is disabled.</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Encoder.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight">Encoder</A></CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#getEncoder(java.lang.String, org.apache.solr.common.params.SolrParams)">getEncoder</A></B>(<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>&nbsp;fieldName,
188           <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</CODE>
189
190<BR>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return an <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Encoder.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>Encoder</CODE></A> appropriate for this field.</TD>
192</TR>
193<TR BGCOLOR="white" CLASS="TableRowColor">
194<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
195<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Formatter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight">Formatter</A></CODE></FONT></TD>
196<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#getFormatter(java.lang.String, org.apache.solr.common.params.SolrParams)">getFormatter</A></B>(<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>&nbsp;fieldName,
197             <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Formatter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>Formatter</CODE></A> appropriate for this field.</TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204<CODE>protected &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>
205<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#getFragListBuilder(java.lang.String, org.apache.solr.common.params.SolrParams)">getFragListBuilder</A></B>(<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>&nbsp;fieldName,
206                   <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</CODE>
207
208<BR>
209&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
210</TR>
211<TR BGCOLOR="white" CLASS="TableRowColor">
212<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Fragmenter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight">Fragmenter</A></CODE></FONT></TD>
214<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#getFragmenter(java.lang.String, org.apache.solr.common.params.SolrParams)">getFragmenter</A></B>(<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>&nbsp;fieldName,
215              <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</CODE>
216
217<BR>
218&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Fragmenter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>Fragmenter</CODE></A> appropriate for this field.</TD>
219</TR>
220<TR BGCOLOR="white" CLASS="TableRowColor">
221<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/vectorhighlight/FragmentsBuilder.html?is-external=true" title="class or interface in org.apache.lucene.search.vectorhighlight">FragmentsBuilder</A></CODE></FONT></TD>
223<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#getFragmentsBuilder(java.lang.String, org.apache.solr.common.params.SolrParams)">getFragmentsBuilder</A></B>(<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>&nbsp;fieldName,
224                    <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</CODE>
225
226<BR>
227&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Highlighter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight">Highlighter</A></CODE></FONT></TD>
232<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#getHighlighter(org.apache.lucene.search.Query, java.lang.String, org.apache.solr.request.SolrQueryRequest)">getHighlighter</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
233               <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>&nbsp;fieldName,
234               <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request)</CODE>
235
236<BR>
237&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Highlighter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>Highlighter</CODE></A> appropriate for this field.</TD>
238</TR>
239<TR BGCOLOR="white" CLASS="TableRowColor">
240<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241<CODE>protected &nbsp;int</CODE></FONT></TD>
242<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#getMaxSnippets(java.lang.String, org.apache.solr.common.params.SolrParams)">getMaxSnippets</A></B>(<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>&nbsp;fieldName,
243               <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</CODE>
244
245<BR>
246&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the max number of snippets for this field.</TD>
247</TR>
248<TR BGCOLOR="white" CLASS="TableRowColor">
249<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
250<CODE>protected &nbsp;<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Highlighter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight">Highlighter</A></CODE></FONT></TD>
251<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#getPhraseHighlighter(org.apache.lucene.search.Query, java.lang.String, org.apache.solr.request.SolrQueryRequest, org.apache.lucene.analysis.CachingTokenFilter)">getPhraseHighlighter</A></B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
252                     <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>&nbsp;fieldName,
253                     <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request,
254                     <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/CachingTokenFilter.html?is-external=true" title="class or interface in org.apache.lucene.analysis">CachingTokenFilter</A>&nbsp;tokenStream)</CODE>
255
256<BR>
257&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a phrase <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Highlighter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>Highlighter</CODE></A> appropriate for this field.</TD>
258</TR>
259<TR BGCOLOR="white" CLASS="TableRowColor">
260<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261<CODE>&nbsp;void</CODE></FONT></TD>
262<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#init(org.apache.solr.core.PluginInfo)">init</A></B>(<A HREF="../../../../org/apache/solr/core/PluginInfo.html" title="class in org.apache.solr.core">PluginInfo</A>&nbsp;info)</CODE>
263
264<BR>
265&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
266</TR>
267<TR BGCOLOR="white" CLASS="TableRowColor">
268<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269<CODE>&nbsp;void</CODE></FONT></TD>
270<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#initalize(org.apache.solr.core.SolrConfig)">initalize</A></B>(<A HREF="../../../../org/apache/solr/core/SolrConfig.html" title="class in org.apache.solr.core">SolrConfig</A>&nbsp;config)</CODE>
271
272<BR>
273&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;</TD>
274</TR>
275<TR BGCOLOR="white" CLASS="TableRowColor">
276<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
277<CODE>protected &nbsp;boolean</CODE></FONT></TD>
278<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html#isMergeContiguousFragments(java.lang.String, org.apache.solr.common.params.SolrParams)">isMergeContiguousFragments</A></B>(<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>&nbsp;fieldName,
279                           <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</CODE>
280
281<BR>
282&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return whether adjacent fragments should be merged.</TD>
283</TR>
284</TABLE>
285&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.highlight.SolrHighlighter"><!-- --></A>
286<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
287<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
288<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.highlight.<A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html" title="class in org.apache.solr.highlight">SolrHighlighter</A></B></TH>
289</TR>
290<TR BGCOLOR="white" CLASS="TableRowColor">
291<TD><CODE><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#emptyArray(java.lang.String[])">emptyArray</A>, <A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#getHighlightFields(org.apache.lucene.search.Query, org.apache.solr.request.SolrQueryRequest, java.lang.String[])">getHighlightFields</A>, <A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#isHighlightingEnabled(org.apache.solr.common.params.SolrParams)">isHighlightingEnabled</A></CODE></TD>
292</TR>
293</TABLE>
294&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
295<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
296<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
297<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
298</TR>
299<TR BGCOLOR="white" CLASS="TableRowColor">
300<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
301</TR>
302</TABLE>
303&nbsp;
304<P>
305
306<!-- ============ FIELD DETAIL =========== -->
307
308<A NAME="field_detail"><!-- --></A>
309<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
310<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
311<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
312<B>Field Detail</B></FONT></TH>
313</TR>
314</TABLE>
315
316<A NAME="log"><!-- --></A><H3>
317log</H3>
318<PRE>
319public static org.slf4j.Logger <B>log</B></PRE>
320<DL>
321<DL>
322</DL>
323</DL>
324
325<!-- ========= CONSTRUCTOR DETAIL ======== -->
326
327<A NAME="constructor_detail"><!-- --></A>
328<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
329<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
330<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
331<B>Constructor Detail</B></FONT></TH>
332</TR>
333</TABLE>
334
335<A NAME="DefaultSolrHighlighter()"><!-- --></A><H3>
336DefaultSolrHighlighter</H3>
337<PRE>
338public <B>DefaultSolrHighlighter</B>()</PRE>
339<DL>
340</DL>
341<HR>
342
343<A NAME="DefaultSolrHighlighter(org.apache.solr.core.SolrCore)"><!-- --></A><H3>
344DefaultSolrHighlighter</H3>
345<PRE>
346public <B>DefaultSolrHighlighter</B>(<A HREF="../../../../org/apache/solr/core/SolrCore.html" title="class in org.apache.solr.core">SolrCore</A>&nbsp;solrCore)</PRE>
347<DL>
348</DL>
349
350<!-- ============ METHOD DETAIL ========== -->
351
352<A NAME="method_detail"><!-- --></A>
353<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
354<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
355<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
356<B>Method Detail</B></FONT></TH>
357</TR>
358</TABLE>
359
360<A NAME="init(org.apache.solr.core.PluginInfo)"><!-- --></A><H3>
361init</H3>
362<PRE>
363public void <B>init</B>(<A HREF="../../../../org/apache/solr/core/PluginInfo.html" title="class in org.apache.solr.core">PluginInfo</A>&nbsp;info)</PRE>
364<DL>
365<DD><DL>
366<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/util/plugin/PluginInfoInitialized.html#init(org.apache.solr.core.PluginInfo)">init</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/util/plugin/PluginInfoInitialized.html" title="interface in org.apache.solr.util.plugin">PluginInfoInitialized</A></CODE></DL>
367</DD>
368<DD><DL>
369</DL>
370</DD>
371</DL>
372<HR>
373
374<A NAME="initalize(org.apache.solr.core.SolrConfig)"><!-- --></A><H3>
375initalize</H3>
376<PRE>
377<FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A>
378</FONT>public void <B>initalize</B>(<A HREF="../../../../org/apache/solr/core/SolrConfig.html" title="class in org.apache.solr.core">SolrConfig</A>&nbsp;config)</PRE>
379<DL>
380<DD><B>Deprecated.</B>&nbsp;
381<P>
382<DD><DL>
383<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#initalize(org.apache.solr.core.SolrConfig)">initalize</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html" title="class in org.apache.solr.highlight">SolrHighlighter</A></CODE></DL>
384</DD>
385<DD><DL>
386</DL>
387</DD>
388</DL>
389<HR>
390
391<A NAME="getPhraseHighlighter(org.apache.lucene.search.Query, java.lang.String, org.apache.solr.request.SolrQueryRequest, org.apache.lucene.analysis.CachingTokenFilter)"><!-- --></A><H3>
392getPhraseHighlighter</H3>
393<PRE>
394protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Highlighter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight">Highlighter</A> <B>getPhraseHighlighter</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
395                                           <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>&nbsp;fieldName,
396                                           <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request,
397                                           <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/analysis/CachingTokenFilter.html?is-external=true" title="class or interface in org.apache.lucene.analysis">CachingTokenFilter</A>&nbsp;tokenStream)
398                                    throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
399<DL>
400<DD>Return a phrase <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Highlighter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>Highlighter</CODE></A> appropriate for this field.
401<P>
402<DD><DL>
403</DL>
404</DD>
405<DD><DL>
406<DT><B>Parameters:</B><DD><CODE>query</CODE> - The current Query<DD><CODE>fieldName</CODE> - The name of the field<DD><CODE>request</CODE> - The current SolrQueryRequest<DD><CODE>tokenStream</CODE> - document text CachingTokenStream
407<DT><B>Throws:</B>
408<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
409</DD>
410</DL>
411<HR>
412
413<A NAME="getHighlighter(org.apache.lucene.search.Query, java.lang.String, org.apache.solr.request.SolrQueryRequest)"><!-- --></A><H3>
414getHighlighter</H3>
415<PRE>
416protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Highlighter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight">Highlighter</A> <B>getHighlighter</B>(<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
417                                     <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>&nbsp;fieldName,
418                                     <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;request)</PRE>
419<DL>
420<DD>Return a <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Highlighter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>Highlighter</CODE></A> appropriate for this field.
421<P>
422<DD><DL>
423</DL>
424</DD>
425<DD><DL>
426<DT><B>Parameters:</B><DD><CODE>query</CODE> - The current Query<DD><CODE>fieldName</CODE> - The name of the field<DD><CODE>request</CODE> - The current SolrQueryRequest</DL>
427</DD>
428</DL>
429<HR>
430
431<A NAME="getMaxSnippets(java.lang.String, org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
432getMaxSnippets</H3>
433<PRE>
434protected int <B>getMaxSnippets</B>(<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>&nbsp;fieldName,
435                             <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</PRE>
436<DL>
437<DD>Return the max number of snippets for this field. If this has not
438 been configured for this field, fall back to the configured default
439 or the solr default.
440<P>
441<DD><DL>
442</DL>
443</DD>
444<DD><DL>
445<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - The name of the field<DD><CODE>params</CODE> - The params controlling Highlighting</DL>
446</DD>
447</DL>
448<HR>
449
450<A NAME="isMergeContiguousFragments(java.lang.String, org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
451isMergeContiguousFragments</H3>
452<PRE>
453protected boolean <B>isMergeContiguousFragments</B>(<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>&nbsp;fieldName,
454                                             <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</PRE>
455<DL>
456<DD>Return whether adjacent fragments should be merged.
457<P>
458<DD><DL>
459</DL>
460</DD>
461<DD><DL>
462<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - The name of the field<DD><CODE>params</CODE> - The params controlling Highlighting</DL>
463</DD>
464</DL>
465<HR>
466
467<A NAME="getFormatter(java.lang.String, org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
468getFormatter</H3>
469<PRE>
470protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Formatter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight">Formatter</A> <B>getFormatter</B>(<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>&nbsp;fieldName,
471                                 <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</PRE>
472<DL>
473<DD>Return a <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Formatter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>Formatter</CODE></A> appropriate for this field. If a formatter
474 has not been configured for this field, fall back to the configured
475 default or the solr default (<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/SimpleHTMLFormatter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>SimpleHTMLFormatter</CODE></A>).
476<P>
477<DD><DL>
478</DL>
479</DD>
480<DD><DL>
481<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - The name of the field<DD><CODE>params</CODE> - The params controlling Highlighting
482<DT><B>Returns:</B><DD>An appropriate <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Formatter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>Formatter</CODE></A>.</DL>
483</DD>
484</DL>
485<HR>
486
487<A NAME="getEncoder(java.lang.String, org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
488getEncoder</H3>
489<PRE>
490protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Encoder.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight">Encoder</A> <B>getEncoder</B>(<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>&nbsp;fieldName,
491                             <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</PRE>
492<DL>
493<DD>Return an <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Encoder.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>Encoder</CODE></A> appropriate for this field. If an encoder
494 has not been configured for this field, fall back to the configured
495 default or the solr default (<A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/DefaultEncoder.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>DefaultEncoder</CODE></A>).
496<P>
497<DD><DL>
498</DL>
499</DD>
500<DD><DL>
501<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - The name of the field<DD><CODE>params</CODE> - The params controlling Highlighting
502<DT><B>Returns:</B><DD>An appropriate <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Encoder.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>Encoder</CODE></A>.</DL>
503</DD>
504</DL>
505<HR>
506
507<A NAME="getFragmenter(java.lang.String, org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
508getFragmenter</H3>
509<PRE>
510protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Fragmenter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight">Fragmenter</A> <B>getFragmenter</B>(<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>&nbsp;fieldName,
511                                   <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</PRE>
512<DL>
513<DD>Return a <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Fragmenter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>Fragmenter</CODE></A> appropriate for this field. If a fragmenter
514 has not been configured for this field, fall back to the configured
515 default or the solr default (<A HREF="../../../../org/apache/solr/highlight/GapFragmenter.html" title="class in org.apache.solr.highlight"><CODE>GapFragmenter</CODE></A>).
516<P>
517<DD><DL>
518</DL>
519</DD>
520<DD><DL>
521<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - The name of the field<DD><CODE>params</CODE> - The params controlling Highlighting
522<DT><B>Returns:</B><DD>An appropriate <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/highlight/Fragmenter.html?is-external=true" title="class or interface in org.apache.lucene.search.highlight"><CODE>Fragmenter</CODE></A>.</DL>
523</DD>
524</DL>
525<HR>
526
527<A NAME="getFragListBuilder(java.lang.String, org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
528getFragListBuilder</H3>
529<PRE>
530protected <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="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;fieldName,
531                                             <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</PRE>
532<DL>
533<DD><DL>
534</DL>
535</DD>
536<DD><DL>
537</DL>
538</DD>
539</DL>
540<HR>
541
542<A NAME="getFragmentsBuilder(java.lang.String, org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
543getFragmentsBuilder</H3>
544<PRE>
545protected <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//highlighter/org/apache/lucene/search/vectorhighlight/FragmentsBuilder.html?is-external=true" title="class or interface in org.apache.lucene.search.vectorhighlight">FragmentsBuilder</A> <B>getFragmentsBuilder</B>(<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>&nbsp;fieldName,
546                                               <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</PRE>
547<DL>
548<DD><DL>
549</DL>
550</DD>
551<DD><DL>
552</DL>
553</DD>
554</DL>
555<HR>
556
557<A NAME="doHighlighting(org.apache.solr.search.DocList, org.apache.lucene.search.Query, org.apache.solr.request.SolrQueryRequest, java.lang.String[])"><!-- --></A><H3>
558doHighlighting</H3>
559<PRE>
560public <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A>&lt;<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&gt; <B>doHighlighting</B>(<A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A>&nbsp;docs,
561                                        <A HREF="http://lucene.apache.org/java/4_0_0-ALPHA//core/org/apache/lucene/search/Query.html?is-external=true" title="class or interface in org.apache.lucene.search">Query</A>&nbsp;query,
562                                        <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A>&nbsp;req,
563                                        <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>[]&nbsp;defaultFields)
564                                 throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
565<DL>
566<DD>Generates a list of Highlighted query fragments for each item in a list
567 of documents, or returns null if highlighting is disabled.
568<P>
569<DD><DL>
570<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#doHighlighting(org.apache.solr.search.DocList, org.apache.lucene.search.Query, org.apache.solr.request.SolrQueryRequest, java.lang.String[])">doHighlighting</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html" title="class in org.apache.solr.highlight">SolrHighlighter</A></CODE></DL>
571</DD>
572<DD><DL>
573<DT><B>Parameters:</B><DD><CODE>docs</CODE> - query results<DD><CODE>query</CODE> - the query<DD><CODE>req</CODE> - the current request<DD><CODE>defaultFields</CODE> - default list of fields to summarize
574<DT><B>Returns:</B><DD>NamedList containing a NamedList for each document, which in
575 turns contains sets (field, summary) pairs.
576<DT><B>Throws:</B>
577<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
578</DD>
579</DL>
580<!-- ========= END OF CLASS DATA ========= -->
581<HR>
582
583
584<!-- ======= START OF BOTTOM NAVBAR ====== -->
585<A NAME="navbar_bottom"><!-- --></A>
586<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
587<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
588<TR>
589<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
590<A NAME="navbar_bottom_firstrow"><!-- --></A>
591<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
592  <TR ALIGN="center" VALIGN="top">
593  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
594  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
595  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
596  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DefaultSolrHighlighter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
597  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
598  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
599  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
600  </TR>
601</TABLE>
602</TD>
603<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
604</EM>
605</TD>
606</TR>
607
608<TR>
609<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
610&nbsp;<A HREF="../../../../org/apache/solr/highlight/DefaultEncoder.html" title="class in org.apache.solr.highlight"><B>PREV CLASS</B></A>&nbsp;
611&nbsp;<A HREF="../../../../org/apache/solr/highlight/GapFragmenter.html" title="class in org.apache.solr.highlight"><B>NEXT CLASS</B></A></FONT></TD>
612<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
613  <A HREF="../../../../index.html?org/apache/solr/highlight/DefaultSolrHighlighter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
614&nbsp;<A HREF="DefaultSolrHighlighter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
615&nbsp;<SCRIPT type="text/javascript">
616  <!--
617  if(window==top) {
618    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
619  }
620  //-->
621</SCRIPT>
622<NOSCRIPT>
623  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
624</NOSCRIPT>
625
626
627</FONT></TD>
628</TR>
629<TR>
630<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
631  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
632<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
633DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
634</TR>
635</TABLE>
636<A NAME="skip-navbar_bottom"></A>
637<!-- ======== END OF BOTTOM NAVBAR ======= -->
638
639<HR>
640
641          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
642          <script src='../../../../prettify.js' type='text/javascript'></script>
643          <script type='text/javascript'>
644            (function(){
645              var oldonload = window.onload;
646              if (typeof oldonload != 'function') {
647                window.onload = prettyPrint;
648              } else {
649                window.onload = function() {
650                  oldonload();
651                  prettyPrint();
652                }
653              }
654            })();
655          </script>
656       
657</BODY>
658</HTML>
Note: See TracBrowser for help on using the repository browser.