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

Revision 7588, 27.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>
8RegexFragmenter (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="RegexFragmenter (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/RegexFragmenter.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/HtmlFormatter.html" title="class in org.apache.solr.highlight"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/solr/highlight/ScoreOrderFragmentsBuilder.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/RegexFragmenter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="RegexFragmenter.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 RegexFragmenter</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.RegexFragmenter</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/SolrFragmenter.html" title="interface in org.apache.solr.highlight">SolrFragmenter</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>RegexFragmenter</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/SolrFragmenter.html" title="interface in org.apache.solr.highlight">SolrFragmenter</A></DL>
105</PRE>
106
107<P>
108<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> that tries to produce snippets that "look" like a regular
109 expression.
110
111 <code>solrconfig.xml</code> parameters:
112 <ul>
113 <li><code>hl.regex.pattern</code>: regular expression corresponding to "nice" fragments.</li>
114 <li><code>hl.regex.slop</code>: how far the fragmenter can stray from the ideal fragment size.
115       A slop of 0.2 means that the fragmenter can go over or under by 20%.</li>
116 <li><code>hl.regex.maxAnalyzedChars</code>: how many characters to apply the
117       regular expression to (independent from the global highlighter setting).</li>
118 </ul>
119
120 NOTE: the default for <code>maxAnalyzedChars</code> is much lower for this
121 fragmenter.  After this limit is exhausted, fragments are produced in the
122 same way as <code>GapFragmenter</code>
123<P>
124
125<P>
126<HR>
127
128<P>
129<!-- ======== NESTED CLASS SUMMARY ======== -->
130
131<A NAME="nested_class_summary"><!-- --></A>
132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
133<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
134<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
135<B>Nested Class Summary</B></FONT></TH>
136</TR>
137</TABLE>
138&nbsp;<A NAME="nested_classes_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
141<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>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD><CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.Category.html" title="enum in org.apache.solr.core">SolrInfoMBean.Category</A></CODE></TD>
145</TR>
146</TABLE>
147&nbsp;
148<!-- =========== FIELD SUMMARY =========== -->
149
150<A NAME="field_summary"><!-- --></A>
151<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
152<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
153<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
154<B>Field Summary</B></FONT></TH>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158<CODE>protected &nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</A></CODE></FONT></TD>
159<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/RegexFragmenter.html#defaultPattern">defaultPattern</A></B></CODE>
160
161<BR>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166<CODE>protected &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>
167<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/RegexFragmenter.html#defaultPatternRaw">defaultPatternRaw</A></B></CODE>
168
169<BR>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
171</TR>
172</TABLE>
173&nbsp;<A NAME="fields_inherited_from_class_org.apache.solr.highlight.HighlightingPluginBase"><!-- --></A>
174<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
175<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
176<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>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<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>
180</TR>
181</TABLE>
182&nbsp;
183<!-- ======== CONSTRUCTOR SUMMARY ======== -->
184
185<A NAME="constructor_summary"><!-- --></A>
186<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
187<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
188<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
189<B>Constructor Summary</B></FONT></TH>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/RegexFragmenter.html#RegexFragmenter()">RegexFragmenter</A></B>()</CODE>
193
194<BR>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
196</TR>
197</TABLE>
198&nbsp;
199<!-- ========== METHOD SUMMARY =========== -->
200
201<A NAME="method_summary"><!-- --></A>
202<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
203<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
204<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
205<B>Method Summary</B></FONT></TH>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209<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>
210<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/RegexFragmenter.html#getDescription()">getDescription</A></B>()</CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Simple one or two line description</TD>
214</TR>
215<TR BGCOLOR="white" CLASS="TableRowColor">
216<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217<CODE>&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>
218<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/RegexFragmenter.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,
219              <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</CODE>
220
221<BR>
222&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>
223</TR>
224<TR BGCOLOR="white" CLASS="TableRowColor">
225<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
226<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>
227<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/RegexFragmenter.html#getSource()">getSource</A></B>()</CODE>
228
229<BR>
230&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CVS Source, SVN Source, etc</TD>
231</TR>
232<TR BGCOLOR="white" CLASS="TableRowColor">
233<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
234<CODE>&nbsp;void</CODE></FONT></TD>
235<TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/RegexFragmenter.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>
236
237<BR>
238&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>init</code> will be called just once, immediately after creation.</TD>
239</TR>
240</TABLE>
241&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.highlight.HighlightingPluginBase"><!-- --></A>
242<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
243<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
244<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>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<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></CODE></TD>
248</TR>
249</TABLE>
250&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
251<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
252<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
253<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>
254</TR>
255<TR BGCOLOR="white" CLASS="TableRowColor">
256<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>
257</TR>
258</TABLE>
259&nbsp;<A NAME="methods_inherited_from_class_org.apache.solr.core.SolrInfoMBean"><!-- --></A>
260<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
261<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
262<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>
263</TR>
264<TR BGCOLOR="white" CLASS="TableRowColor">
265<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>
266</TR>
267</TABLE>
268&nbsp;
269<P>
270
271<!-- ============ FIELD DETAIL =========== -->
272
273<A NAME="field_detail"><!-- --></A>
274<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
275<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
276<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
277<B>Field Detail</B></FONT></TH>
278</TR>
279</TABLE>
280
281<A NAME="defaultPatternRaw"><!-- --></A><H3>
282defaultPatternRaw</H3>
283<PRE>
284protected <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>defaultPatternRaw</B></PRE>
285<DL>
286<DL>
287</DL>
288</DL>
289<HR>
290
291<A NAME="defaultPattern"><!-- --></A><H3>
292defaultPattern</H3>
293<PRE>
294protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</A> <B>defaultPattern</B></PRE>
295<DL>
296<DL>
297</DL>
298</DL>
299
300<!-- ========= CONSTRUCTOR DETAIL ======== -->
301
302<A NAME="constructor_detail"><!-- --></A>
303<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
304<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
305<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
306<B>Constructor Detail</B></FONT></TH>
307</TR>
308</TABLE>
309
310<A NAME="RegexFragmenter()"><!-- --></A><H3>
311RegexFragmenter</H3>
312<PRE>
313public <B>RegexFragmenter</B>()</PRE>
314<DL>
315</DL>
316
317<!-- ============ METHOD DETAIL ========== -->
318
319<A NAME="method_detail"><!-- --></A>
320<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
321<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
322<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
323<B>Method Detail</B></FONT></TH>
324</TR>
325</TABLE>
326
327<A NAME="init(org.apache.solr.common.util.NamedList)"><!-- --></A><H3>
328init</H3>
329<PRE>
330public 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>
331<DL>
332<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/highlight/SolrFragmenter.html#init(org.apache.solr.common.util.NamedList)">SolrFragmenter</A></CODE></B></DD>
333<DD><code>init</code> will be called just once, immediately after creation.
334 <p>The args are user-level initialization parameters that
335 may be specified when declaring a request handler in
336 solrconfig.xml
337<P>
338<DD><DL>
339<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/highlight/SolrFragmenter.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/highlight/SolrFragmenter.html" title="interface in org.apache.solr.highlight">SolrFragmenter</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/util/plugin/NamedListInitializedPlugin.html" title="interface in org.apache.solr.util.plugin">NamedListInitializedPlugin</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html#init(org.apache.solr.common.util.NamedList)">init</A></CODE> in class <CODE><A HREF="../../../../org/apache/solr/highlight/HighlightingPluginBase.html" title="class in org.apache.solr.highlight">HighlightingPluginBase</A></CODE></DL>
340</DD>
341<DD><DL>
342</DL>
343</DD>
344</DL>
345<HR>
346
347<A NAME="getFragmenter(java.lang.String, org.apache.solr.common.params.SolrParams)"><!-- --></A><H3>
348getFragmenter</H3>
349<PRE>
350public <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,
351                                <A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A>&nbsp;params)</PRE>
352<DL>
353<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/highlight/SolrFragmenter.html#getFragmenter(java.lang.String, org.apache.solr.common.params.SolrParams)">SolrFragmenter</A></CODE></B></DD>
354<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.
355<P>
356<DD><DL>
357<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/solr/highlight/SolrFragmenter.html#getFragmenter(java.lang.String, org.apache.solr.common.params.SolrParams)">getFragmenter</A></CODE> in interface <CODE><A HREF="../../../../org/apache/solr/highlight/SolrFragmenter.html" title="interface in org.apache.solr.highlight">SolrFragmenter</A></CODE></DL>
358</DD>
359<DD><DL>
360<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - The name of the field<DD><CODE>params</CODE> - The params controlling Highlighting
361<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>
362</DD>
363</DL>
364<HR>
365
366<A NAME="getDescription()"><!-- --></A><H3>
367getDescription</H3>
368<PRE>
369public <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>
370<DL>
371<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getDescription()">SolrInfoMBean</A></CODE></B></DD>
372<DD>Simple one or two line description
373<P>
374<DD><DL>
375<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>
376</DD>
377<DD><DL>
378</DL>
379</DD>
380</DL>
381<HR>
382
383<A NAME="getSource()"><!-- --></A><H3>
384getSource</H3>
385<PRE>
386public <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>
387<DL>
388<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/solr/core/SolrInfoMBean.html#getSource()">SolrInfoMBean</A></CODE></B></DD>
389<DD>CVS Source, SVN Source, etc
390<P>
391<DD><DL>
392<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>
393</DD>
394<DD><DL>
395</DL>
396</DD>
397</DL>
398<!-- ========= END OF CLASS DATA ========= -->
399<HR>
400
401
402<!-- ======= START OF BOTTOM NAVBAR ====== -->
403<A NAME="navbar_bottom"><!-- --></A>
404<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
405<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
406<TR>
407<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
408<A NAME="navbar_bottom_firstrow"><!-- --></A>
409<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
410  <TR ALIGN="center" VALIGN="top">
411  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
412  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
413  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
414  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/RegexFragmenter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
415  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
416  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
417  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
418  </TR>
419</TABLE>
420</TD>
421<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
422</EM>
423</TD>
424</TR>
425
426<TR>
427<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
428&nbsp;<A HREF="../../../../org/apache/solr/highlight/HtmlFormatter.html" title="class in org.apache.solr.highlight"><B>PREV CLASS</B></A>&nbsp;
429&nbsp;<A HREF="../../../../org/apache/solr/highlight/ScoreOrderFragmentsBuilder.html" title="class in org.apache.solr.highlight"><B>NEXT CLASS</B></A></FONT></TD>
430<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
431  <A HREF="../../../../index.html?org/apache/solr/highlight/RegexFragmenter.html" target="_top"><B>FRAMES</B></A>  &nbsp;
432&nbsp;<A HREF="RegexFragmenter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
433&nbsp;<SCRIPT type="text/javascript">
434  <!--
435  if(window==top) {
436    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
437  }
438  //-->
439</SCRIPT>
440<NOSCRIPT>
441  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
442</NOSCRIPT>
443
444
445</FONT></TD>
446</TR>
447<TR>
448<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
449  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>
450<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
451DETAIL:&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>
452</TR>
453</TABLE>
454<A NAME="skip-navbar_bottom"></A>
455<!-- ======== END OF BOTTOM NAVBAR ======= -->
456
457<HR>
458
459          <address>Copyright &copy; 2000-2012 Apache Software Foundation.  All Rights Reserved.</address>
460          <script src='../../../../prettify.js' type='text/javascript'></script>
461          <script type='text/javascript'>
462            (function(){
463              var oldonload = window.onload;
464              if (typeof oldonload != 'function') {
465                window.onload = prettyPrint;
466              } else {
467                window.onload = function() {
468                  oldonload();
469                  prettyPrint();
470                }
471              }
472            })();
473          </script>
474       
475</BODY>
476</HTML>
Note: See TracBrowser for help on using the repository browser.