org.opengis.util.NameSpace Maven / Gradle / Ivy

/*
 *    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.util;

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

import org.opengis.annotation.UML;

/**
 * A domain in which {@linkplain GenericName names} given by character strings are defined.
 *
 * @author Bryce Nordgren (USDA)
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 2.1
 */
@UML(identifier = "NameSpace", specification = ISO_19103)
public interface NameSpace {
    /**
     * Indicates whether this namespace is a "top level" namespace. Global, or top-level namespaces
     * are not contained within another namespace. There is no namespace called "global" or "root"
     * which contains all of the top-level namespaces. Hence, this flag indicates whether the
     * namespace has a parent.
     *
     * @return {@code true} if this namespace has no parent.
     */
    @UML(identifier = "isGlobal", obligation = MANDATORY, specification = ISO_19103)
    boolean isGlobal();

    /**
     * Represents the identifier of this namespace. If the {@linkplain #isGlobal global} attribute
     * is {@code true}, indicating that this is a top level {@code NameSpace}, then the name should
     * be a {@linkplain LocalName local name}. If {@code false}, name should be a fully-qualified
     * name where name.{@linkplain GenericName#scope() scope()}.{@linkplain #isGlobal} == true
     * .
     *
     * @return The identifier of this namespace.
     */
    @UML(identifier = "name", obligation = MANDATORY, specification = ISO_19103)
    GenericName name();
}