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.metadata.Identifier;
035 import org.opengis.metadata.extent.Extent;
036 import org.opengis.referencing.ReferenceIdentifier;
037 import org.opengis.referencing.ReferenceSystem;
038 import org.opengis.annotation.UML;
039
040 import static org.opengis.annotation.Obligation.*;
041 import static org.opengis.annotation.Specification.*;
042
043
044 /**
045 * Provides information about a temporal reference system.
046 * <p>
047 * This interface is similar to ReferenceSytem and may be deprecated
048 * in the future. It is made available currently in order to *exactly*
049 * match this ISO 19108 specification with a "domain of validity"
050 * association to an Extent.
051 * </p>
052 * @author Stephane Fellah (Image Matters)
053 * @author Alexander Petkov
054 */
055 @UML(identifier="TM_ReferenceSystem", specification=ISO_19108)
056 public interface TemporalReferenceSystem extends ReferenceSystem {
057 /**
058 * Provides a name that uniquely identifies the temporal referece system.
059 *
060 * Currently returns MD_Identifier, which is defined in ISO 19115, while ISO 19108
061 * requires that RS_Identifier (defined in ISO 19111 and http://www.opengis.org/docs/03-073r1.zip)
062 * is returned. From the looks of it, org.opengis.referencing.ReferenceSystem could also fit the bill.
063 *
064 * @return {@link ReferenceIdentifier} for the temporal reference system
065 */
066 @UML(identifier="name", obligation=MANDATORY, specification=ISO_19108)
067 ReferenceIdentifier getName();
068
069 /**
070 * Identifies the space and time within which the reference system is applicable.
071 * The return type allows for describing both spatial and temporal extent.
072 * This attribute shall be used whenever an application schema includes
073 * {@link TemporalPosition}s referenced to a reference system which has a valid extent
074 * that is less than the extent of a data set containing such values.
075 * <p>
076 * Please note this is very similar to ReferenceSystem.getValidArea() from ISO 19115.
077 */
078 @UML(identifier="DomainOfValidity", obligation=MANDATORY, specification=ISO_19108)
079 Extent getDomainOfValidity();
080 }