Field Detail

• DEFAULT_SIDE

  public static final EdgeNGramTokenizer.Side DEFAULT_SIDE

• DEFAULT_MAX_GRAM_SIZE

  public static final int DEFAULT_MAX_GRAM_SIZE

  See Also:

  Constant Field Values

• DEFAULT_MIN_GRAM_SIZE

  public static final int DEFAULT_MIN_GRAM_SIZE

  See Also:

  Constant Field Values

Constructor Detail

• EdgeNGramTokenizer

  public EdgeNGramTokenizer(java.io.Reader input,
                            EdgeNGramTokenizer.Side side,
                            int minGram,
                            int maxGram)

  Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range

  Parameters:

  input - Reader holding the input to be tokenized

  side - the EdgeNGramTokenizer.Side from which to chop off an n-gram

  minGram - the smallest n-gram to generate

  maxGram - the largest n-gram to generate

• EdgeNGramTokenizer

  public EdgeNGramTokenizer(AttributeSource source,
                            java.io.Reader input,
                            EdgeNGramTokenizer.Side side,
                            int minGram,
                            int maxGram)

  Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range

  Parameters:

  source - AttributeSource to use

  input - Reader holding the input to be tokenized

  side - the EdgeNGramTokenizer.Side from which to chop off an n-gram

  minGram - the smallest n-gram to generate

  maxGram - the largest n-gram to generate

• EdgeNGramTokenizer

  public EdgeNGramTokenizer(AttributeSource.AttributeFactory factory,
                            java.io.Reader input,
                            EdgeNGramTokenizer.Side side,
                            int minGram,
                            int maxGram)

  Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range

  Parameters:

  factory - AttributeSource.AttributeFactory to use

  input - Reader holding the input to be tokenized

  side - the EdgeNGramTokenizer.Side from which to chop off an n-gram

  minGram - the smallest n-gram to generate

  maxGram - the largest n-gram to generate

• EdgeNGramTokenizer

  public EdgeNGramTokenizer(java.io.Reader input,
                            java.lang.String sideLabel,
                            int minGram,
                            int maxGram)

  Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range

  Parameters:

  input - Reader holding the input to be tokenized

  sideLabel - the name of the EdgeNGramTokenizer.Side from which to chop off an n-gram

  minGram - the smallest n-gram to generate

  maxGram - the largest n-gram to generate

• EdgeNGramTokenizer

  public EdgeNGramTokenizer(AttributeSource source,
                            java.io.Reader input,
                            java.lang.String sideLabel,
                            int minGram,
                            int maxGram)

  Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range

  Parameters:

  source - AttributeSource to use

  input - Reader holding the input to be tokenized

  sideLabel - the name of the EdgeNGramTokenizer.Side from which to chop off an n-gram

  minGram - the smallest n-gram to generate

  maxGram - the largest n-gram to generate

• EdgeNGramTokenizer

  public EdgeNGramTokenizer(AttributeSource.AttributeFactory factory,
                            java.io.Reader input,
                            java.lang.String sideLabel,
                            int minGram,
                            int maxGram)

  Creates EdgeNGramTokenizer that can generate n-grams in the sizes of the given range

  Parameters:

  factory - AttributeSource.AttributeFactory to use

  input - Reader holding the input to be tokenized

  sideLabel - the name of the EdgeNGramTokenizer.Side from which to chop off an n-gram

  minGram - the smallest n-gram to generate

  maxGram - the largest n-gram to generate

Method Detail

• incrementToken

  public final boolean incrementToken()
                               throws java.io.IOException

  Returns the next token in the stream, or null at EOS.

  Overrides:

  incrementToken in class TokenStream

  Returns:

  false for end of stream; true otherwise

  Note that this method will be defined abstract in Lucene 3.0.

  Throws:

  java.io.IOException

• end

  public final void end()

  Description copied from class: TokenStream
  This method is called by the consumer after the last token has been consumed, after TokenStream.incrementToken() returned false (using the new TokenStream API). Streams implementing the old API should upgrade to use this feature.

  This method can be used to perform any end-of-stream operations, such as setting the final offset of a stream. The final offset of a stream might differ from the offset of the last token eg in case one or more whitespaces followed after the last token, but a WhitespaceTokenizer was used.

  Overrides:

  end in class TokenStream

• next

  public final Token next(Token reusableToken)
                   throws java.io.IOException

  Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
  Description copied from class: TokenStream
  Returns the next token in the stream, or null at EOS. When possible, the input Token should be used as the returned Token (this gives fastest tokenization performance), but this is not required and a new Token may be returned. Callers may re-use a single Token instance for successive calls to this method.

  This implicitly defines a "contract" between consumers (callers of this method) and producers (implementations of this method that are the source for tokens):

  • A consumer must fully consume the previously returned Token before calling this method again.
  • A producer must call Token.clear() before setting the fields in it and returning it

  Also, the producer must make no assumptions about a Token after it has been returned: the caller may arbitrarily change it. If the producer needs to hold onto the Token for subsequent calls, it must clone() it before storing it. Note that a TokenFilter is considered a consumer.

  Overrides:

  next in class TokenStream

  Parameters:

  reusableToken - a Token that may or may not be used to return; this parameter should never be null (the callee is not required to check for null before using it, but it is a good idea to assert that it is not null.)

  Returns:

  next Token in the stream or null if end-of-stream was hit

  Throws:

  java.io.IOException

• next

  public final Token next()
                   throws java.io.IOException

  Deprecated. Will be removed in Lucene 3.0. This method is final, as it should not be overridden. Delegates to the backwards compatibility layer.
  Description copied from class: TokenStream
  Returns the next Token in the stream, or null at EOS.

  Overrides:

  next in class TokenStream

  Throws:

  java.io.IOException

• reset

  public void reset(java.io.Reader input)
             throws java.io.IOException

  Description copied from class: Tokenizer
  Expert: Reset the tokenizer to a new reader. Typically, an analyzer (in its reusableTokenStream method) will use this to re-use a previously created tokenizer.

  Overrides:

  reset in class Tokenizer

  Throws:

  java.io.IOException

• reset

  public void reset()
             throws java.io.IOException

  Description copied from class: TokenStream
  Resets this stream to the beginning. This is an optional operation, so subclasses may or may not implement this method. TokenStream.reset() is not needed for the standard indexing process. However, if the tokens of a TokenStream are intended to be consumed more than once, it is necessary to implement TokenStream.reset(). Note that if your TokenStream caches tokens and feeds them back again after a reset, it is imperative that you clone the tokens when you store them away (on the first pass) as well as when you return them (on future passes after TokenStream.reset()).

  Overrides:

  reset in class TokenStream

  Throws:

  java.io.IOException