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

Revision 7588, 23.8 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>
8DefaultEncoder (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="DefaultEncoder (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/DefaultEncoder.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/BreakIteratorBoundaryScanner.html" title="class in org.apache.solr.highlight"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.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/DefaultEncoder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="DefaultEncoder.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="#fields_inherited_from_class_org.apache.solr.highlight.HighlightingPluginBase">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;FIELD&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 DefaultEncoder</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/HighlightingPluginBase.html" title="class in org.apache.solr.highlight">org.apache.solr.highlight.HighlightingPluginBase</A>
97      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.solr.highlight.DefaultEncoder</B>
98</PRE>
99<DL>
100<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A>, <A HREF="../../../../org/apache/solr/highlight/SolrEncoder.html" title="interface in org.apache.solr.highlight">SolrEncoder</A>, <A HREF="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A></DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public class <B>DefaultEncoder</B><DT>extends <A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html" title="class in org.apache.solr.highlight">HighlightingPluginBase</A><DT>implements <A HREF="../../../../org/apache/solr/highlight/SolrEncoder.html" title="interface in org.apache.solr.highlight">SolrEncoder</A></DL>
105</PRE>
106
107<P>
108Use the <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>
109<P>
110
111<P>
112<HR>
113
114<P>
115<!-- ======== NESTED CLASS SUMMARY ======== -->
116
117<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
122</TR>
123</TABLE>
124&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
125<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
127<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>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<TD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
131</TR>
132</TABLE>
133&nbsp;
134<!-- =========== FIELD SUMMARY =========== -->
135
136<A NAME="field_summary"><!-- --></A>
137<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
138<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
139<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
140<B>Field Summary</B></FONT></TH>
141</TR>
142</TABLE>
143&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.highlight.HighlightingPluginBase"><!-- --></A>
144<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
145<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
146<TH ALIGN="left"><B>Fields inherited from class org.apache.solr.highlight.<A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html" title="class in org.apache.solr.highlight">HighlightingPluginBase</A></B></TH>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD><CODE><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#defaults">defaults</A>, <A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#numRequests">numRequests</A></CODE></TD>
150</TR>
151</TABLE>
152&nbsp;
153<!-- ======== CONSTRUCTOR SUMMARY ======== -->
154
155<A NAME="constructor_summary"><!-- --></A>
156<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
157<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
158<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
159<B>Constructor Summary</B></FONT></TH>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultEncoder.html#DefaultEncoder()">DefaultEncoder</A></B>()</CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
166</TR>
167</TABLE>
168&nbsp;
169<!-- ========== METHOD SUMMARY =========== -->
170
171<A NAME="method_summary"><!-- --></A>
172<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
173<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
174<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
175<B>Method Summary</B></FONT></TH>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<CODE>&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>
180<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultEncoder.html#getDescription()">getDescription</A></B>()</CODE>
181
182<BR>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Simple one or two line description</TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187<CODE>&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>
188<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultEncoder.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,
189           <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</CODE>
190
191<BR>
192&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>
193</TR>
194<TR BGCOLOR="white" CLASS="TableRowColor">
195<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196<CODE>&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>
197<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/DefaultEncoder.html#getSource()">getSource</A></B>()</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CVS Source, SVN Source, etc</TD>
201</TR>
202</TABLE>
203&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.highlight.HighlightingPluginBase"><!-- --></A>
204<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
205<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
206<TH ALIGN="left"><B>Methods inherited from class org.apache.solr.highlight.<A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html" title="class in org.apache.solr.highlight">HighlightingPluginBase</A></B></TH>
207</TR>
208<TR BGCOLOR="white" CLASS="TableRowColor">
209<TD><CODE><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#getCategory()">getCategory</A>, <A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#getDocs()">getDocs</A>, <A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#getName()">getName</A>, <A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#getStatistics()">getStatistics</A>, <A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#getVersion()">getVersion</A>, <A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE></TD>
210</TR>
211</TABLE>
212&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
213<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
214<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
215<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>
216</TR>
217<TR BGCOLOR="white" CLASS="TableRowColor">
218<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>
219</TR>
220</TABLE>
221&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.highlight.SolrEncoder"><!-- --></A>
222<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
223<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
224<TH ALIGN="left"><B>Methods inherited from interface org.apache.solr.highlight.<A HREF="../../../../org/apache/solr/highlight/SolrEncoder.html" title="interface in org.apache.solr.highlight">SolrEncoder</A></B></TH>
225</TR>
226<TR BGCOLOR="white" CLASS="TableRowColor">
227<TD><CODE><A HREF="../../../../org/apache/solr/highlight/SolrEncoder.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE></TD>
228</TR>
229</TABLE>
230&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
231<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
232<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
233<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>
234</TR>
235<TR BGCOLOR="white" CLASS="TableRowColor">
236<TD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getCategory()">getCategory</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#getStatistics()">getStatistics</A>, <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getVersion()">getVersion</A></CODE></TD>
237</TR>
238</TABLE>
239&nbsp;
240<P>
241
242<!-- ========= CONSTRUCTOR DETAIL ======== -->
243
244<A NAME="constructor_detail"><!-- --></A>
245<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
246<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
247<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
248<B>Constructor Detail</B></FONT></TH>
249</TR>
250</TABLE>
251
252<A NAME="DefaultEncoder()"><!-- --></A><H3>
253DefaultEncoder</H3>
254<PRE>
255public <B>DefaultEncoder</B>()</PRE>
256<DL>
257</DL>
258
259<!-- ============ METHOD DETAIL ========== -->
260
261<A NAME="method_detail"><!-- --></A>
262<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
263<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
264<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
265<B>Method Detail</B></FONT></TH>
266</TR>
267</TABLE>
268
269<A NAME="getEncoder(java.lang.String, org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
270getEncoder</H3>
271<PRE>
272public <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,
273                          <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</PRE>
274<DL>
275<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/highlight/SolrEncoder.html#getEncoder(java.lang.String, org.apache.solr.common.params.SolrParams)">SolrEncoder</A></CODE></B></DD>
276<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.
277<P>
278<DD><DL>
279<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/highlight/SolrEncoder.html#getEncoder(java.lang.String, org.apache.solr.common.params.SolrParams)">getEncoder</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/highlight/SolrEncoder.html" title="interface in org.apache.solr.highlight">SolrEncoder</A></CODE></DL>
280</DD>
281<DD><DL>
282<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - The name of the field<DD><CODE>params</CODE> - The params controlling Highlighting
283<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>
284</DD>
285</DL>
286<HR>
287
288<A NAME="getDescription()"><!-- --></A><H3>
289getDescription</H3>
290<PRE>
291public <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>getDescription</B>()</PRE>
292<DL>
293<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">SolrInfoMBean</A></CODE></B></DD>
294<DD>Simple one or two line description
295<P>
296<DD><DL>
297<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">getDescription</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#getDescription()">getDescription</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html" title="class in org.apache.solr.highlight">HighlightingPluginBase</A></CODE></DL>
298</DD>
299<DD><DL>
300</DL>
301</DD>
302</DL>
303<HR>
304
305<A NAME="getSource()"><!-- --></A><H3>
306getSource</H3>
307<PRE>
308public <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>getSource</B>()</PRE>
309<DL>
310<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">SolrInfoMBean</A></CODE></B></DD>
311<DD>CVS Source, SVN Source, etc
312<P>
313<DD><DL>
314<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">getSource</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#getSource()">getSource</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html" title="class in org.apache.solr.highlight">HighlightingPluginBase</A></CODE></DL>
315</DD>
316<DD><DL>
317</DL>
318</DD>
319</DL>
320<!-- ========= END OF CLASS DATA ========= -->
321<HR>
322
323
324<!-- ======= START OF BOTTOM NAVBAR ====== -->
325<A NAME="navbar_bottom"><!-- --></A>
326<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
327<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
328<TR>
329<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
330<A NAME="navbar_bottom_firstrow"><!-- --></A>
331<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
332  <TR ALIGN="center" VALIGN="top">
333  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
334  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
335  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
336  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DefaultEncoder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
337  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
338  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
339  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
340  </TR>
341</TABLE>
342</TD>
343<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
344</EM>
345</TD>
346</TR>
347
348<TR>
349<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
350&nbsp;<A HREF="../../../../org/apache/solr/highlight/BreakIteratorBoundaryScanner.html" title="class in org.apache.solr.highlight"><B>PREV CLASS</B></A>&nbsp;
351&nbsp;<A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html" title="class in org.apache.solr.highlight"><B>NEXT CLASS</B></A></FONT></TD>
352<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
353  <A HREF="../../../../index.html?org/apache/solr/highlight/DefaultEncoder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
354&nbsp;<A HREF="DefaultEncoder.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
355&nbsp;<SCRIPT type="text/javascript">
356  <!--
357  if(window==top) {
358    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
359  }
360  //-->
361</SCRIPT>
362<NOSCRIPT>
363  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
364</NOSCRIPT>
365
366
367</FONT></TD>
368</TR>
369<TR>
370<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
371  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.solr.highlight.HighlightingPluginBase">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
372<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
373DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
374</TR>
375</TABLE>
376<A NAME="skip-navbar_bottom"></A>
377<!-- ======== END OF BOTTOM NAVBAR ======= -->
378
379<HR>
380
381          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
382          <script src='../../../../prettify.js' type='text/javascript'></script>
383          <script type='text/javascript'>
384            (function(){
385              var oldonload = window.onload;
386              if (typeof oldonload != 'function') {
387                window.onload = prettyPrint;
388              } else {
389                window.onload = function() {
390                  oldonload();
391                  prettyPrint();
392                }
393              }
394            })();
395          </script>
396       
397</BODY>
398</HTML>
Note: See TracBrowser for help on using the repository browser.