Uploaded image for project: 'Lucene - Core'
  1. Lucene - Core
  2. LUCENE-4786

Out of date API document-SinkTokenizer

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 4.1
    • Fix Version/s: None
    • Component/s: modules/analysis
    • Labels:
      None
    • Lucene Fields:
      New

      Description

      The following API document talks about SinkTokenizer:
      http://lucene.apache.org/core/4_1_0/analyzers-common/org/apache/lucene/analysis/sinks/package-summary.html

      However, SinkTokenizer is deleted and replaced by TeeSinkTokenFilter in lucene 4.1, according to the change log:
      http://lucene.apache.org/core/4_1_0/changes/Changes.html

      LUCENE-1422, LUCENE-1693: New TokenStream API that uses a new class called AttributeSource instead of the Token class, which is now a utility class that holds common Token attributes. All attributes that the Token class had have been moved into separate classes: TermAttribute, OffsetAttribute, PositionIncrementAttribute, PayloadAttribute, TypeAttribute and FlagsAttribute. The new API is much more flexible; it allows to combine the Attributes arbitrarily and also to define custom Attributes. The new API has the same performance as the old next(Token) approach. For conformance with this new API Tee-/SinkTokenizer was deprecated and replaced by a new TeeSinkTokenFilter.

      Please update the API documents to reflect the latest code.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              drzhonghao Hao Zhong
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: