lucene/suggest/src/java/org/apache/lucene/search/suggest/document/CompletionTokenStream.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.lucene.search.suggest.document;

import java.io.IOException;
import org.apache.lucene.analysis.TokenFilter;
import org.apache.lucene.analysis.TokenStream;
import org.apache.lucene.analysis.miscellaneous.ConcatenateGraphFilter;
import org.apache.lucene.analysis.tokenattributes.PayloadAttribute;
import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.automaton.Automaton;

/**
 * A {@link ConcatenateGraphFilter} but we can set the payload and provide access to config options.
 *
 * @lucene.experimental
 */
public final class CompletionTokenStream extends TokenFilter {

  private final PayloadAttribute payloadAttr = addAttribute(PayloadAttribute.class);

  // package accessible on purpose
  final TokenStream inputTokenStream;
  final boolean preserveSep;
  final boolean preservePositionIncrements;
  final int maxGraphExpansions;

  private BytesRef
      payload; // note doesn't participate in TokenStream lifecycle; it's effectively constant

  CompletionTokenStream(TokenStream inputTokenStream) {
    this(
        inputTokenStream,
        ConcatenateGraphFilter.DEFAULT_PRESERVE_SEP,
        ConcatenateGraphFilter.DEFAULT_PRESERVE_POSITION_INCREMENTS,
        ConcatenateGraphFilter.DEFAULT_MAX_GRAPH_EXPANSIONS);
  }

  CompletionTokenStream(
      TokenStream inputTokenStream,
      boolean preserveSep,
      boolean preservePositionIncrements,
      int maxGraphExpansions) {
    super(
        new ConcatenateGraphFilter(
            inputTokenStream, preserveSep, preservePositionIncrements, maxGraphExpansions));
    this.inputTokenStream = inputTokenStream;
    this.preserveSep = preserveSep;
    this.preservePositionIncrements = preservePositionIncrements;
    this.maxGraphExpansions = maxGraphExpansions;
  }

  /** Sets a payload available throughout successive token stream enumeration */
  public void setPayload(BytesRef payload) {
    this.payload = payload;
  }

  @Override
  public boolean incrementToken() throws IOException {
    if (input.incrementToken()) {
      payloadAttr.setPayload(payload);
      return true;
    } else {
      return false;
    }
  }

  /**
   * Delegates to...At
   *
   * @see ConcatenateGraphFilter#toAutomaton()
   */
  public Automaton toAutomaton() throws IOException {
    return ((ConcatenateGraphFilter) input).toAutomaton();
  }

  /**
   * Delegates to...
   *
   * @see ConcatenateGraphFilter#toAutomaton(boolean)
   */
  public Automaton toAutomaton(boolean unicodeAware) throws IOException {
    return ((ConcatenateGraphFilter) input).toAutomaton(unicodeAware);
  }
}