solr-4.6.0/docs/solr-clustering/org/apache/solr/handler/clustering/carrot2/LuceneCarrot2StemmerFactory.html

   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_30) on Tue Nov 19 11:17:19 CET 2013 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=utf-8">
   7 <TITLE>
   8 LuceneCarrot2StemmerFactory (Solr 4.6.0 API)
   9 </TITLE>
  10
  11 <META NAME="date" CONTENT="2013-11-19">
  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="LuceneCarrot2StemmerFactory (Solr 4.6.0 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/LuceneCarrot2StemmerFactory.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/handler/clustering/carrot2/CarrotParams.html" title="class in org.apache.solr.handler.clustering.carrot2"><B>PREV CLASS</B></A>&nbsp;
  59 &nbsp;<A HREF="../../../../../../org/apache/solr/handler/clustering/carrot2/LuceneCarrot2TokenizerFactory.html" title="class in org.apache.solr.handler.clustering.carrot2"><B>NEXT CLASS</B></A></FONT></TD>
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  61   <A HREF="../../../../../../index.html?org/apache/solr/handler/clustering/carrot2/LuceneCarrot2StemmerFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  62 &nbsp;<A HREF="LuceneCarrot2StemmerFactory.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;FIELD&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">
  81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  82 </TR>
  83 </TABLE>
  84 <A NAME="skip-navbar_top"></A>
  85 <!-- ========= END OF TOP NAVBAR ========= -->
  86
  87 <HR>
  88 <!-- ======== START OF CLASS DATA ======== -->
  89 <H2>
  90 <FONT SIZE="-1">
  91 org.apache.solr.handler.clustering.carrot2</FONT>
  92 <BR>
  93 Class LuceneCarrot2StemmerFactory</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.handler.clustering.carrot2.LuceneCarrot2StemmerFactory</B>
  97 </PRE>
  98 <DL>
  99 <DT><B>All Implemented Interfaces:</B> <DD>org.carrot2.text.linguistic.IStemmerFactory</DD>
 100 </DL>
 101 <HR>
 102 <DL>
 103 <DT><PRE>public class <B>LuceneCarrot2StemmerFactory</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 org.carrot2.text.linguistic.IStemmerFactory</DL>
 104 </PRE>
 105
 106 <P>
 107 An implementation of Carrot2's <CODE>IStemmerFactory</CODE> based on Lucene's
 108  APIs. Should the relevant Lucene APIs need to change, the changes can be made
 109  in this class.
 110 <P>
 111
 112 <P>
 113 <DL>
 114 <DT><B>WARNING: This API is experimental and might change in incompatible ways in the next release.</B></DT>
 115   <DD></DD>
 116 </DL>
 117 <HR>
 118
 119 <P>
 120
 121 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 122
 123 <A NAME="constructor_summary"><!-- --></A>
 124 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 125 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 126 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 127 <B>Constructor Summary</B></FONT></TH>
 128 </TR>
 129 <TR BGCOLOR="white" CLASS="TableRowColor">
 130 <TD><CODE><B><A HREF="../../../../../../org/apache/solr/handler/clustering/carrot2/LuceneCarrot2StemmerFactory.html#LuceneCarrot2StemmerFactory()">LuceneCarrot2StemmerFactory</A></B>()</CODE>
 131
 132 <BR>
 133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 134 </TR>
 135 </TABLE>
 136 &nbsp;
 137 <!-- ========== METHOD SUMMARY =========== -->
 138
 139 <A NAME="method_summary"><!-- --></A>
 140 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 141 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 142 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 143 <B>Method Summary</B></FONT></TH>
 144 </TR>
 145 <TR BGCOLOR="white" CLASS="TableRowColor">
 146 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 147 <CODE>&nbsp;org.carrot2.text.linguistic.IStemmer</CODE></FONT></TD>
 148 <TD><CODE><B><A HREF="../../../../../../org/apache/solr/handler/clustering/carrot2/LuceneCarrot2StemmerFactory.html#getStemmer(org.carrot2.core.LanguageCode)">getStemmer</A></B>(org.carrot2.core.LanguageCode&nbsp;language)</CODE>
 149
 150 <BR>
 151 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 152 </TR>
 153 </TABLE>
 154 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 155 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 156 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 157 <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>
 158 </TR>
 159 <TR BGCOLOR="white" CLASS="TableRowColor">
 160 <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>
 161 </TR>
 162 </TABLE>
 163 &nbsp;
 164 <P>
 165
 166 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 167
 168 <A NAME="constructor_detail"><!-- --></A>
 169 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 170 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 171 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 172 <B>Constructor Detail</B></FONT></TH>
 173 </TR>
 174 </TABLE>
 175
 176 <A NAME="LuceneCarrot2StemmerFactory()"><!-- --></A><H3>
 177 LuceneCarrot2StemmerFactory</H3>
 178 <PRE>
 179 public <B>LuceneCarrot2StemmerFactory</B>()</PRE>
 180 <DL>
 181 </DL>
 182
 183 <!-- ============ METHOD DETAIL ========== -->
 184
 185 <A NAME="method_detail"><!-- --></A>
 186 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 187 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 188 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 189 <B>Method Detail</B></FONT></TH>
 190 </TR>
 191 </TABLE>
 192
 193 <A NAME="getStemmer(org.carrot2.core.LanguageCode)"><!-- --></A><H3>
 194 getStemmer</H3>
 195 <PRE>
 196 public org.carrot2.text.linguistic.IStemmer <B>getStemmer</B>(org.carrot2.core.LanguageCode&nbsp;language)</PRE>
 197 <DL>
 198 <DD><DL>
 199 <DT><B>Specified by:</B><DD><CODE>getStemmer</CODE> in interface <CODE>org.carrot2.text.linguistic.IStemmerFactory</CODE></DL>
 200 </DD>
 201 <DD><DL>
 202 </DL>
 203 </DD>
 204 </DL>
 205 <!-- ========= END OF CLASS DATA ========= -->
 206 <HR>
 207
 208
 209 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 210 <A NAME="navbar_bottom"><!-- --></A>
 211 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 212 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 213 <TR>
 214 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 215 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 216 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 217   <TR ALIGN="center" VALIGN="top">
 218   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 219   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 220   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 221   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/LuceneCarrot2StemmerFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 222   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 223   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 224   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 225   </TR>
 226 </TABLE>
 227 </TD>
 228 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 229 </EM>
 230 </TD>
 231 </TR>
 232
 233 <TR>
 234 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 235 &nbsp;<A HREF="../../../../../../org/apache/solr/handler/clustering/carrot2/CarrotParams.html" title="class in org.apache.solr.handler.clustering.carrot2"><B>PREV CLASS</B></A>&nbsp;
 236 &nbsp;<A HREF="../../../../../../org/apache/solr/handler/clustering/carrot2/LuceneCarrot2TokenizerFactory.html" title="class in org.apache.solr.handler.clustering.carrot2"><B>NEXT CLASS</B></A></FONT></TD>
 237 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 238   <A HREF="../../../../../../index.html?org/apache/solr/handler/clustering/carrot2/LuceneCarrot2StemmerFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 239 &nbsp;<A HREF="LuceneCarrot2StemmerFactory.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 240 &nbsp;<SCRIPT type="text/javascript">
 241   <!--
 242   if(window==top) {
 243     document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 244   }
 245   //-->
 246 </SCRIPT>
 247 <NOSCRIPT>
 248   <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 249 </NOSCRIPT>
 250
 251
 252 </FONT></TD>
 253 </TR>
 254 <TR>
 255 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 256   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 257 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 258 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 259 </TR>
 260 </TABLE>
 261 <A NAME="skip-navbar_bottom"></A>
 262 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 263
 264 <HR>
 265
 266           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 267           <script src='../../../../../../prettify.js' type='text/javascript'></script>
 268           <script type='text/javascript'>
 269             (function(){
 270               var oldonload = window.onload;
 271               if (typeof oldonload != 'function') {
 272                 window.onload = prettyPrint;
 273               } else {
 274                 window.onload = function() {
 275                   oldonload();
 276                   prettyPrint();
 277                 }
 278               }
 279             })();
 280           </script>
 281
 282 </BODY>
 283 </HTML>