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 java.util.Collection;
036 import java.util.Date;
037 import org.opengis.annotation.UML;
038
039 import static org.opengis.annotation.Obligation.*;
040 import static org.opengis.annotation.Specification.*;
041
042
043 /**
044 * A temporal coordinate system to simplify the computation of temporal distances
045 * between points and the functional description of temporal operations.
046 *
047 * @author Stephane Fellah (Image Matters)
048 * @author Alexander Petkov
049 *
050 * @todo Retrofit in {@link org.opengis.referencing.cs.TimeCS}.
051 */
052 @UML(identifier="TM_CoordinateSystem", specification=ISO_19108)
053 public interface TemporalCoordinateSystem extends TemporalReferenceSystem {
054 /**
055 * Position of the origin of the scale on which the temporal coordinate system is based
056 * expressed as a date in the Gregorian calendar and time of day in UTC.
057 */
058 @UML(identifier="origin", obligation=MANDATORY, specification=ISO_19108)
059 Date getOrigin();
060
061 /**
062 * Identifies the base interval for this temporal coordinate system
063 * as a unit of measure specified by ISO 31-1,
064 * or a multiple of one of those units, as specified by ISO 1000.
065 */
066 @UML(identifier="interval", obligation=MANDATORY, specification=ISO_19108)
067 InternationalString getInterval();
068
069 /**
070 * Transforms a value of a {@linkplain TemporalCoordinate coordinate} within this
071 * temporal coordinate system and returns the equivalent {@linkplain DateAndTime date
072 * and time} in the Gregorian Calendar and UTC
073 */
074 @UML(identifier="transformCoord", obligation=MANDATORY, specification=ISO_19108)
075 Date transformCoord(TemporalCoordinate coordinates);
076
077 /**
078 * Transforms a {@linkplain DateAndTime date and time} in the Gregorian Calendar and UTC
079 * to an equivalent {@linkplain TemporalCoordinate coordinate} within this temporal
080 * coordinate system.
081 */
082 @UML(identifier="transformDateTime", obligation=MANDATORY, specification=ISO_19108)
083 TemporalCoordinate transformDateTime(Date datetime);
084 }