org.opengis.temporal.CalendarEra Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gt-opengis Show documentation

Standard interfaces implemented throughout the library.

The newest version!

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.temporal;

import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;

import org.opengis.annotation.UML;
import org.opengis.util.InternationalString;

/**
 * Characteristics of each calendar era.
 *
 * @author Stephane Fellah (Image Matters)
 * @author Alexander Petkov
 */
@UML(identifier = "TM_CalendarEra", specification = ISO_19108)
public interface CalendarEra {
    /** Uniquely identifies the calendar era within this calendar. */
    @UML(identifier = "name", obligation = MANDATORY, specification = ISO_19108)
    InternationalString getName();

    /**
     * Provides the name or description of a mythical or historic event which fixes the position of
     * the base scale of the calendar era.
     */
    @UML(identifier = "referenceEvent", obligation = OPTIONAL, specification = ISO_19108)
    InternationalString getReferenceEvent();

    /** Provides the date of the reference event expressed as a date in the given calendar. */
    @UML(identifier = "referenceDate", obligation = OPTIONAL, specification = ISO_19108)
    CalendarDate getReferenceDate();

    /** Provides the {@linkplain JulianDate julian date} that corresponds to the reference date. */
    @UML(identifier = "julianReference", specification = ISO_19108)
    JulianDate getJulianReference();

    /**
     * Identifies the {@linkplain Period period} for which the calendar era was used as a reference
     * fro dating.
     *
     * @return The period, where the data type for {@linkplain Period#getBegin begin} and {@link
     *     Period#getEnd end} is {@link JulianDate}.
     */
    @UML(identifier = "epochOfUse", specification = ISO_19108)
    Period getEpochOfUse();
}