ITimeLine.java

/*
 * Copyright 2011-2013 the original author or authors.
 *
 * 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 kr.debop4j.timeperiod;

import java.io.Serializable;

/**
 * TimePeriod의 컬렉션을 가지며, 이를 통해 여러 기간에 대한 Union, Intersection, Gap 등을 구할 수 있도록 합니다.
 *
 * @author 배성혁 sunghyouk.bae@gmail.com
 * @since 13. 5. 11. 오후 6:06
 */
public interface ITimeLine extends Serializable {

    /**
     * Gets periods.
     *
     * @return the periods
     */
    ITimePeriodContainer getPeriods();

    /**
     * Gets limits.
     *
     * @return the limits
     */
    ITimePeriod getLimits();

    /**
     * Gets period mapper.
     *
     * @return the period mapper
     */
    ITimePeriodMapper getPeriodMapper();

    /** 기간들의 합집합을 구합니다. */
    ITimePeriodCollection combinePeriods();

    /** 기간들의 교집합을 구합니다. */
    ITimePeriodCollection intersectPeriods();

    /** 기간들의 여집합을 구합니다. */
    ITimePeriodCollection calculateGaps();
}