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 org.opengis.util.InternationalString;
035    import org.opengis.annotation.UML;
036    
037    import static org.opengis.annotation.Obligation.*;
038    import static org.opengis.annotation.Specification.*;
039    
040    
041    /**
042     * Characteristics of each calendar era.
043     *
044     * @author Stephane Fellah (Image Matters)
045     * @author Alexander Petkov
046     */
047    @UML(identifier="TM_CalendarEra", specification=ISO_19108)
048    public interface CalendarEra {
049        /**
050         * Uniquely identifies the calendar era within this calendar.
051         */
052        @UML(identifier="name", obligation=MANDATORY, specification=ISO_19108)
053        InternationalString getName();
054    
055        /**
056         * Provides the name or description of a mythical or historic event which fixes the position
057         * of the base scale of the calendar era.
058         */
059        @UML(identifier="referenceEvent", obligation=OPTIONAL, specification=ISO_19108)
060        InternationalString getReferenceEvent();
061    
062        /**
063         * Provides the date of the reference event expressed as a date in the given calendar.
064         */
065        @UML(identifier="referenceDate", obligation=OPTIONAL, specification=ISO_19108)
066        CalendarDate getReferenceDate();
067    
068        /**
069         * Provides the {@linkplain JulianDate julian date} that corresponds to the reference date.
070         */
071        @UML(identifier="julianReference", specification=ISO_19108)
072        JulianDate getJulianReference();
073    
074        /**
075         * Identifies the {@linkplain Period period} for which the calendar era
076         * was used as a reference fro dating.
077         *
078         *
079         * @return The period, where the data type for {@linkplain Period#getBegin begin}
080         *         and {@link Period#getEnd end} is {@link JulianDate}.
081         */
082        @UML(identifier="epochOfUse", specification=ISO_19108)
083        Period getEpochOfUse();
084    }