001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2007-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.referencing;
033    
034    import org.opengis.annotation.UML;
035    import org.opengis.metadata.Identifier;
036    
037    import static org.opengis.annotation.Obligation.*;
038    import static org.opengis.annotation.Specification.*;
039    
040    
041    /**
042     * Identifier used for reference systems.
043     *
044     * @author  Ely Conn (Leica Geosystems Geospatial Imaging, LLC)
045     * @version 3.0
046     * @since   2.1
047     */
048    @UML(identifier="RS_Identifier", specification=ISO_19115)
049    public interface ReferenceIdentifier extends Identifier {
050        /**
051         * Key for the <code>{@value}</code> property to be given to the
052         * {@linkplain org.opengis.referencing.ObjectFactory CRS factory} <code>createFoo(&hellip;)</code>
053         * methods. This is used for setting the value to be returned by {@link #getCodeSpace()}.
054         *
055         * @see #getCodeSpace()
056         */
057        String CODESPACE_KEY = "codespace";
058    
059        /**
060         * Key for the <code>{@value}</code> property to be given to the
061         * {@linkplain org.opengis.referencing.ObjectFactory CRS factory} <code>createFoo(&hellip;)</code>
062         * methods. This is used for setting the value to be returned by {@link #getVersion()}.
063         *
064         * @see #getVersion()
065         */
066        String VERSION_KEY = "version";
067    
068        /**
069         * Name or identifier of the person or organization responsible for namespace.
070         *
071         * @return The identifier code space.
072         */
073        @UML(identifier="codeSpace", obligation=OPTIONAL, specification=ISO_19115)
074        String getCodeSpace();
075    
076        /**
077         * Version identifier for the namespace, as specified by the code authority.
078         * When appropriate, the edition is identified by the effective date, coded
079         * using ISO 8601 date format.
080         *
081         * @return The version for the namespace (for example the version of the
082         *         underlying EPSG database).
083         */
084        @UML(identifier="version", obligation=OPTIONAL, specification=ISO_19115)
085        String getVersion();
086    }