001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2006-2012 Open Geospatial Consortium, Inc.
006     *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007     *
008     *    Permission to use, copy, and modify this software and its documentation, with
009     *    or without modification, for any purpose and without fee or royalty is hereby
010     *    granted, provided that you include the following on ALL copies of the software
011     *    and documentation or portions thereof, including modifications, that you make:
012     *
013     *    1. The full text of this NOTICE in a location viewable to users of the
014     *       redistributed or derivative work.
015     *    2. Notice of any changes or modifications to the OGC files, including the
016     *       date changes were made.
017     *
018     *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019     *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020     *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021     *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022     *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023     *
024     *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025     *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026     *
027     *    The name and trademarks of copyright holders may NOT be used in advertising or
028     *    publicity pertaining to the software without specific, written prior permission.
029     *    Title to copyright in this software and any associated documentation will at all
030     *    times remain with copyright holders.
031     */
032    package org.opengis.temporal;
033    
034    import java.util.Collection;
035    import org.opengis.util.InternationalString;
036    import org.opengis.annotation.UML;
037    
038    import static org.opengis.annotation.Obligation.*;
039    import static org.opengis.annotation.Specification.*;
040    
041    
042    /**
043     * A discrete temporal reference system that provides a
044     * basis for defining temporal position to a resolution of one day.
045     *
046     * @author Alexander Petkov
047     */
048    @UML(identifier="TM_Calendar", specification=ISO_19108)
049    public interface Calendar extends TemporalReferenceSystem {
050        /**
051         * Converts a {@linkplain CalendarDate date} in this calendar to a
052         * {@linkplain JulianDate julian date}.
053         */
054        @UML(identifier="dateTrans", obligation=MANDATORY, specification=ISO_19108)
055        JulianDate dateTrans(CalendarDate date, ClockTime time);
056    
057        /**
058         * Converts a {@linkplain JulianDate julian date} to a {@linkplain CalendarDate date}
059         * in this calendar.
060         */
061        @UML(identifier="julTrans", obligation=MANDATORY, specification=ISO_19108)
062        CalendarDate julTrans(JulianDate julian);
063    
064        /**
065         * links this calendar to the {@linkplain CalendarEra calendar eras}
066         * that it uses as a reference for dating.
067         *
068         * @todo The original version of this class returned {@code TemporalCalendarEra}, which
069         *       doesn't exists in the provided sources. I assumed that it was a typo and that
070         *       the actual class was {@link CalendarEra}.
071         */
072        @UML(identifier="Basis", specification=ISO_19108)
073        Collection<CalendarEra> getBasis();
074    
075        /**
076         * Links this calendar to the {@linkplain Clock clock} that is used for specifying
077         * temporal positions within the smallest calendar interval.
078         *
079         * @todo Method name doesn't match the UML identifier.
080         */
081        @UML(identifier="Resolution", specification=ISO_19108)
082        Clock getClock();
083    }