/*
 * 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.analysis.tokenattributes;

import org.apache.lucene.util.Attribute;

/**
 * This attribute tracks what sentence a given token belongs to as well as potentially other
 * sentence specific attributes.
 */
public interface SentenceAttribute extends Attribute {

  /**
   * Get the sentence index for the current token
   *
   * @return The index of the sentence
   * @see #getSentenceIndex()
   */
  int getSentenceIndex();

  /**
   * Set the sentence of the current token
   *
   * @see #setSentenceIndex(int sentenceIndex)
   */
  void setSentenceIndex(int sentenceIndex);
}
