trunk/ruta-ep-textruler/src/main/java/org/apache/uima/ruta/textruler/core/TextRulerRuleItem.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.uima.ruta.textruler.core;

/**
 * 
 * Every rule pattern (TextRulerRulePattern) consists of items. Those have to implement the
 * interface TextRulerRuleItem.
 * 
 *         hint: maybe we should change this to an abstract class instead of an interface ?!
 */
public interface TextRulerRuleItem {

  public enum MLRuleItemType {
    PREFILLER, FILLER, POSTFILLER
  };

  public String getStringForRuleString(TextRulerRule rule, MLRuleItemType type,
          int numberInPattern, int patternSize, int numberInRule, int ruleSize, int slotIndex);

  public boolean equals(TextRulerRuleItem o);

  public TextRulerRuleItem copy();

  public String toString();

  public int hashCode();

}