KeywordAttribute (Lucene 3.6.2 API)
Keywords: org.apache.lucene.analysis.tokenattributes.KeywordAttribute interface

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.lucene.analysis.tokenattributes
Interface KeywordAttribute

All Superinterfaces:
  Attribute

All Known Implementing Classes:
  KeywordAttributeImpl

    public interface KeywordAttribute

extends Attribute

This attribute can be used to mark a token as a keyword. Keyword aware `TokenStream`s can decide to modify a token based on the return value of `isKeyword()` if the token is modified. Stemming filters for instance can use this attribute to conditionally skip a term if `isKeyword()` returns `true`.

Method Summary
`boolean` | `isKeyword()` Returns `true` iff the current token is a keyword, otherwise `false`/
`void` | `setKeyword(boolean isKeyword)` Marks the current token as keyword iff set to `true`.

Method Detail

### isKeyword

    boolean isKeyword()

  Returns `true` iff the current token is a keyword, otherwise `false`/

  Returns:
    `true` iff the current token is a keyword, otherwise `false`/

### setKeyword

    void setKeyword(boolean isKeyword)

  Marks the current token as keyword iff set to `true`.

  Parameters:
    `isKeyword` - `true` iff the current token is a keyword, otherwise `false`.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD