opennlp-tools/src/main/java/opennlp/tools/sentdetect/SDContextGenerator.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 opennlp.tools.sentdetect;


/**
 * Interface for {@link SentenceDetectorME} context generators.
 */
public interface SDContextGenerator {

  /**
   * Returns an array of contextual features for the potential sentence boundary at the
   * specified position within the specified string buffer.
   *
   * @param s The {@link String} for which sentences are being determined.
   * @param position An index into the specified string buffer when a sentence boundary may occur.
   *
   * @return an array of contextual features for the potential sentence boundary at the
   * specified position within the specified string buffer.
   */
  public abstract String[] getContext(CharSequence s, int position);
}