001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2004-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.metadata;
033    
034    import org.opengis.metadata.citation.Citation;
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     * Value uniquely identifying an object within a namespace.
043     *
044     * @author  Martin Desruisseaux (IRD)
045     * @version 3.0
046     * @since   2.0
047     *
048     * @navassoc 1 - - Citation
049     */
050    @UML(identifier="MD_Identifier", specification=ISO_19115)
051    public interface Identifier {
052        /**
053         * Key for the <code>{@value}</code> property to be given to the
054         * {@linkplain org.opengis.referencing.ObjectFactory CRS factory} <code>createFoo(&hellip;)</code>
055         * methods. This is used for setting the value to be returned by {@link #getCode()}.
056         *
057         * @see #getCode()
058         */
059        String CODE_KEY = "code";
060    
061        /**
062         * Key for the <code>{@value}</code> property to be given to the
063         * {@linkplain org.opengis.referencing.ObjectFactory CRS factory} <code>createFoo(&hellip;)</code>
064         * methods. This is used for setting the value to be returned by {@link #getAuthority()}.
065         *
066         * @see #getAuthority()
067         */
068        String AUTHORITY_KEY = "authority";
069    
070        /**
071         * Alphanumeric value identifying an instance in the namespace.
072         *
073         * @return Value identifying an instance in the namespace.
074         */
075        @UML(identifier="code", obligation=MANDATORY, specification=ISO_19115)
076        String getCode();
077    
078        /**
079         * Organization or party responsible for definition and maintenance of the
080         * {@linkplain #getCode() code}.
081         *
082         * @return Party responsible for definition and maintenance of the code.
083         */
084        @UML(identifier="authority", obligation=OPTIONAL, specification=ISO_19115)
085        Citation getAuthority();
086    }