highlighter.html

Lucene是apache软件基金会[4] jakarta项目组的一个子项目

 <A HREF="../../../../../org/apache/lucene/search/highlight/Highlighter.html#getBestFragments(org.apache.lucene.analysis.TokenStream, java.lang.String, int)"><CODE>getBestFragments(TokenStream, String, int)</CODE></A>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>analyzer</CODE> - the analyzer that will be used to split <code>text</code>
 into chunks<DD><CODE>fieldName</CODE> - the name of the field being highlighted (used by analyzer)<DD><CODE>text</CODE> - text to highlight terms in<DD><CODE>maxNumFragments</CODE> - the maximum number of fragments.
<DT><B>Returns:</B><DD>highlighted text fragments (between 0 and maxNumFragments number of fragments)
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getBestFragments(org.apache.lucene.analysis.TokenStream, java.lang.String, int)"><!-- --></A><H3>
getBestFragments</H3>
<PRE>
public final <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>getBestFragments</B>(<A HREF="../../../../../org/apache/lucene/analysis/TokenStream.html" title="class in org.apache.lucene.analysis">TokenStream</A>&nbsp;tokenStream,
                                       <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;text,
                                       int&nbsp;maxNumFragments)
                                throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Highlights chosen terms in a text, extracting the most relevant sections.
 The document text is analysed in chunks to record hit statistics
 across the document. After accumulating stats, the fragments with the highest scores
 are returned as an array of strings in order of score (contiguous fragments are merged into
 one in their original order to improve readability)
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>text</CODE> - text to highlight terms in<DD><CODE>maxNumFragments</CODE> - the maximum number of fragments.
<DT><B>Returns:</B><DD>highlighted text fragments (between 0 and maxNumFragments number of fragments)
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getBestTextFragments(org.apache.lucene.analysis.TokenStream, java.lang.String, boolean, int)"><!-- --></A><H3>
getBestTextFragments</H3>
<PRE>
public final <A HREF="../../../../../org/apache/lucene/search/highlight/TextFragment.html" title="class in org.apache.lucene.search.highlight">TextFragment</A>[] <B>getBestTextFragments</B>(<A HREF="../../../../../org/apache/lucene/analysis/TokenStream.html" title="class in org.apache.lucene.analysis">TokenStream</A>&nbsp;tokenStream,
                                                 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;text,
                                                 boolean&nbsp;mergeContiguousFragments,
                                                 int&nbsp;maxNumFragments)
                                          throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Low level api to get the most relevant (formatted) sections of the document.
 This method has been made public to allow visibility of score information held in TextFragment objects.
 Thanks to Jason Calabrese for help in redefining the interface.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>tokenStream</CODE> - <DD><CODE>text</CODE> - <DD><CODE>maxNumFragments</CODE> - <DD><CODE>mergeContiguousFragments</CODE> - 
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getBestFragments(org.apache.lucene.analysis.TokenStream, java.lang.String, int, java.lang.String)"><!-- --></A><H3>
getBestFragments</H3>
<PRE>
public final <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getBestFragments</B>(<A HREF="../../../../../org/apache/lucene/analysis/TokenStream.html" title="class in org.apache.lucene.analysis">TokenStream</A>&nbsp;tokenStream,
                                     <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;text,
                                     int&nbsp;maxNumFragments,
                                     <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;separator)
                              throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Highlights terms in the  text , extracting the most relevant sections
 and concatenating the chosen fragments with a separator (typically "...").
 The document text is analysed in chunks to record hit statistics
 across the document. After accumulating stats, the fragments with the highest scores
 are returned in order as "separator" delimited strings.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>text</CODE> - text to highlight terms in<DD><CODE>maxNumFragments</CODE> - the maximum number of fragments.<DD><CODE>separator</CODE> - the separator used to intersperse the document fragments (typically "...")
<DT><B>Returns:</B><DD>highlighted text
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getMaxDocBytesToAnalyze()"><!-- --></A><H3>
getMaxDocBytesToAnalyze</H3>
<PRE>
public int <B>getMaxDocBytesToAnalyze</B>()</PRE>
<DL>
<DD><DL>

<DT><B>Returns:</B><DD>the maximum number of bytes to be tokenized per doc</DL>
</DD>
</DL>
<HR>

<A NAME="setMaxDocBytesToAnalyze(int)"><!-- --></A><H3>
setMaxDocBytesToAnalyze</H3>
<PRE>
public void <B>setMaxDocBytesToAnalyze</B>(int&nbsp;byteCount)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>byteCount</CODE> - the maximum number of bytes to be tokenized per doc
 (This can improve performance with large documents)</DL>
</DD>
</DL>
<HR>

<A NAME="getTextFragmenter()"><!-- --></A><H3>
getTextFragmenter</H3>
<PRE>
public <A HREF="../../../../../org/apache/lucene/search/highlight/Fragmenter.html" title="interface in org.apache.lucene.search.highlight">Fragmenter</A> <B>getTextFragmenter</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setTextFragmenter(org.apache.lucene.search.highlight.Fragmenter)"><!-- --></A><H3>
setTextFragmenter</H3>
<PRE>
public void <B>setTextFragmenter</B>(<A HREF="../../../../../org/apache/lucene/search/highlight/Fragmenter.html" title="interface in org.apache.lucene.search.highlight">Fragmenter</A>&nbsp;fragmenter)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fragmenter</CODE> - </DL>
</DD>
</DL>
<HR>

<A NAME="getFragmentScorer()"><!-- --></A><H3>
getFragmentScorer</H3>
<PRE>
public <A HREF="../../../../../org/apache/lucene/search/highlight/Scorer.html" title="interface in org.apache.lucene.search.highlight">Scorer</A> <B>getFragmentScorer</B>()</PRE>
<DL>
<DD><DL>

<DT><B>Returns:</B><DD>Object used to score each text fragment</DL>
</DD>
</DL>
<HR>

<A NAME="setFragmentScorer(org.apache.lucene.search.highlight.Scorer)"><!-- --></A><H3>
setFragmentScorer</H3>
<PRE>
public void <B>setFragmentScorer</B>(<A HREF="../../../../../org/apache/lucene/search/highlight/Scorer.html" title="interface in org.apache.lucene.search.highlight">Scorer</A>&nbsp;scorer)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>scorer</CODE> - </DL>
</DD>
</DL>
<HR>

<A NAME="getEncoder()"><!-- --></A><H3>
getEncoder</H3>
<PRE>
public <A HREF="../../../../../org/apache/lucene/search/highlight/Encoder.html" title="interface in org.apache.lucene.search.highlight">Encoder</A> <B>getEncoder</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setEncoder(org.apache.lucene.search.highlight.Encoder)"><!-- --></A><H3>
setEncoder</H3>
<PRE>
public void <B>setEncoder</B>(<A HREF="../../../../../org/apache/lucene/search/highlight/Encoder.html" title="interface in org.apache.lucene.search.highlight">Encoder</A>&nbsp;encoder)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Highlighter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/lucene/search/highlight/GradientFormatter.html" title="class in org.apache.lucene.search.highlight"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/lucene/search/highlight/NullFragmenter.html" title="class in org.apache.lucene.search.highlight"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Highlighter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  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>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&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>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright &copy; 2000-2007 Apache Software Foundation.  All Rights Reserved.
</BODY>
</HTML>