[7588] | 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> |
---|
| 8 | SolrHighlighter (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"> |
---|
| 16 | function windowTitle() |
---|
| 17 | { |
---|
| 18 | if (location.href.indexOf('is-external=true') == -1) { |
---|
| 19 | parent.document.title="SolrHighlighter (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> </TD> |
---|
| 42 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 43 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 44 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SolrHighlighter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
| 45 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 46 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 47 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 | <A HREF="../../../../org/apache/solr/highlight/SolrFragmentsBuilder.html" title="class in org.apache.solr.highlight"><B>PREV CLASS</B></A> |
---|
| 59 | <A HREF="../../../../org/apache/solr/highlight/WeightedFragListBuilder.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/SolrHighlighter.html" target="_top"><B>FRAMES</B></A> |
---|
| 62 | <A HREF="SolrHighlighter.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 63 | <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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 81 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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"> |
---|
| 91 | org.apache.solr.highlight</FONT> |
---|
| 92 | <BR> |
---|
| 93 | Class SolrHighlighter</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.SolrHighlighter</B> |
---|
| 97 | </PRE> |
---|
| 98 | <DL> |
---|
| 99 | <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/solr/highlight/DefaultSolrHighlighter.html" title="class in org.apache.solr.highlight">DefaultSolrHighlighter</A></DD> |
---|
| 100 | </DL> |
---|
| 101 | <HR> |
---|
| 102 | <DL> |
---|
| 103 | <DT><PRE>public abstract class <B>SolrHighlighter</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></DL> |
---|
| 104 | </PRE> |
---|
| 105 | |
---|
| 106 | <P> |
---|
| 107 | <HR> |
---|
| 108 | |
---|
| 109 | <P> |
---|
| 110 | <!-- =========== FIELD SUMMARY =========== --> |
---|
| 111 | |
---|
| 112 | <A NAME="field_summary"><!-- --></A> |
---|
| 113 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 114 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 115 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 116 | <B>Field Summary</B></FONT></TH> |
---|
| 117 | </TR> |
---|
| 118 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 119 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 120 | <CODE>protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<A HREF="../../../../org/apache/solr/highlight/SolrBoundaryScanner.html" title="class in org.apache.solr.highlight">SolrBoundaryScanner</A>></CODE></FONT></TD> |
---|
| 121 | <TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#boundaryScanners">boundaryScanners</A></B></CODE> |
---|
| 122 | |
---|
| 123 | <BR> |
---|
| 124 | </TD> |
---|
| 125 | </TR> |
---|
| 126 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 127 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 128 | <CODE>protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<A HREF="../../../../org/apache/solr/highlight/SolrEncoder.html" title="interface in org.apache.solr.highlight">SolrEncoder</A>></CODE></FONT></TD> |
---|
| 129 | <TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#encoders">encoders</A></B></CODE> |
---|
| 130 | |
---|
| 131 | <BR> |
---|
| 132 | </TD> |
---|
| 133 | </TR> |
---|
| 134 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 135 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 136 | <CODE>protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<A HREF="../../../../org/apache/solr/highlight/SolrFormatter.html" title="interface in org.apache.solr.highlight">SolrFormatter</A>></CODE></FONT></TD> |
---|
| 137 | <TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#formatters">formatters</A></B></CODE> |
---|
| 138 | |
---|
| 139 | <BR> |
---|
| 140 | </TD> |
---|
| 141 | </TR> |
---|
| 142 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 143 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 144 | <CODE>protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<A HREF="../../../../org/apache/solr/highlight/SolrFragListBuilder.html" title="interface in org.apache.solr.highlight">SolrFragListBuilder</A>></CODE></FONT></TD> |
---|
| 145 | <TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#fragListBuilders">fragListBuilders</A></B></CODE> |
---|
| 146 | |
---|
| 147 | <BR> |
---|
| 148 | </TD> |
---|
| 149 | </TR> |
---|
| 150 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 151 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 152 | <CODE>protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<A HREF="../../../../org/apache/solr/highlight/SolrFragmenter.html" title="interface in org.apache.solr.highlight">SolrFragmenter</A>></CODE></FONT></TD> |
---|
| 153 | <TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#fragmenters">fragmenters</A></B></CODE> |
---|
| 154 | |
---|
| 155 | <BR> |
---|
| 156 | </TD> |
---|
| 157 | </TR> |
---|
| 158 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 159 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 160 | <CODE>protected <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<A HREF="../../../../org/apache/solr/highlight/SolrFragmentsBuilder.html" title="class in org.apache.solr.highlight">SolrFragmentsBuilder</A>></CODE></FONT></TD> |
---|
| 161 | <TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#fragmentsBuilders">fragmentsBuilders</A></B></CODE> |
---|
| 162 | |
---|
| 163 | <BR> |
---|
| 164 | </TD> |
---|
| 165 | </TR> |
---|
| 166 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 167 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 168 | <CODE>static org.slf4j.Logger</CODE></FONT></TD> |
---|
| 169 | <TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#log">log</A></B></CODE> |
---|
| 170 | |
---|
| 171 | <BR> |
---|
| 172 | </TD> |
---|
| 173 | </TR> |
---|
| 174 | </TABLE> |
---|
| 175 | |
---|
| 176 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
| 177 | |
---|
| 178 | <A NAME="constructor_summary"><!-- --></A> |
---|
| 179 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 180 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 181 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 182 | <B>Constructor Summary</B></FONT></TH> |
---|
| 183 | </TR> |
---|
| 184 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 185 | <TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#SolrHighlighter()">SolrHighlighter</A></B>()</CODE> |
---|
| 186 | |
---|
| 187 | <BR> |
---|
| 188 | </TD> |
---|
| 189 | </TR> |
---|
| 190 | </TABLE> |
---|
| 191 | |
---|
| 192 | <!-- ========== METHOD SUMMARY =========== --> |
---|
| 193 | |
---|
| 194 | <A NAME="method_summary"><!-- --></A> |
---|
| 195 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 196 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 197 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 198 | <B>Method Summary</B></FONT></TH> |
---|
| 199 | </TR> |
---|
| 200 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 201 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 202 | <CODE>abstract <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A><<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>></CODE></FONT></TD> |
---|
| 203 | <TD><CODE><B><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></B>(<A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A> docs, |
---|
| 204 | <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> query, |
---|
| 205 | <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A> req, |
---|
| 206 | <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>[] defaultFields)</CODE> |
---|
| 207 | |
---|
| 208 | <BR> |
---|
| 209 | Generates a list of Highlighted query fragments for each item in a list |
---|
| 210 | of documents, or returns null if highlighting is disabled.</TD> |
---|
| 211 | </TR> |
---|
| 212 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 213 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 214 | <CODE>protected boolean</CODE></FONT></TD> |
---|
| 215 | <TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#emptyArray(java.lang.String[])">emptyArray</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>[] arr)</CODE> |
---|
| 216 | |
---|
| 217 | <BR> |
---|
| 218 | </TD> |
---|
| 219 | </TR> |
---|
| 220 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 221 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 222 | <CODE> <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> |
---|
| 223 | <TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#getHighlightFields(org.apache.lucene.search.Query, org.apache.solr.request.SolrQueryRequest, java.lang.String[])">getHighlightFields</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> query, |
---|
| 224 | <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A> request, |
---|
| 225 | <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>[] defaultFields)</CODE> |
---|
| 226 | |
---|
| 227 | <BR> |
---|
| 228 | Return a String array of the fields to be highlighted.</TD> |
---|
| 229 | </TR> |
---|
| 230 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 231 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 232 | <CODE>abstract void</CODE></FONT></TD> |
---|
| 233 | <TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.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> config)</CODE> |
---|
| 234 | |
---|
| 235 | <BR> |
---|
| 236 | <B>Deprecated.</B> </TD> |
---|
| 237 | </TR> |
---|
| 238 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 239 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 240 | <CODE> boolean</CODE></FONT></TD> |
---|
| 241 | <TD><CODE><B><A HREF="../../../../org/apache/solr/highlight/SolrHighlighter.html#isHighlightingEnabled(org.apache.solr.common.params.SolrParams)">isHighlightingEnabled</A></B>(<A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A> params)</CODE> |
---|
| 242 | |
---|
| 243 | <BR> |
---|
| 244 | Check whether Highlighting is enabled for this request.</TD> |
---|
| 245 | </TR> |
---|
| 246 | </TABLE> |
---|
| 247 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
| 248 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 249 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
| 250 | <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> |
---|
| 251 | </TR> |
---|
| 252 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 253 | <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> |
---|
| 254 | </TR> |
---|
| 255 | </TABLE> |
---|
| 256 | |
---|
| 257 | <P> |
---|
| 258 | |
---|
| 259 | <!-- ============ FIELD DETAIL =========== --> |
---|
| 260 | |
---|
| 261 | <A NAME="field_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>Field Detail</B></FONT></TH> |
---|
| 266 | </TR> |
---|
| 267 | </TABLE> |
---|
| 268 | |
---|
| 269 | <A NAME="log"><!-- --></A><H3> |
---|
| 270 | log</H3> |
---|
| 271 | <PRE> |
---|
| 272 | public static org.slf4j.Logger <B>log</B></PRE> |
---|
| 273 | <DL> |
---|
| 274 | <DL> |
---|
| 275 | </DL> |
---|
| 276 | </DL> |
---|
| 277 | <HR> |
---|
| 278 | |
---|
| 279 | <A NAME="formatters"><!-- --></A><H3> |
---|
| 280 | formatters</H3> |
---|
| 281 | <PRE> |
---|
| 282 | protected final <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<A HREF="../../../../org/apache/solr/highlight/SolrFormatter.html" title="interface in org.apache.solr.highlight">SolrFormatter</A>> <B>formatters</B></PRE> |
---|
| 283 | <DL> |
---|
| 284 | <DL> |
---|
| 285 | </DL> |
---|
| 286 | </DL> |
---|
| 287 | <HR> |
---|
| 288 | |
---|
| 289 | <A NAME="encoders"><!-- --></A><H3> |
---|
| 290 | encoders</H3> |
---|
| 291 | <PRE> |
---|
| 292 | protected final <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<A HREF="../../../../org/apache/solr/highlight/SolrEncoder.html" title="interface in org.apache.solr.highlight">SolrEncoder</A>> <B>encoders</B></PRE> |
---|
| 293 | <DL> |
---|
| 294 | <DL> |
---|
| 295 | </DL> |
---|
| 296 | </DL> |
---|
| 297 | <HR> |
---|
| 298 | |
---|
| 299 | <A NAME="fragmenters"><!-- --></A><H3> |
---|
| 300 | fragmenters</H3> |
---|
| 301 | <PRE> |
---|
| 302 | protected final <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<A HREF="../../../../org/apache/solr/highlight/SolrFragmenter.html" title="interface in org.apache.solr.highlight">SolrFragmenter</A>> <B>fragmenters</B></PRE> |
---|
| 303 | <DL> |
---|
| 304 | <DL> |
---|
| 305 | </DL> |
---|
| 306 | </DL> |
---|
| 307 | <HR> |
---|
| 308 | |
---|
| 309 | <A NAME="fragListBuilders"><!-- --></A><H3> |
---|
| 310 | fragListBuilders</H3> |
---|
| 311 | <PRE> |
---|
| 312 | protected final <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<A HREF="../../../../org/apache/solr/highlight/SolrFragListBuilder.html" title="interface in org.apache.solr.highlight">SolrFragListBuilder</A>> <B>fragListBuilders</B></PRE> |
---|
| 313 | <DL> |
---|
| 314 | <DL> |
---|
| 315 | </DL> |
---|
| 316 | </DL> |
---|
| 317 | <HR> |
---|
| 318 | |
---|
| 319 | <A NAME="fragmentsBuilders"><!-- --></A><H3> |
---|
| 320 | fragmentsBuilders</H3> |
---|
| 321 | <PRE> |
---|
| 322 | protected final <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<A HREF="../../../../org/apache/solr/highlight/SolrFragmentsBuilder.html" title="class in org.apache.solr.highlight">SolrFragmentsBuilder</A>> <B>fragmentsBuilders</B></PRE> |
---|
| 323 | <DL> |
---|
| 324 | <DL> |
---|
| 325 | </DL> |
---|
| 326 | </DL> |
---|
| 327 | <HR> |
---|
| 328 | |
---|
| 329 | <A NAME="boundaryScanners"><!-- --></A><H3> |
---|
| 330 | boundaryScanners</H3> |
---|
| 331 | <PRE> |
---|
| 332 | protected final <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<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>,<A HREF="../../../../org/apache/solr/highlight/SolrBoundaryScanner.html" title="class in org.apache.solr.highlight">SolrBoundaryScanner</A>> <B>boundaryScanners</B></PRE> |
---|
| 333 | <DL> |
---|
| 334 | <DL> |
---|
| 335 | </DL> |
---|
| 336 | </DL> |
---|
| 337 | |
---|
| 338 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
| 339 | |
---|
| 340 | <A NAME="constructor_detail"><!-- --></A> |
---|
| 341 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 342 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 343 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 344 | <B>Constructor Detail</B></FONT></TH> |
---|
| 345 | </TR> |
---|
| 346 | </TABLE> |
---|
| 347 | |
---|
| 348 | <A NAME="SolrHighlighter()"><!-- --></A><H3> |
---|
| 349 | SolrHighlighter</H3> |
---|
| 350 | <PRE> |
---|
| 351 | public <B>SolrHighlighter</B>()</PRE> |
---|
| 352 | <DL> |
---|
| 353 | </DL> |
---|
| 354 | |
---|
| 355 | <!-- ============ METHOD DETAIL ========== --> |
---|
| 356 | |
---|
| 357 | <A NAME="method_detail"><!-- --></A> |
---|
| 358 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 359 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 360 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 361 | <B>Method Detail</B></FONT></TH> |
---|
| 362 | </TR> |
---|
| 363 | </TABLE> |
---|
| 364 | |
---|
| 365 | <A NAME="initalize(org.apache.solr.core.SolrConfig)"><!-- --></A><H3> |
---|
| 366 | initalize</H3> |
---|
| 367 | <PRE> |
---|
| 368 | <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> |
---|
| 369 | </FONT>public abstract void <B>initalize</B>(<A HREF="../../../../org/apache/solr/core/SolrConfig.html" title="class in org.apache.solr.core">SolrConfig</A> config)</PRE> |
---|
| 370 | <DL> |
---|
| 371 | <DD><B>Deprecated.</B> |
---|
| 372 | <P> |
---|
| 373 | <DD><DL> |
---|
| 374 | </DL> |
---|
| 375 | </DD> |
---|
| 376 | </DL> |
---|
| 377 | <HR> |
---|
| 378 | |
---|
| 379 | <A NAME="isHighlightingEnabled(org.apache.solr.common.params.SolrParams)"><!-- --></A><H3> |
---|
| 380 | isHighlightingEnabled</H3> |
---|
| 381 | <PRE> |
---|
| 382 | public boolean <B>isHighlightingEnabled</B>(<A HREF="../../../../org/apache/solr/common/params/SolrParams.html" title="class in org.apache.solr.common.params">SolrParams</A> params)</PRE> |
---|
| 383 | <DL> |
---|
| 384 | <DD>Check whether Highlighting is enabled for this request. |
---|
| 385 | <P> |
---|
| 386 | <DD><DL> |
---|
| 387 | <DT><B>Parameters:</B><DD><CODE>params</CODE> - The params controlling Highlighting |
---|
| 388 | <DT><B>Returns:</B><DD><code>true</code> if highlighting enabled, <code>false</code> if not.</DL> |
---|
| 389 | </DD> |
---|
| 390 | </DL> |
---|
| 391 | <HR> |
---|
| 392 | |
---|
| 393 | <A NAME="getHighlightFields(org.apache.lucene.search.Query, org.apache.solr.request.SolrQueryRequest, java.lang.String[])"><!-- --></A><H3> |
---|
| 394 | getHighlightFields</H3> |
---|
| 395 | <PRE> |
---|
| 396 | public <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>getHighlightFields</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> query, |
---|
| 397 | <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A> request, |
---|
| 398 | <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>[] defaultFields)</PRE> |
---|
| 399 | <DL> |
---|
| 400 | <DD>Return a String array of the fields to be highlighted. |
---|
| 401 | Falls back to the programatic defaults, or the default search field if the list of fields |
---|
| 402 | is not specified in either the handler configuration or the request. |
---|
| 403 | <P> |
---|
| 404 | <DD><DL> |
---|
| 405 | <DT><B>Parameters:</B><DD><CODE>query</CODE> - The current Query<DD><CODE>request</CODE> - The current SolrQueryRequest<DD><CODE>defaultFields</CODE> - Programmatic default highlight fields, used if nothing is specified in the handler config or the request.</DL> |
---|
| 406 | </DD> |
---|
| 407 | </DL> |
---|
| 408 | <HR> |
---|
| 409 | |
---|
| 410 | <A NAME="emptyArray(java.lang.String[])"><!-- --></A><H3> |
---|
| 411 | emptyArray</H3> |
---|
| 412 | <PRE> |
---|
| 413 | protected boolean <B>emptyArray</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>[] arr)</PRE> |
---|
| 414 | <DL> |
---|
| 415 | <DD><DL> |
---|
| 416 | </DL> |
---|
| 417 | </DD> |
---|
| 418 | </DL> |
---|
| 419 | <HR> |
---|
| 420 | |
---|
| 421 | <A NAME="doHighlighting(org.apache.solr.search.DocList, org.apache.lucene.search.Query, org.apache.solr.request.SolrQueryRequest, java.lang.String[])"><!-- --></A><H3> |
---|
| 422 | doHighlighting</H3> |
---|
| 423 | <PRE> |
---|
| 424 | public abstract <A HREF="../../../../org/apache/solr/common/util/NamedList.html" title="class in org.apache.solr.common.util">NamedList</A><<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>doHighlighting</B>(<A HREF="../../../../org/apache/solr/search/DocList.html" title="interface in org.apache.solr.search">DocList</A> docs, |
---|
| 425 | <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> query, |
---|
| 426 | <A HREF="../../../../org/apache/solr/request/SolrQueryRequest.html" title="interface in org.apache.solr.request">SolrQueryRequest</A> req, |
---|
| 427 | <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>[] defaultFields) |
---|
| 428 | 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> |
---|
| 429 | <DL> |
---|
| 430 | <DD>Generates a list of Highlighted query fragments for each item in a list |
---|
| 431 | of documents, or returns null if highlighting is disabled. |
---|
| 432 | <P> |
---|
| 433 | <DD><DL> |
---|
| 434 | <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 |
---|
| 435 | <DT><B>Returns:</B><DD>NamedList containing a NamedList for each document, which in |
---|
| 436 | turns contains sets (field, summary) pairs. |
---|
| 437 | <DT><B>Throws:</B> |
---|
| 438 | <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> |
---|
| 439 | </DD> |
---|
| 440 | </DL> |
---|
| 441 | <!-- ========= END OF CLASS DATA ========= --> |
---|
| 442 | <HR> |
---|
| 443 | |
---|
| 444 | |
---|
| 445 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
| 446 | <A NAME="navbar_bottom"><!-- --></A> |
---|
| 447 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
| 448 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
| 449 | <TR> |
---|
| 450 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
| 451 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
| 452 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
| 453 | <TR ALIGN="center" VALIGN="top"> |
---|
| 454 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
| 455 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 456 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 457 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SolrHighlighter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
| 458 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 459 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 460 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
| 461 | </TR> |
---|
| 462 | </TABLE> |
---|
| 463 | </TD> |
---|
| 464 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
| 465 | </EM> |
---|
| 466 | </TD> |
---|
| 467 | </TR> |
---|
| 468 | |
---|
| 469 | <TR> |
---|
| 470 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 471 | <A HREF="../../../../org/apache/solr/highlight/SolrFragmentsBuilder.html" title="class in org.apache.solr.highlight"><B>PREV CLASS</B></A> |
---|
| 472 | <A HREF="../../../../org/apache/solr/highlight/WeightedFragListBuilder.html" title="class in org.apache.solr.highlight"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 473 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 474 | <A HREF="../../../../index.html?org/apache/solr/highlight/SolrHighlighter.html" target="_top"><B>FRAMES</B></A> |
---|
| 475 | <A HREF="SolrHighlighter.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 476 | <SCRIPT type="text/javascript"> |
---|
| 477 | <!-- |
---|
| 478 | if(window==top) { |
---|
| 479 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
| 480 | } |
---|
| 481 | //--> |
---|
| 482 | </SCRIPT> |
---|
| 483 | <NOSCRIPT> |
---|
| 484 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
| 485 | </NOSCRIPT> |
---|
| 486 | |
---|
| 487 | |
---|
| 488 | </FONT></TD> |
---|
| 489 | </TR> |
---|
| 490 | <TR> |
---|
| 491 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 492 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 493 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 494 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
| 495 | </TR> |
---|
| 496 | </TABLE> |
---|
| 497 | <A NAME="skip-navbar_bottom"></A> |
---|
| 498 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
| 499 | |
---|
| 500 | <HR> |
---|
| 501 | |
---|
| 502 | <address>Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.</address> |
---|
| 503 | <script src='../../../../prettify.js' type='text/javascript'></script> |
---|
| 504 | <script type='text/javascript'> |
---|
| 505 | (function(){ |
---|
| 506 | var oldonload = window.onload; |
---|
| 507 | if (typeof oldonload != 'function') { |
---|
| 508 | window.onload = prettyPrint; |
---|
| 509 | } else { |
---|
| 510 | window.onload = function() { |
---|
| 511 | oldonload(); |
---|
| 512 | prettyPrint(); |
---|
| 513 | } |
---|
| 514 | } |
---|
| 515 | })(); |
---|
| 516 | </script> |
---|
| 517 | |
---|
| 518 | </BODY> |
---|
| 519 | </HTML> |
---|