org.apache.lucene.analysis.custom

## Class CustomAnalyzer.ConditionBuilder

- java.lang.Object
- - org.apache.lucene.analysis.custom.CustomAnalyzer.ConditionBuilder

- Enclosing class:
    CustomAnalyzer

      public static class CustomAnalyzer.ConditionBuilder
      extends Object

  Factory class for a `ConditionalTokenFilter`

- - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `CustomAnalyzer.ConditionBuilder` | `addTokenFilter(Class<? extends TokenFilterFactory> factory, Map<String,String> params)` Adds the given token filter.
    `CustomAnalyzer.ConditionBuilder` | `addTokenFilter(Class<? extends TokenFilterFactory> factory, String... params)` Adds the given token filter.
    `CustomAnalyzer.ConditionBuilder` | `addTokenFilter(String name, Map<String,String> params)` Adds the given token filter.
    `CustomAnalyzer.ConditionBuilder` | `addTokenFilter(String name, String... params)` Adds the given token filter.
    `CustomAnalyzer.Builder` | `endwhen()` Close the branch and return to the main analysis chain

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### addTokenFilter

          public CustomAnalyzer.ConditionBuilder addTokenFilter(String name,
                                                                Map<String,String> params)
                                                         throws IOException

      Adds the given token filter.
      Parameters:
        `name` - is used to look up the factory with `TokenFilterFactory.forName(String, Map)`. The list of possible names can be looked up with `TokenFilterFactory.availableTokenFilters()`.
        `params` - the map of parameters to be passed to factory. The map must be modifiable.
      Throws:
        `IOException`

    - #### addTokenFilter

          public CustomAnalyzer.ConditionBuilder addTokenFilter(String name,
                                                                String... params)
                                                         throws IOException

      Adds the given token filter.
      Parameters:
        `name` - is used to look up the factory with `TokenFilterFactory.forName(String, Map)`. The list of possible names can be looked up with `TokenFilterFactory.availableTokenFilters()`.
        `params` - the map of parameters to be passed to factory. The map must be modifiable.
      Throws:
        `IOException`

    - #### addTokenFilter

          public CustomAnalyzer.ConditionBuilder addTokenFilter(Class<? extends TokenFilterFactory> factory,
                                                                Map<String,String> params)
                                                         throws IOException

      Adds the given token filter.
      Parameters:
        `factory` - class that is used to create the token filter.
        `params` - the map of parameters to be passed to factory. The map must be modifiable.
      Throws:
        `IOException`

    - #### addTokenFilter

          public CustomAnalyzer.ConditionBuilder addTokenFilter(Class<? extends TokenFilterFactory> factory,
                                                                String... params)
                                                         throws IOException

      Adds the given token filter.
      Parameters:
        `factory` - class that is used to create the token filter.
        `params` - the map of parameters to be passed to factory. The map must be modifiable.
      Throws:
        `IOException`

    - #### endwhen

          public CustomAnalyzer.Builder endwhen()
                                         throws IOException

      Close the branch and return to the main analysis chain
      Throws:
        `IOException`

Copyright © 2000-2024 Apache Software Foundation. All Rights Reserved.