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

Revision 7588, 26.3 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>
8HighlightingPluginBase (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="HighlightingPluginBase (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/HighlightingPluginBase.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/GapFragmenter.html" title="class in org.apache.solr.highlight"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/highlight/HtmlEncoder.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/HighlightingPluginBase.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="HighlightingPluginBase.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 HighlightingPluginBase</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 "><B>org.apache.solr.highlight.HighlightingPluginBase</B>
97</PRE>
98<DL>
99<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></DD>
100</DL>
101<DL>
102<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/solr/highlight/DefaultEncoder.html" title="class in org.apache.solr.highlight">DefaultEncoder</A>, <A HREF="../../../../org/apache/solr/highlight/GapFragmenter.html" title="class in org.apache.solr.highlight">GapFragmenter</A>, <A HREF="../../../../org/apache/solr/highlight/HtmlEncoder.html" title="class in org.apache.solr.highlight">HtmlEncoder</A>, <A HREF="../../../../org/apache/solr/highlight/HtmlFormatter.html" title="class in org.apache.solr.highlight">HtmlFormatter</A>, <A HREF="../../../../org/apache/solr/highlight/RegexFragmenter.html" title="class in org.apache.solr.highlight">RegexFragmenter</A>, <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/SolrBoundaryScanner.html" title="class in org.apache.solr.highlight">SolrBoundaryScanner</A>, <A HREF="../../../../org/apache/solr/highlight/SolrFragmentsBuilder.html" title="class in org.apache.solr.highlight">SolrFragmentsBuilder</A>, <A HREF="../../../../org/apache/solr/highlight/WeightedFragListBuilder.html" title="class in org.apache.solr.highlight">WeightedFragListBuilder</A></DD>
103</DL>
104<HR>
105<DL>
106<DT><PRE>public abstract class <B>HighlightingPluginBase</B><DT>extends <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><DT>implements <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></DL>
107</PRE>
108
109<P>
110<DL>
111<DT><B>Since:</B></DT>
112  <DD>solr 1.3</DD>
113</DL>
114<HR>
115
116<P>
117<!-- ======== NESTED CLASS SUMMARY ======== -->
118
119<A NAME="nested_class_summary"><!-- --></A>
120<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
121<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
122<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
123<B>Nested Class Summary</B></FONT></TH>
124</TR>
125</TABLE>
126&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
127<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
128<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
129<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>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
133</TR>
134</TABLE>
135&nbsp;
136<!-- =========== FIELD SUMMARY =========== -->
137
138<A NAME="field_summary"><!-- --></A>
139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
141<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
142<B>Field Summary</B></FONT></TH>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146<CODE>protected &nbsp;<A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A></CODE></FONT></TD>
147<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#defaults">defaults</A></B></CODE>
148
149<BR>
150&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154<CODE>protected &nbsp;long</CODE></FONT></TD>
155<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#numRequests">numRequests</A></B></CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
159</TR>
160</TABLE>
161&nbsp;
162<!-- ======== CONSTRUCTOR SUMMARY ======== -->
163
164<A NAME="constructor_summary"><!-- --></A>
165<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
166<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
167<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
168<B>Constructor Summary</B></FONT></TH>
169</TR>
170<TR BGCOLOR="white" CLASS="TableRowColor">
171<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#HighlightingPluginBase()">HighlightingPluginBase</A></B>()</CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
175</TR>
176</TABLE>
177&nbsp;
178<!-- ========== METHOD SUMMARY =========== -->
179
180<A NAME="method_summary"><!-- --></A>
181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
182<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
183<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
184<B>Method Summary</B></FONT></TH>
185</TR>
186<TR BGCOLOR="white" CLASS="TableRowColor">
187<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188<CODE>&nbsp;<A HREF="../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></FONT></TD>
189<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#getCategory()">getCategory</A></B>()</CODE>
190
191<BR>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Purpose of this Class</TD>
193</TR>
194<TR BGCOLOR="white" CLASS="TableRowColor">
195<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196<CODE>abstract &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/HighlightingPluginBase.html#getDescription()">getDescription</A></B>()</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Simple one or two line description</TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204<CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A>[]</CODE></FONT></TD>
205<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#getDocs()">getDocs</A></B>()</CODE>
206
207<BR>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Documentation URL list.</TD>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
212<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>
213<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#getName()">getName</A></B>()</CODE>
214
215<BR>
216&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Simple common usage name, e.g.</TD>
217</TR>
218<TR BGCOLOR="white" CLASS="TableRowColor">
219<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220<CODE>abstract &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>
221<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#getSource()">getSource</A></B>()</CODE>
222
223<BR>
224&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CVS Source, SVN Source, etc</TD>
225</TR>
226<TR BGCOLOR="white" CLASS="TableRowColor">
227<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228<CODE>&nbsp;<A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A></CODE></FONT></TD>
229<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#getStatistics()">getStatistics</A></B>()</CODE>
230
231<BR>
232&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Any statistics this instance would like to be publicly available via
233 the Solr Administration interface.</TD>
234</TR>
235<TR BGCOLOR="white" CLASS="TableRowColor">
236<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
237<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>
238<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#getVersion()">getVersion</A></B>()</CODE>
239
240<BR>
241&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Simple common usage version, e.g.</TD>
242</TR>
243<TR BGCOLOR="white" CLASS="TableRowColor">
244<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
245<CODE>&nbsp;void</CODE></FONT></TD>
246<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.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>
247
248<BR>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
250</TR>
251</TABLE>
252&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
253<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
254<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
255<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>
256</TR>
257<TR BGCOLOR="white" CLASS="TableRowColor">
258<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>
259</TR>
260</TABLE>
261&nbsp;
262<P>
263
264<!-- ============ FIELD DETAIL =========== -->
265
266<A NAME="field_detail"><!-- --></A>
267<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
268<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
269<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
270<B>Field Detail</B></FONT></TH>
271</TR>
272</TABLE>
273
274<A NAME="numRequests"><!-- --></A><H3>
275numRequests</H3>
276<PRE>
277protected long <B>numRequests</B></PRE>
278<DL>
279<DL>
280</DL>
281</DL>
282<HR>
283
284<A NAME="defaults"><!-- --></A><H3>
285defaults</H3>
286<PRE>
287protected <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A> <B>defaults</B></PRE>
288<DL>
289<DL>
290</DL>
291</DL>
292
293<!-- ========= CONSTRUCTOR DETAIL ======== -->
294
295<A NAME="constructor_detail"><!-- --></A>
296<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
297<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
298<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
299<B>Constructor Detail</B></FONT></TH>
300</TR>
301</TABLE>
302
303<A NAME="HighlightingPluginBase()"><!-- --></A><H3>
304HighlightingPluginBase</H3>
305<PRE>
306public <B>HighlightingPluginBase</B>()</PRE>
307<DL>
308</DL>
309
310<!-- ============ METHOD DETAIL ========== -->
311
312<A NAME="method_detail"><!-- --></A>
313<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
314<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
315<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
316<B>Method Detail</B></FONT></TH>
317</TR>
318</TABLE>
319
320<A NAME="init(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
321init</H3>
322<PRE>
323public void <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>
324<DL>
325<DD><DL>
326</DL>
327</DD>
328<DD><DL>
329</DL>
330</DD>
331</DL>
332<HR>
333
334<A NAME="getName()"><!-- --></A><H3>
335getName</H3>
336<PRE>
337public <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>getName</B>()</PRE>
338<DL>
339<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getName()">SolrInfoMBean</A></CODE></B></DD>
340<DD>Simple common usage name, e.g. BasicQueryHandler,
341 or fully qualified clas name.
342<P>
343<DD><DL>
344<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getName()">getName</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE></DL>
345</DD>
346<DD><DL>
347</DL>
348</DD>
349</DL>
350<HR>
351
352<A NAME="getDescription()"><!-- --></A><H3>
353getDescription</H3>
354<PRE>
355public abstract <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>
356<DL>
357<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">SolrInfoMBean</A></CODE></B></DD>
358<DD>Simple one or two line description
359<P>
360<DD><DL>
361<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></DL>
362</DD>
363<DD><DL>
364</DL>
365</DD>
366</DL>
367<HR>
368
369<A NAME="getSource()"><!-- --></A><H3>
370getSource</H3>
371<PRE>
372public abstract <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>
373<DL>
374<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">SolrInfoMBean</A></CODE></B></DD>
375<DD>CVS Source, SVN Source, etc
376<P>
377<DD><DL>
378<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></DL>
379</DD>
380<DD><DL>
381</DL>
382</DD>
383</DL>
384<HR>
385
386<A NAME="getVersion()"><!-- --></A><H3>
387getVersion</H3>
388<PRE>
389public <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>getVersion</B>()</PRE>
390<DL>
391<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getVersion()">SolrInfoMBean</A></CODE></B></DD>
392<DD>Simple common usage version, e.g. 2.0
393<P>
394<DD><DL>
395<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getVersion()">getVersion</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE></DL>
396</DD>
397<DD><DL>
398</DL>
399</DD>
400</DL>
401<HR>
402
403<A NAME="getCategory()"><!-- --></A><H3>
404getCategory</H3>
405<PRE>
406public <A HREF="../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A> <B>getCategory</B>()</PRE>
407<DL>
408<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getCategory()">SolrInfoMBean</A></CODE></B></DD>
409<DD>Purpose of this Class
410<P>
411<DD><DL>
412<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getCategory()">getCategory</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE></DL>
413</DD>
414<DD><DL>
415</DL>
416</DD>
417</DL>
418<HR>
419
420<A NAME="getDocs()"><!-- --></A><H3>
421getDocs</H3>
422<PRE>
423public <A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A>[] <B>getDocs</B>()</PRE>
424<DL>
425<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDocs()">SolrInfoMBean</A></CODE></B></DD>
426<DD>Documentation URL list.
427
428 <p>
429 Suggested documentation URLs: Homepage for sponsoring project,
430 FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...
431 </p>
432<P>
433<DD><DL>
434<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDocs()">getDocs</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE></DL>
435</DD>
436<DD><DL>
437</DL>
438</DD>
439</DL>
440<HR>
441
442<A NAME="getStatistics()"><!-- --></A><H3>
443getStatistics</H3>
444<PRE>
445public <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A> <B>getStatistics</B>()</PRE>
446<DL>
447<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getStatistics()">SolrInfoMBean</A></CODE></B></DD>
448<DD>Any statistics this instance would like to be publicly available via
449 the Solr Administration interface.
450
451 <p>
452 Any Object type may be stored in the list, but only the
453 <code>toString()</code> representation will be used.
454 </p>
455<P>
456<DD><DL>
457<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getStatistics()">getStatistics</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html" title="interface in org.apache.solr.core">SolrInfoMBean</A></CODE></DL>
458</DD>
459<DD><DL>
460</DL>
461</DD>
462</DL>
463<!-- ========= END OF CLASS DATA ========= -->
464<HR>
465
466
467<!-- ======= START OF BOTTOM NAVBAR ====== -->
468<A NAME="navbar_bottom"><!-- --></A>
469<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
470<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
471<TR>
472<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
473<A NAME="navbar_bottom_firstrow"><!-- --></A>
474<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
475  <TR ALIGN="center" VALIGN="top">
476  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
477  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
478  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
479  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/HighlightingPluginBase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
480  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
481  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
482  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
483  </TR>
484</TABLE>
485</TD>
486<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
487</EM>
488</TD>
489</TR>
490
491<TR>
492<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
493&nbsp;<A HREF="../../../../org/apache/solr/highlight/GapFragmenter.html" title="class in org.apache.solr.highlight"><B>PREV CLASS</B></A>&nbsp;
494&nbsp;<A HREF="../../../../org/apache/solr/highlight/HtmlEncoder.html" title="class in org.apache.solr.highlight"><B>NEXT CLASS</B></A></FONT></TD>
495<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
496  <A HREF="../../../../index.html?org/apache/solr/highlight/HighlightingPluginBase.html" target="_top"><B>FRAMES</B></A>  &nbsp;
497&nbsp;<A HREF="HighlightingPluginBase.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
498&nbsp;<SCRIPT type="text/javascript">
499  <!--
500  if(window==top) {
501    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
502  }
503  //-->
504</SCRIPT>
505<NOSCRIPT>
506  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
507</NOSCRIPT>
508
509
510</FONT></TD>
511</TR>
512<TR>
513<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
514  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>
515<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
516DETAIL:&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>
517</TR>
518</TABLE>
519<A NAME="skip-navbar_bottom"></A>
520<!-- ======== END OF BOTTOM NAVBAR ======= -->
521
522<HR>
523
524          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
525          <script src='../../../../prettify.js' type='text/javascript'></script>
526          <script type='text/javascript'>
527            (function(){
528              var oldonload = window.onload;
529              if (typeof oldonload != 'function') {
530                window.onload = prettyPrint;
531              } else {
532                window.onload = function() {
533                  oldonload();
534                  prettyPrint();
535                }
536              }
537            })();
538          </script>
539       
540</BODY>
541</HTML>
Note: See TracBrowser for help on using the repository browser.