TimePeriod.java

/**
 * Copyright (C) 2012 52°North Initiative for Geospatial Open Source Software GmbH
 *
 * 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 org.n52.oxf.valueDomains.time;

/**
 * Represents a TimePeriod specified in OGC WCS spec 1.0.0 and consists of the TimePositions start and end and
 * the TimeResolution resolution.
 * 
 * Valid example time period strings: <li>1998-11-01/2005-11-02</li> <li>
 * 1998-11-01/2005-11-02/P1Y</li>
 * 
 * @author <a href="mailto:broering@52north.org">Arne Broering</a>
 */
public class TimePeriod implements ITimePeriod {

    public static String PERIOD_PATTERN_WITH_RESOLUTION = ".+/.+/.+";
    public static String PERIOD_PATTERN = ".+/.+";
    private ITimePosition start;
    private ITimePosition end;
    private ITimeResolution resolution;

    /**
     * constructs a TimePeriod without a resolution. The default resolution has to be set explicitly.
     */
    public TimePeriod(String begin, String end) {
        this.start = new TimePosition(begin);
        this.end = new TimePosition(end);
    }

    /**
     * 
     * @param currentStart
     * @param currentEnd
     * @param currentResolution
     */
    public TimePeriod(ITimePosition currentStart, ITimePosition currentEnd, ITimeResolution currentResolution) {
        this.start = currentStart;
        this.end = currentEnd;
        this.resolution = currentResolution;
    }

    /**
     * 
     * @param period
     */
    public TimePeriod(String period) {
        if (period == null) {
            throw new NullPointerException();
        }
        if (period.matches(PERIOD_PATTERN_WITH_RESOLUTION)) {
            String[] periodParts = period.split("/");
            start = new TimePosition(periodParts[0]);
            end = new TimePosition(periodParts[1]);
            resolution = new TimeResolution(periodParts[2]);
        }
        else if (period.matches(PERIOD_PATTERN)) {
            String[] periodParts = period.split("/");
            start = new TimePosition(periodParts[0]);
            end = new TimePosition(periodParts[1]);
        }
        else {
            throw new IllegalArgumentException("period does not match ISO compliant time pattern, received: " + period);
        }
    }

    /**
     * 
     * @param currentStart
     * @param currentEnd
     */
    public TimePeriod(ITimePosition currentStart, ITimePosition currentEnd) {
        this.start = currentStart;
        this.end = currentEnd;
    }

    @Override
    public boolean equals(Object obj) {

        if (obj instanceof ITimePeriod) {

            ITimePeriod timePeriod = (ITimePeriod) obj;

            if (timePeriod.toISO8601Format().equals(this.toISO8601Format())) {
                return true;
            }
        }
        return false;
    }

    public ITimePosition getStart() {
        return start;
    }

    public ITimePosition getEnd() {
        return end;
    }

    public ITimeResolution getResolution() {
        return resolution;
    }

    /**
     * Sets a default resolution iff the resolution has not been set yet in any other method.
     */
    public void setDefaultResolution(String resolution) {
        if (this.resolution == null) {
            this.resolution = new TimeResolution(resolution);
        }
    }

    public boolean isResolutionSet() {
        return resolution != null;
    }

    public String toISO8601Format() {
        return start.toISO8601Format() + "/" + end.toISO8601Format() + (resolution != null ? ("/" + resolution) : "");
    }

    @Override
    public String toString() {
        return "start: " + start.toString() + "  end: " + end.toString();
    }

    /**
     * proofs whether timePeriod is contained in this TimePeriod.
     */
    public boolean contains(ITimePeriod timePeriod) {
        return (start.before(timePeriod.getStart()) || start.equals(timePeriod.getStart()))
                && (end.after(timePeriod.getEnd()) || end.equals(timePeriod.getEnd()));
    }

    /**
     * proofs whether timePosition is contained in this TimePeriod.
     */
    public boolean contains(ITimePosition timePos) {
        return (start.before(timePos) || start.equals(timePos)) && (end.after(timePos) || end.equals(timePos));
    }

}