/*
 * 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 opennlp.tools.postag;

import opennlp.tools.util.Sequence;

/**
 * The interface for part of speech taggers.
 */
public interface POSTagger {

  /**
   * Assigns the sentence of tokens pos tags.
   *
   * @param sentence The sentence of tokens to be tagged.
   * @return An array of pos tags for each token provided in {@code sentence}.
   */
  String[] tag(String[] sentence);

  /**
   * Assigns the sentence of tokens pos tags.
   *
   * @param sentence The sentence of tokens to be tagged.
   * @param additionalContext The context to provide additional information with.
   *
   * @return An array of pos tags for each token provided in {@code sentence}.
   */
  String[] tag(String[] sentence, Object[] additionalContext);

  /**
   * Assigns the sentence the top-k {@link Sequence sequences}.
   *
   * @param sentence The sentence of tokens to be tagged.
   *
   * @return An array of {@link Sequence sequences} for each token provided in {@code sentence}.
   */
  Sequence[] topKSequences(String[] sentence);

  /**
   * Assigns the sentence the top-k {@link Sequence sequences}.
   *
   * @param sentence The sentence of tokens to be tagged.
   * @param additionalContext The context to provide additional information with.
   *
   * @return An array of {@link Sequence sequences} for each token provided in {@code sentence}.
   */
  Sequence[] topKSequences(String[] sentence, Object[] additionalContext);
}
