Annotation.java

/*
 * Copyright 2007  T-Rank AS
 * 
 * Licensed 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 no.trank.openpipe.api.document;

/**
 * An interface that represents an annotation of a field-value.
 * <p/>
 * This <tt>Annotation</tt> annotates {@link AnnotatedField#getValue()}<tt>.substring(getStartPos(), getEndPos())</tt>.  
 * 
 * @version $Revision$
 */
public interface Annotation {

   /**
    * Gets the start index in the field-value.
    * 
    * @return the start index in the field-value.
    */
   int getStartPos();

   /**
    * Gets the end index (exclusive) in the field-value.
    * 
    * @return the end index (exclusive) in the field-value.
    */
   int getEndPos();
}