org.apache.lucene.analysis.standard

## Class UAX29URLEmailTokenizer

- java.lang.Object
- - org.apache.lucene.util.AttributeSource
  - - org.apache.lucene.analysis.TokenStream
    - - org.apache.lucene.analysis.Tokenizer
      - - org.apache.lucene.analysis.standard.UAX29URLEmailTokenizer

- All Implemented Interfaces:
    Closeable, AutoCloseable

      public final class UAX29URLEmailTokenizer
      extends Tokenizer

  This class implements Word Break rules from the Unicode Text Segmentation algorithm, as specified in Unicode Standard Annex #29 URLs and email addresses are also tokenized according to the relevant RFCs.

  Tokens produced are of the following types:

  - <ALPHANUM>: A sequence of alphabetic and numeric characters
  - <NUM>: A number
  - <URL>: A URL
  - <EMAIL>: An email address
  - <SOUTHEAST_ASIAN>: A sequence of characters from South and Southeast Asian languages, including Thai, Lao, Myanmar, and Khmer
  - <IDEOGRAPHIC>: A single CJKV ideographic character
  - <HIRAGANA>: A single hiragana character

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource

      `AttributeSource.State`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `ALPHANUM`
    `static int` | `EMAIL`
    `static int` | `HANGUL`
    `static int` | `HIRAGANA`
    `static int` | `IDEOGRAPHIC`
    `static int` | `KATAKANA`
    `static int` | `MAX_TOKEN_LENGTH_LIMIT` Absolute maximum sized token
    `static int` | `NUM`
    `static int` | `SOUTHEAST_ASIAN`
    `static String[]` | `TOKEN_TYPES` String token types that correspond to token type int constants
    `static int` | `URL`

    - ### Fields inherited from class org.apache.lucene.analysis.Tokenizer

      `input`

    - ### Fields inherited from class org.apache.lucene.analysis.TokenStream

      `DEFAULT_TOKEN_ATTRIBUTE_FACTORY`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `UAX29URLEmailTokenizer()` Creates a new instance of the UAX29URLEmailTokenizer.
    `UAX29URLEmailTokenizer(AttributeFactory factory)` Creates a new UAX29URLEmailTokenizer with a given `AttributeFactory`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `close()`
    `void` | `end()`
    `int` | `getMaxTokenLength()`
    `boolean` | `incrementToken()`
    `void` | `reset()`
    `void` | `setMaxTokenLength(int length)` Set the max allowed token length.

    - ### Methods inherited from class org.apache.lucene.analysis.Tokenizer

      `correctOffset, setReader`

    - ### Methods inherited from class org.apache.lucene.util.AttributeSource

      `addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString`

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

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### ALPHANUM

          public static final int ALPHANUM

      See Also:
        Constant Field Values

    - #### NUM

          public static final int NUM

      See Also:
        Constant Field Values

    - #### SOUTHEAST_ASIAN

          public static final int SOUTHEAST_ASIAN

      See Also:
        Constant Field Values

    - #### IDEOGRAPHIC

          public static final int IDEOGRAPHIC

      See Also:
        Constant Field Values

    - #### HIRAGANA

          public static final int HIRAGANA

      See Also:
        Constant Field Values

    - #### KATAKANA

          public static final int KATAKANA

      See Also:
        Constant Field Values

    - #### HANGUL

          public static final int HANGUL

      See Also:
        Constant Field Values

    - #### URL

          public static final int URL

      See Also:
        Constant Field Values

    - #### EMAIL

          public static final int EMAIL

      See Also:
        Constant Field Values

    - #### TOKEN_TYPES

          public static final String[] TOKEN_TYPES

      String token types that correspond to token type int constants

    - #### MAX_TOKEN_LENGTH_LIMIT

          public static final int MAX_TOKEN_LENGTH_LIMIT

      Absolute maximum sized token
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### UAX29URLEmailTokenizer

          public UAX29URLEmailTokenizer()

      Creates a new instance of the UAX29URLEmailTokenizer. Attaches the `input` to the newly created JFlex scanner.

    - #### UAX29URLEmailTokenizer

          public UAX29URLEmailTokenizer(AttributeFactory factory)

      Creates a new UAX29URLEmailTokenizer with a given `AttributeFactory`

  - ### Method Detail

    - #### setMaxTokenLength

          public void setMaxTokenLength(int length)

      Set the max allowed token length. Tokens larger than this will be chopped up at this token length and emitted as multiple tokens. If you need to skip such large tokens, you could increase this max length, and then use `LengthFilter` to remove long tokens. The default is `UAX29URLEmailAnalyzer.DEFAULT_MAX_TOKEN_LENGTH`.
      Throws:
        `IllegalArgumentException` - if the given length is outside of the range [1, 1048576].

    - #### getMaxTokenLength

          public int getMaxTokenLength()

      See Also:
        `setMaxTokenLength(int)`

    - #### incrementToken

          public final boolean incrementToken()
                                       throws IOException

      Specified by:
        `incrementToken` in class `TokenStream`
      Throws:
        `IOException`

    - #### end

          public final void end()
                         throws IOException

      Overrides:
        `end` in class `TokenStream`
      Throws:
        `IOException`

    - #### close

          public void close()
                     throws IOException

      Specified by:
        `close` in interface `Closeable`
      Specified by:
        `close` in interface `AutoCloseable`
      Overrides:
        `close` in class `Tokenizer`
      Throws:
        `IOException`

    - #### reset

          public void reset()
                     throws IOException

      Overrides:
        `reset` in class `Tokenizer`
      Throws:
        `IOException`

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