org.opengis.referencing.ReferenceIdentifier 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) 2003-2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.referencing;

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

import org.opengis.annotation.UML;
import org.opengis.metadata.Identifier;

/**
 * Identifier used for reference systems.
 *
 * @version ISO 19115
 * @author Ely Conn (Leica Geosystems Geospatial Imaging, LLC)
 * @since GeoAPI 2.1
 */
@UML(identifier = "RS_Identifier", specification = ISO_19115)
public interface ReferenceIdentifier extends Identifier {
    /**
     * Key for the {@value} property to be given to the {@linkplain
     * org.opengis.referencing.ObjectFactory CRS factory} createFoo(…) methods.
     * This is used for setting the value to be returned by {@link #getCodeSpace}.
     *
     * @see #getCodeSpace
     */
    String CODESPACE_KEY = "codespace";

    /**
     * Key for the {@value} property to be given to the {@linkplain
     * org.opengis.referencing.ObjectFactory CRS factory} createFoo(…) methods.
     * This is used for setting the value to be returned by {@link #getVersion}.
     *
     * @see #getVersion
     */
    String VERSION_KEY = "version";

    /**
     * Name or identifier of the person or organization responsible for namespace.
     *
     * @return The identifier code space.
     */
    @UML(identifier = "codeSpace", obligation = OPTIONAL, specification = ISO_19115)
    String getCodeSpace();

    /**
     * Version identifier for the namespace, as specified by the code authority. When appropriate,
     * the edition is identified by the effective date, coded using ISO 8601 date format.
     *
     * @return The version for the namespace (for example the version of the underlying EPSG
     *     database).
     */
    @UML(identifier = "version", obligation = OPTIONAL, specification = ISO_19115)
    String getVersion();
}