001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2006-2013 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 data type that shall be used to identify temporal position within a calendar.
044     *
045     * @author Stephane Fellah (Image Matters)
046     * @author Alexander Petkov
047     */
048    @UML(identifier="TM_CalDate", specification=ISO_19108)
049    public interface CalendarDate extends TemporalPosition {
050        /**
051         * Provides the name of the {@linkplain CalendarEra calendar era}
052         * to which the date is referenced.
053         *
054         * @return The name of the calendar era.
055         */
056        @UML(identifier="calendarEraName", obligation=MANDATORY, specification=ISO_19108)
057        InternationalString getCalendarEraName();
058    
059        /**
060         * Provides a sequence of integers in which the first integer identifies a specific instance
061         * of the unit used at the highest level of the calendar hierarchy, the second integer
062         * identifies a specific instance of the unit used at the next lower level in the hierarchy,
063         * and so on. The format defined in ISO 8601 for dates in the Gregorian calendar may be
064         * used for any date that is composed of values for year, month and day.
065         *
066         * @return Instance of the units, from highest level to lowest level of the calendar hierarchy.
067         */
068        @UML(identifier="calDate", obligation=MANDATORY, specification=ISO_19108)
069        int[] getCalendarDate();
070    }