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

import opennlp.tools.util.SequenceValidator;

/**
 * The default name finder {@link SequenceValidator} implementation.
 * Created by the {@link BioCodec}.
 *
 * @see TokenNameFinder
 * @see BioCodec
 */
public class NameFinderSequenceValidator implements SequenceValidator<String> {

  @Override
  public boolean validSequence(int i, String[] inputSequence,
      String[] outcomesSequence, String outcome) {

    // outcome is formatted like "cont" or "sometype-cont", so we
    // can check if it ends with "cont".
    if (outcome.endsWith(BioCodec.CONTINUE)) {

      int li = outcomesSequence.length - 1;

      if (li == -1) {
        return false;
      } else if (outcomesSequence[li].endsWith(BioCodec.OTHER)) {
        return false;
      } else if (outcomesSequence[li].endsWith(BioCodec.CONTINUE) ||
          outcomesSequence[li].endsWith(BioCodec.START)) {
        // if it is continue or start, we have to check if previous match was of the same type
        String previousNameType = NameFinderME.extractNameType(outcomesSequence[li]);
        String nameType = NameFinderME.extractNameType(outcome);
        if (previousNameType != null || nameType != null ) {
          if (nameType != null ) {
            return nameType.equals(previousNameType);
          }
          return false; // outcomes types are not equal
        }
      }
    }
    return true;
  }
}
