org.opengis.metadata.Identifier 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.

There is a newer version: 24.2-oss84-1

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2004-2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.metadata;

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

import org.opengis.annotation.UML;
import org.opengis.metadata.citation.Citation;

/**
 * Value uniquely identifying an object within a namespace.
 *
 * @version ISO 19115
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 2.0
 */
@UML(identifier = "MD_Identifier", specification = ISO_19115)
public interface 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 #getCode}.
     *
     * @see #getCode
     */
    String CODE_KEY = "code";

    /**
     * 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 #getAuthority}.
     *
     * @see #getAuthority
     */
    String AUTHORITY_KEY = "authority";

    /**
     * Alphanumeric value identifying an instance in the namespace.
     *
     * @return Value identifying an instance in the namespace.
     */
    @UML(identifier = "code", obligation = MANDATORY, specification = ISO_19115)
    String getCode();

    /**
     * Organization or party responsible for definition and maintenance of the {@linkplain #getCode
     * code}.
     *
     * @return Party responsible for definition and maintenance of the code.
     */
    @UML(identifier = "authority", obligation = OPTIONAL, specification = ISO_19115)
    Citation getAuthority();
}