Interval.java

/*
 * Copyright 2008
 * Richard Eckart de Castilho
 * Institut für Sprach- und Literaturwissenschaft
 * Technische Universität Darmstadt
 *
 * 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 de.tudarmstadt.ukp.dkpro.core.api.transform.alignment;

import java.util.Comparator;

public interface Interval
{
    public final static Comparator<Interval> SEG_START_CMP = new Comparator<Interval>()
    {
        @Override
        public int compare(final Interval a0, final Interval a1)
        {
            final int a0s = a0.getStart();
            final int a1s = a1.getStart();

            if (a0s == a1s) {
                return a0.getEnd() - a1.getEnd();
            }
            else {
                return a0s - a1s;
            }
        }
    };

    public final static Comparator<Interval> SEG_END_CMP = new Comparator<Interval>()
    {
        @Override
        public int compare(final Interval a0, final Interval a1)
        {
            final int a0e = a0.getEnd();
            final int a1e = a1.getEnd();

            if (a0e == a1e) {
                return a0.getStart() - a1.getStart();
            }
            else {
                return a0e - a1e;
            }
        }
    };

    /**
     * Get the length of the interval.
     * 
     * @return the interval length.
     */
    int getLength();

    /**
     * Get the start of the interval.
     * 
     * @return the start offset.
     */
    int getStart();

    /**
     * Get the end of the interval.
     * 
     * @return the end offset.
     */
    int getEnd();

    /**
     * Test if the current and the given reference interval overlap.
     * 
     * @param interval
     *            the reference interval.
     * @return <code>true</code> if there is an overlap.
     */
    boolean overlaps(final Interval interval);

    boolean overlapsLeft(final Interval interval);

    /**
     * this: [ s ][e] i: ss-----ee
     * 
     * @param interval
     *            a interval.
     * @return if the given interval overlaps right with the current interval.
     */
    boolean overlapsRight(final Interval interval);

    Interval overlap(final Interval interval);

    boolean rightAligned(final Interval interval);

    boolean leftAligned(final Interval interval);

    boolean sameExtent(final Interval interval);

    boolean contains(final Interval interval);

    boolean precedes(final Interval interval);

    boolean immediatelyPrecedes(final Interval interval);

    boolean follows(final Interval interval);

    boolean immediatelyFollows(final Interval interval);

    boolean startsEarilerThan(final Interval interval);

    boolean startsLaterThan(final Interval interval);

    boolean startsSameAs(final Interval interval);

    boolean endsEarilerThan(final Interval interval);

    boolean endsLaterThan(final Interval interval);

    boolean endsSameAs(final Interval interval);
}