Class TypeAsSynonymFilterFactory


  • public class TypeAsSynonymFilterFactory
    extends TokenFilterFactory
    Factory for TypeAsSynonymFilter.

    In Solr this might be used as such

     <fieldType name="text_type_as_synonym" class="solr.TextField" positionIncrementGap="100">
       <analyzer>
         <tokenizer class="solr.UAX29URLEmailTokenizerFactory"/>
         <filter class="solr.TypeAsSynonymFilterFactory" prefix="_type_" synFlagsMask="5" ignore="foo,bar"/>
       </analyzer>
     </fieldType>

    If the optional prefix parameter is used, the specified value will be prepended to the type, e.g. with prefix="_type_", for a token "example.com" with type "<URL>", the emitted synonym will have text "_type_<URL>". If the optional synFlagsMask is used then the flags on the synonym will be set to synFlagsMask & tokenFlags. The example above transfers only the lowest and third lowest bits. If no mask is set then all flags are transferred. The ignore parameter can be used to avoid creating synonyms for some types.

    Since:
    7.3.0
    • Field Detail

      • prefix

        private final java.lang.String prefix
      • ignore

        private final java.util.Set<java.lang.String> ignore
      • synFlagMask

        private final int synFlagMask
    • Constructor Detail

      • TypeAsSynonymFilterFactory

        public TypeAsSynonymFilterFactory​(java.util.Map<java.lang.String,​java.lang.String> args)
      • TypeAsSynonymFilterFactory

        public TypeAsSynonymFilterFactory()
        Default ctor for compatibility with SPI