[Missing <summary> documentation for "N:Lucene.Net.Analysis.Tokenattributes"]

Classes

  ClassDescription
Public classFlagsAttributeImpl
This attribute can be used to pass different flags down the tokenizer chain, eg from one TokenFilter to another one.
Public classOffsetAttributeImpl
The start and end character offset of a Token.
Public classPayloadAttributeImpl
The payload of a Token. See also {@link Payload}.
Public classPositionIncrementAttributeImpl
The positionIncrement determines the position of this token relative to the previous Token in a {@link TokenStream}, used in phrase searching.

The default value is one.

Some common uses for this are:

  • Set it to zero to put multiple terms in the same position. This is useful if, e.g., a word has multiple stems. Searches for phrases including either stem will match. In this case, all but the first stem's increment should be set to zero: the increment of the first instance should be one. Repeating a token with an increment of zero can also be used to boost the scores of matches on that token.
  • Set it to values greater than one to inhibit exact phrase matches. If, for example, one does not want phrases to match across removed stop words, then one could build a stop word filter that removes stop words and also sets the increment to the number of stop words removed before each non-stop word. Then exact phrase queries will only match when the terms occur with no intervening stop words.
Public classTermAttributeImpl
The term text of a Token.
Public classTypeAttributeImpl
A Token's lexical type. The Default value is "word".

Interfaces

  InterfaceDescription
Public interfaceFlagsAttribute
This attribute can be used to pass different flags down the {@link Tokenizer} chain, eg from one TokenFilter to another one.
Public interfaceOffsetAttribute
The start and end character offset of a Token.
Public interfacePayloadAttribute
The payload of a Token. See also {@link Payload}.
Public interfacePositionIncrementAttribute
The positionIncrement determines the position of this token relative to the previous Token in a TokenStream, used in phrase searching.

The default value is one.

Some common uses for this are:

  • Set it to zero to put multiple terms in the same position. This is useful if, e.g., a word has multiple stems. Searches for phrases including either stem will match. In this case, all but the first stem's increment should be set to zero: the increment of the first instance should be one. Repeating a token with an increment of zero can also be used to boost the scores of matches on that token.
  • Set it to values greater than one to inhibit exact phrase matches. If, for example, one does not want phrases to match across removed stop words, then one could build a stop word filter that removes stop words and also sets the increment to the number of stop words removed before each non-stop word. Then exact phrase queries will only match when the terms occur with no intervening stop words.
Public interfaceTermAttribute
The term text of a Token.
Public interfaceTypeAttribute
A Token's lexical type. The Default value is "word".