diff --git a/solr/src/java/org/apache/solr/analysis/ASCIIFoldingFilterFactory.java b/solr/src/java/org/apache/solr/analysis/ASCIIFoldingFilterFactory.java index 8513d3453f6..5926713b02d 100644 --- a/solr/src/java/org/apache/solr/analysis/ASCIIFoldingFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/ASCIIFoldingFilterFactory.java @@ -21,7 +21,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.miscellaneous.ASCIIFoldingFilter; import org.apache.lucene.analysis.TokenStream; -/** Factory for {@link ASCIIFoldingFilter} */ +/** + * Factory for {@link ASCIIFoldingFilter}. + * 
+ * <fieldType name="text_ascii" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.ASCIIFoldingFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
+ * @version $Id$ + */ public class ASCIIFoldingFilterFactory extends BaseTokenFilterFactory { public ASCIIFoldingFilter create(TokenStream input) { return new ASCIIFoldingFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/ArabicNormalizationFilterFactory.java b/solr/src/java/org/apache/solr/analysis/ArabicNormalizationFilterFactory.java index 3c6ac90db9a..7a3e9830237 100644 --- a/solr/src/java/org/apache/solr/analysis/ArabicNormalizationFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/ArabicNormalizationFilterFactory.java @@ -21,8 +21,16 @@ import org.apache.lucene.analysis.ar.ArabicNormalizationFilter; /** - * Factory for {@link ArabicNormalizationFilter} - **/ + * Factory for {@link ArabicNormalizationFilter}. + * 
+ * <fieldType name="text_arnormal" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.ArabicNormalizationFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
+ * @version $Id$ + */ public class ArabicNormalizationFilterFactory extends BaseTokenFilterFactory{ public ArabicNormalizationFilter create(TokenStream input) { diff --git a/solr/src/java/org/apache/solr/analysis/ArabicStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/ArabicStemFilterFactory.java index 4042bf2b348..b8773019a4c 100644 --- a/solr/src/java/org/apache/solr/analysis/ArabicStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/ArabicStemFilterFactory.java @@ -21,8 +21,16 @@ import org.apache.lucene.analysis.ar.ArabicStemFilter; /** - * Factory for {@link ArabicStemFilter} - **/ + * Factory for {@link ArabicStemFilter}. + * 
+ * <fieldType name="text_arstem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.ArabicStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
+ * @version $Id$ + */ public class ArabicStemFilterFactory extends BaseTokenFilterFactory{ diff --git a/solr/src/java/org/apache/solr/analysis/BrazilianStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/BrazilianStemFilterFactory.java index 26ca406af26..6d96441d312 100644 --- a/solr/src/java/org/apache/solr/analysis/BrazilianStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/BrazilianStemFilterFactory.java @@ -21,7 +21,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.br.BrazilianStemFilter; -/** Factory for {@link BrazilianStemFilter} */ +/** + * Factory for {@link BrazilianStemFilter}. + * 
+ * <fieldType name="text_brstem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.BrazilianStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
+ * @version $Id$ + */ public class BrazilianStemFilterFactory extends BaseTokenFilterFactory { public BrazilianStemFilter create(TokenStream in) { return new BrazilianStemFilter(in); diff --git a/solr/src/java/org/apache/solr/analysis/BulgarianStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/BulgarianStemFilterFactory.java index 53acdf93c2e..44563df043b 100644 --- a/solr/src/java/org/apache/solr/analysis/BulgarianStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/BulgarianStemFilterFactory.java @@ -20,7 +20,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.bg.BulgarianStemFilter; -/** Factory for {@link BulgarianStemFilter} */ +/** + * Factory for {@link BulgarianStemFilter}. + * 
+ * <fieldType name="text_bgstem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.BulgarianStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
+ * @version $Id$ + */ public class BulgarianStemFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { return new BulgarianStemFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/CJKTokenizerFactory.java b/solr/src/java/org/apache/solr/analysis/CJKTokenizerFactory.java index 2e0e7f8933a..c3ba41b6be7 100644 --- a/solr/src/java/org/apache/solr/analysis/CJKTokenizerFactory.java +++ b/solr/src/java/org/apache/solr/analysis/CJKTokenizerFactory.java @@ -22,7 +22,16 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.cjk.CJKTokenizer; import java.io.Reader; -/** Factory for {@link CJKTokenizer} */ +/** + * Factory for {@link CJKTokenizer}. + * 
+ * <fieldType name="text_cjk" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.CJKTokenizerFactory"/>
+ *   </analyzer>
+ * </fieldType>
+ * @version $Id$ + */ public class CJKTokenizerFactory extends BaseTokenizerFactory { public CJKTokenizer create(Reader in) { return new CJKTokenizer(in); diff --git a/solr/src/java/org/apache/solr/analysis/CapitalizationFilterFactory.java b/solr/src/java/org/apache/solr/analysis/CapitalizationFilterFactory.java index 07ab89ba6a6..81747847333 100644 --- a/solr/src/java/org/apache/solr/analysis/CapitalizationFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/CapitalizationFilterFactory.java @@ -33,7 +33,7 @@ import java.util.StringTokenizer; * The factory takes parameters:
* "onlyFirstWord" - should each word be capitalized or all of the words?
* "keep" - a keep word list. Each word that should be kept separated by whitespace.
- * "keepIgnoreCase - true or false. If true, the keep list will be considered case-insensitive. + * "keepIgnoreCase - true or false. If true, the keep list will be considered case-insensitive.
* "forceFirstLetter" - Force the first letter to be capitalized even if it is in the keep list
* "okPrefix" - do not change word capitalization if a word begins with something in this list. * for example if "McK" is on the okPrefix list, the word "McKinley" should not be changed to @@ -43,6 +43,16 @@ import java.util.StringTokenizer; * "maxWordCount" - if the token contains more then maxWordCount words, the capitalization is * assumed to be correct.
* + * 
+ * <fieldType name="text_cptlztn" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.CapitalizationFilterFactory" onlyFirstWord="true"
+ *     	     keep="java solr lucene" keepIgnoreCase="false"
+ *     	     okPrefix="McK McD McA"/>   
+ *   </analyzer>
+ * </fieldType>
+ * * @version $Id$ * @since solr 1.3 */ diff --git a/solr/src/java/org/apache/solr/analysis/ClassicFilterFactory.java b/solr/src/java/org/apache/solr/analysis/ClassicFilterFactory.java index a7ac168a7f9..ff97f64753d 100644 --- a/solr/src/java/org/apache/solr/analysis/ClassicFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/ClassicFilterFactory.java @@ -22,6 +22,15 @@ import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.standard.ClassicFilter; /** + * Factory for {@link ClassicFilter}. + * 
+ * <fieldType name="text_clssc" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.ClassicFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
+ * * @version $Id$ */ public class ClassicFilterFactory extends BaseTokenFilterFactory { diff --git a/solr/src/java/org/apache/solr/analysis/ClassicTokenizerFactory.java b/solr/src/java/org/apache/solr/analysis/ClassicTokenizerFactory.java index 8acc832d8fc..edaf6e2f996 100644 --- a/solr/src/java/org/apache/solr/analysis/ClassicTokenizerFactory.java +++ b/solr/src/java/org/apache/solr/analysis/ClassicTokenizerFactory.java @@ -24,6 +24,14 @@ import java.io.Reader; import java.util.Map; /** + * Factory for {@link ClassicTokenizer}. + * 
+ * <fieldType name="text_clssc" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.ClassicTokenizerFactory" maxTokenLength="120"/>
+ *   </analyzer>
+ * </fieldType>
+ * * @version $Id$ */ diff --git a/solr/src/java/org/apache/solr/analysis/CollationKeyFilterFactory.java b/solr/src/java/org/apache/solr/analysis/CollationKeyFilterFactory.java index c0f0867a386..67b84126511 100644 --- a/solr/src/java/org/apache/solr/analysis/CollationKeyFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/CollationKeyFilterFactory.java @@ -56,11 +56,19 @@ import org.apache.solr.util.plugin.ResourceLoaderAware; *
  • strength: 'primary','secondary','tertiary', or 'identical' (optional) *
  • decomposition: 'no','canonical', or 'full' (optional) * - * + * + * 
    + * <fieldType name="text_clltnky" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.CollationKeyFilterFactory" language="ja" country="JP"/>
+ *   </analyzer>
+ * </fieldType>
    + * * @see Collator * @see Locale * @see RuleBasedCollator - * @since solr 1.5 + * @since solr 3.1 */ public class CollationKeyFilterFactory extends BaseTokenFilterFactory implements ResourceLoaderAware { private Collator collator; diff --git a/solr/src/java/org/apache/solr/analysis/CommonGramsFilterFactory.java b/solr/src/java/org/apache/solr/analysis/CommonGramsFilterFactory.java index 386b3de887b..dede00a5e4b 100644 --- a/solr/src/java/org/apache/solr/analysis/CommonGramsFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/CommonGramsFilterFactory.java @@ -27,7 +27,15 @@ import org.apache.solr.common.ResourceLoader; import org.apache.solr.util.plugin.ResourceLoaderAware; /** - * Constructs a CommonGramsFilter + * Constructs a {@link CommonGramsFilter}. + * 
    + * <fieldType name="text_cmmngrms" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.CommonGramsFilterFactory" words="commongramsstopwords.txt" ignoreCase="false"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ */ /* diff --git a/solr/src/java/org/apache/solr/analysis/CommonGramsQueryFilterFactory.java b/solr/src/java/org/apache/solr/analysis/CommonGramsQueryFilterFactory.java index 8ec50663774..8a27adc2df9 100644 --- a/solr/src/java/org/apache/solr/analysis/CommonGramsQueryFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/CommonGramsQueryFilterFactory.java @@ -29,10 +29,18 @@ import org.apache.solr.common.ResourceLoader; import org.apache.solr.util.plugin.ResourceLoaderAware; /** - * Construct CommonGramsQueryFilter + * Construct {@link CommonGramsQueryFilter}. * - * This is pretty close to a straight copy from StopFilterFactory + * This is pretty close to a straight copy from {@link StopFilterFactory}. * + * 
    + * <fieldType name="text_cmmngrmsqry" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.CommonGramsQueryFilterFactory" words="commongramsquerystopwords.txt" ignoreCase="false"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ */ public class CommonGramsQueryFilterFactory extends BaseTokenFilterFactory implements ResourceLoaderAware { diff --git a/solr/src/java/org/apache/solr/analysis/CzechStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/CzechStemFilterFactory.java index f3f889f146d..18d3ea77b1b 100644 --- a/solr/src/java/org/apache/solr/analysis/CzechStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/CzechStemFilterFactory.java @@ -20,7 +20,16 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.cz.CzechStemFilter; -/** Factory for {@link CzechStemFilter} */ +/** + * Factory for {@link CzechStemFilter}. + * 
    + * <fieldType name="text_czstem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.CzechStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + */ public class CzechStemFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { return new CzechStemFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/DelimitedPayloadTokenFilterFactory.java b/solr/src/java/org/apache/solr/analysis/DelimitedPayloadTokenFilterFactory.java index 69127a5712c..de1ab11ab15 100644 --- a/solr/src/java/org/apache/solr/analysis/DelimitedPayloadTokenFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/DelimitedPayloadTokenFilterFactory.java @@ -31,8 +31,17 @@ import java.util.Map; /** * - * Factory for {@link DelimitedPayloadTokenFilter} - **/ + * Factory for {@link DelimitedPayloadTokenFilter}. + * 
    + * <fieldType name="text_dlmtd" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.DelimitedPayloadTokenFilterFactory" encoder="float" delimiter="|"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + * + */ public class DelimitedPayloadTokenFilterFactory extends BaseTokenFilterFactory implements ResourceLoaderAware { public static final String ENCODER_ATTR = "encoder"; public static final String DELIMITER_ATTR = "delimiter"; diff --git a/solr/src/java/org/apache/solr/analysis/DictionaryCompoundWordTokenFilterFactory.java b/solr/src/java/org/apache/solr/analysis/DictionaryCompoundWordTokenFilterFactory.java index 63e650e9d7d..e3010ead884 100644 --- a/solr/src/java/org/apache/solr/analysis/DictionaryCompoundWordTokenFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/DictionaryCompoundWordTokenFilterFactory.java @@ -28,7 +28,18 @@ import org.apache.lucene.analysis.TokenStream; import java.util.Map; import java.io.IOException; -/** Factory for {@link DictionaryCompoundWordTokenFilter} */ +/** + * Factory for {@link DictionaryCompoundWordTokenFilter}. + * 
    + * <fieldType name="text_dictcomp" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.DictionaryCompoundWordTokenFilterFactory" dictionary="dictionary.txt"
+ *     	     minWordSize="5" minSubwordSize="2" maxSubwordSize="15" onlyLongestMatch="true"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class DictionaryCompoundWordTokenFilterFactory extends BaseTokenFilterFactory implements ResourceLoaderAware { private CharArraySet dictionary; private String dictFile; diff --git a/solr/src/java/org/apache/solr/analysis/DoubleMetaphoneFilterFactory.java b/solr/src/java/org/apache/solr/analysis/DoubleMetaphoneFilterFactory.java index bb72143c56c..2089f4835c1 100644 --- a/solr/src/java/org/apache/solr/analysis/DoubleMetaphoneFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/DoubleMetaphoneFilterFactory.java @@ -21,6 +21,17 @@ import java.util.Map; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.phonetic.DoubleMetaphoneFilter; +/** + * Factory for {@link DoubleMetaphoneFilter}. + * 
    + * <fieldType name="text_dblmtphn" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.DoubleMetaphoneFilterFactory" inject="true" maxCodeLength="4"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class DoubleMetaphoneFilterFactory extends BaseTokenFilterFactory { public static final String INJECT = "inject"; diff --git a/solr/src/java/org/apache/solr/analysis/EdgeNGramFilterFactory.java b/solr/src/java/org/apache/solr/analysis/EdgeNGramFilterFactory.java index a05b6257086..c7f07796176 100644 --- a/solr/src/java/org/apache/solr/analysis/EdgeNGramFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/EdgeNGramFilterFactory.java @@ -23,6 +23,14 @@ import org.apache.lucene.analysis.ngram.EdgeNGramTokenFilter; /** * Creates new instances of {@link EdgeNGramTokenFilter}. + * 
    + * <fieldType name="text_edgngrm" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.EdgeNGramFilterFactory" side="front" minGramSize="1" maxGramSize="1"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ */ public class EdgeNGramFilterFactory extends BaseTokenFilterFactory { private int maxGramSize = 0; diff --git a/solr/src/java/org/apache/solr/analysis/EdgeNGramTokenizerFactory.java b/solr/src/java/org/apache/solr/analysis/EdgeNGramTokenizerFactory.java index 7d97699681e..9945d5f12a4 100755 --- a/solr/src/java/org/apache/solr/analysis/EdgeNGramTokenizerFactory.java +++ b/solr/src/java/org/apache/solr/analysis/EdgeNGramTokenizerFactory.java @@ -24,6 +24,13 @@ import java.util.Map; /** * Creates new instances of {@link EdgeNGramTokenizer}. + * 
    + * <fieldType name="text_edgngrm" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.EdgeNGramTokenizerFactory" side="front" minGramSize="1" maxGramSize="1"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ */ public class EdgeNGramTokenizerFactory extends BaseTokenizerFactory { private int maxGramSize = 0; diff --git a/solr/src/java/org/apache/solr/analysis/ElisionFilterFactory.java b/solr/src/java/org/apache/solr/analysis/ElisionFilterFactory.java index 3ced2246a1f..894ec436e19 100644 --- a/solr/src/java/org/apache/solr/analysis/ElisionFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/ElisionFilterFactory.java @@ -27,7 +27,17 @@ import org.apache.lucene.analysis.util.CharArraySet; import java.io.IOException; import org.apache.lucene.analysis.TokenStream; -/** Factory for {@link ElisionFilter} */ +/** + * Factory for {@link ElisionFilter}. + * 
    + * <fieldType name="text_elsn" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.ElisionFilterFactory" articles="stopwordarticles.txt"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class ElisionFilterFactory extends BaseTokenFilterFactory implements ResourceLoaderAware { private CharArraySet articles; diff --git a/solr/src/java/org/apache/solr/analysis/EnglishMinimalStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/EnglishMinimalStemFilterFactory.java index a7f1f6dab5c..f64ce24d862 100644 --- a/solr/src/java/org/apache/solr/analysis/EnglishMinimalStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/EnglishMinimalStemFilterFactory.java @@ -20,7 +20,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.en.EnglishMinimalStemFilter; -/** Factory for {@link EnglishMinimalStemFilter} */ +/** + * Factory for {@link EnglishMinimalStemFilter}. + * 
    + * <fieldType name="text_enminstem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.EnglishMinimalStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class EnglishMinimalStemFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { return new EnglishMinimalStemFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/EnglishPossessiveFilterFactory.java b/solr/src/java/org/apache/solr/analysis/EnglishPossessiveFilterFactory.java index 3134dcc18f6..488c822ff43 100644 --- a/solr/src/java/org/apache/solr/analysis/EnglishPossessiveFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/EnglishPossessiveFilterFactory.java @@ -20,7 +20,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.en.EnglishPossessiveFilter; -/** Factory for {@link EnglishPossessiveFilter} */ +/** + * Factory for {@link EnglishPossessiveFilter}. + * 
    + * <fieldType name="text_enpossessive" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.EnglishPossessiveFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class EnglishPossessiveFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { return new EnglishPossessiveFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/FinnishLightStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/FinnishLightStemFilterFactory.java index 7a284ed6f8a..ebb077bda1b 100644 --- a/solr/src/java/org/apache/solr/analysis/FinnishLightStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/FinnishLightStemFilterFactory.java @@ -20,7 +20,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.fi.FinnishLightStemFilter; -/** Factory for {@link FinnishLightStemFilter} */ +/** + * Factory for {@link FinnishLightStemFilter}. + * 
    + * <fieldType name="text_filgtstem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.FinnishLightStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class FinnishLightStemFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { return new FinnishLightStemFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/FrenchLightStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/FrenchLightStemFilterFactory.java index a2f15896174..2e1c16fb6c6 100644 --- a/solr/src/java/org/apache/solr/analysis/FrenchLightStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/FrenchLightStemFilterFactory.java @@ -20,7 +20,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.fr.FrenchLightStemFilter; -/** Factory for {@link FrenchLightStemFilter} */ +/** + * Factory for {@link FrenchLightStemFilter}. + * 
    + * <fieldType name="text_frlgtstem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.FrenchLightStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class FrenchLightStemFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { return new FrenchLightStemFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/FrenchMinimalStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/FrenchMinimalStemFilterFactory.java index 3af344648fb..d2381da89bf 100644 --- a/solr/src/java/org/apache/solr/analysis/FrenchMinimalStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/FrenchMinimalStemFilterFactory.java @@ -20,7 +20,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.fr.FrenchMinimalStemFilter; -/** Factory for {@link FrenchMinimalStemFilter} */ +/** + * Factory for {@link FrenchMinimalStemFilter}. + * 
    + * <fieldType name="text_frminstem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.FrenchMinimalStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class FrenchMinimalStemFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { return new FrenchMinimalStemFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/GalicianStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/GalicianStemFilterFactory.java index 4cd0ec58c07..844c3f25c76 100644 --- a/solr/src/java/org/apache/solr/analysis/GalicianStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/GalicianStemFilterFactory.java @@ -20,7 +20,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.gl.GalicianStemFilter; -/** Factory for {@link GalicianStemFilter} */ +/** + * Factory for {@link GalicianStemFilter}. + * 
    + * <fieldType name="text_glstem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.GalicianStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class GalicianStemFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { return new GalicianStemFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/GermanLightStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/GermanLightStemFilterFactory.java index b790d5af297..08cb732e9cc 100644 --- a/solr/src/java/org/apache/solr/analysis/GermanLightStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/GermanLightStemFilterFactory.java @@ -20,7 +20,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.de.GermanLightStemFilter; -/** Factory for {@link GermanLightStemFilter} */ +/** + * Factory for {@link GermanLightStemFilter}. + * 
    + * <fieldType name="text_delgtstem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.GermanLightStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class GermanLightStemFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { return new GermanLightStemFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/GermanMinimalStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/GermanMinimalStemFilterFactory.java index e41329093eb..5c2f65f69c1 100644 --- a/solr/src/java/org/apache/solr/analysis/GermanMinimalStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/GermanMinimalStemFilterFactory.java @@ -20,7 +20,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.de.GermanMinimalStemFilter; -/** Factory for {@link GermanMinimalStemFilter} */ +/** + * Factory for {@link GermanMinimalStemFilter}. + * 
    + * <fieldType name="text_deminstem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.GermanMinimalStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class GermanMinimalStemFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { return new GermanMinimalStemFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/GermanStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/GermanStemFilterFactory.java index 2c85c44108d..34d8aaf5651 100644 --- a/solr/src/java/org/apache/solr/analysis/GermanStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/GermanStemFilterFactory.java @@ -22,7 +22,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.de.GermanStemFilter; import org.apache.lucene.analysis.TokenStream; -/** Factory for {@link GermanStemFilter} */ +/** + * Factory for {@link GermanStemFilter}. + * 
    + * <fieldType name="text_destem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.GermanStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class GermanStemFilterFactory extends BaseTokenFilterFactory { public GermanStemFilter create(TokenStream in) { return new GermanStemFilter(in); diff --git a/solr/src/java/org/apache/solr/analysis/GreekLowerCaseFilterFactory.java b/solr/src/java/org/apache/solr/analysis/GreekLowerCaseFilterFactory.java index 4e87773f18a..2c3a043b781 100644 --- a/solr/src/java/org/apache/solr/analysis/GreekLowerCaseFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/GreekLowerCaseFilterFactory.java @@ -26,7 +26,17 @@ import org.apache.lucene.analysis.el.GreekLowerCaseFilter; import org.apache.solr.common.SolrException; import org.apache.solr.common.SolrException.ErrorCode; -/** Factory for {@link GreekLowerCaseFilter} */ +/** + * Factory for {@link GreekLowerCaseFilter}. + * 
    + * <fieldType name="text_glc" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.GreekLowerCaseFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class GreekLowerCaseFilterFactory extends BaseTokenFilterFactory { diff --git a/solr/src/java/org/apache/solr/analysis/GreekStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/GreekStemFilterFactory.java index 2c6f005222f..2783a7e1995 100644 --- a/solr/src/java/org/apache/solr/analysis/GreekStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/GreekStemFilterFactory.java @@ -20,7 +20,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.el.GreekStemFilter; -/** Factory for {@link GreekStemFilter} */ +/** + * Factory for {@link GreekStemFilter}. + * 
    + * <fieldType name="text_gstem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.GreekStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class GreekStemFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { diff --git a/solr/src/java/org/apache/solr/analysis/HTMLStripCharFilterFactory.java b/solr/src/java/org/apache/solr/analysis/HTMLStripCharFilterFactory.java index 70130d9b5f9..096a07b896c 100644 --- a/solr/src/java/org/apache/solr/analysis/HTMLStripCharFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/HTMLStripCharFilterFactory.java @@ -21,7 +21,18 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.CharStream; import org.apache.lucene.analysis.charfilter.HTMLStripCharFilter; -public class HTMLStripCharFilterFactory extends BaseCharFilterFactory { +/** +* Factory for {@link HTMLStripCharFilter}. + * 
    + * <fieldType name="text_html" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <charFilter class="solr.HTMLStripCharFilterFactory"/>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * <fieldType name="text_hinormal" class="solr.TextField" positionIncrementGap="100"> + * <analyzer> + * <tokenizer class="solr.WhitespaceTokenizerFactory"/> + * <filter class="solr.HindiNormalizationFilterFactory"/> + * </analyzer> + * </fieldType> + * @version $Id$ + */ public class HindiNormalizationFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { return new HindiNormalizationFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/HindiStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/HindiStemFilterFactory.java index 406343e021e..e54e8c0ce3c 100644 --- a/solr/src/java/org/apache/solr/analysis/HindiStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/HindiStemFilterFactory.java @@ -20,7 +20,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.hi.HindiStemFilter; -/** Factory for {@link HindiStemFilter} */ +/** + * Factory for {@link HindiStemFilter}. + * 
    + * <fieldType name="text_histem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.HindiStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class HindiStemFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { return new HindiStemFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/HungarianLightStemFilterFactory.java b/solr/src/java/org/apache/solr/analysis/HungarianLightStemFilterFactory.java index b4f6dce5acc..60a46fbb3ce 100644 --- a/solr/src/java/org/apache/solr/analysis/HungarianLightStemFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/HungarianLightStemFilterFactory.java @@ -20,7 +20,17 @@ package org.apache.solr.analysis; import org.apache.lucene.analysis.TokenStream; import org.apache.lucene.analysis.hu.HungarianLightStemFilter; -/** Factory for {@link HungarianLightStemFilter} */ +/** + * Factory for {@link HungarianLightStemFilter}. + * 
    + * <fieldType name="text_hulgtstem" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.HungarianLightStemFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ + */ public class HungarianLightStemFilterFactory extends BaseTokenFilterFactory { public TokenStream create(TokenStream input) { return new HungarianLightStemFilter(input); diff --git a/solr/src/java/org/apache/solr/analysis/HyphenatedWordsFilterFactory.java b/solr/src/java/org/apache/solr/analysis/HyphenatedWordsFilterFactory.java index 8e1170d6388..7e68d4e727f 100755 --- a/solr/src/java/org/apache/solr/analysis/HyphenatedWordsFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/HyphenatedWordsFilterFactory.java @@ -22,7 +22,15 @@ import org.apache.lucene.analysis.miscellaneous.HyphenatedWordsFilter; import org.apache.solr.analysis.BaseTokenFilterFactory; /** - * Factory for {@link HyphenatedWordsFilter} + * Factory for {@link HyphenatedWordsFilter}. + * 
    + * <fieldType name="text_hyphn" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.HyphenatedWordsFilterFactory"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ */ public class HyphenatedWordsFilterFactory extends BaseTokenFilterFactory { public HyphenatedWordsFilter create(TokenStream input) { diff --git a/solr/src/java/org/apache/solr/analysis/HyphenationCompoundWordTokenFilterFactory.java b/solr/src/java/org/apache/solr/analysis/HyphenationCompoundWordTokenFilterFactory.java index a90cef5d5da..7fca6f2349b 100644 --- a/solr/src/java/org/apache/solr/analysis/HyphenationCompoundWordTokenFilterFactory.java +++ b/solr/src/java/org/apache/solr/analysis/HyphenationCompoundWordTokenFilterFactory.java @@ -33,7 +33,7 @@ import java.io.InputStream; import org.xml.sax.InputSource; /** - * Factory for {@link HyphenationCompoundWordTokenFilter} + * Factory for {@link HyphenationCompoundWordTokenFilter}. *

    * This factory accepts the following parameters: *

    *

    + * 

    + * <fieldType name="text_hyphncomp" class="solr.TextField" positionIncrementGap="100">
+ *   <analyzer>
+ *     <tokenizer class="solr.WhitespaceTokenizerFactory"/>
+ *     <filter class="solr.HyphenationCompoundWordTokenFilterFactory" hyphenator="hyphenator.xml" encoding="UTF-8"
+ *     	     dictionary="dictionary.txt" minWordSize="5" minSubwordSize="2" maxSubwordSize="15" onlyLongestMatch="false"/>
+ *   </analyzer>
+ * </fieldType>
    + * @version $Id$ * @see HyphenationCompoundWordTokenFilter */ public class HyphenationCompoundWordTokenFilterFactory extends BaseTokenFilterFactory implements ResourceLoaderAware {