001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2006-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.util;
033
034 import java.util.Map;
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 * A domain in which {@linkplain GenericName names} given by character strings are defined.
043 * Every {@link GenericName} must be valid in a namespace. For a {@link LocalName}, this means
044 * that the name must exist in the current namespace. For a {@link ScopedName}, this means:
045 * <p>
046 * <ol>
047 * <li>The {@linkplain ScopedName#head() head} of a {@code ScopedName} must be a {@code LocalName}
048 * which is valid in this namespace.</li>
049 * <li>The {@linkplain ScopedName#tail() tail} must either be:
050 * <ul>
051 * <li>a {@code LocalName} which is valid in the {@code NameSpace} associated with the head, or</li>
052 * <li>another {@code ScopedName} with these same constraints on head and tail, applied to
053 * the {@code NameSpace} associated with the head.</li>
054 * </ul>
055 * </li>
056 * </ol>
057 *
058 * @author Bryce Nordgren (USDA)
059 * @author Martin Desruisseaux (IRD)
060 * @version 3.0
061 * @since 2.1
062 *
063 * @navassoc 1 - - GenericName
064 *
065 * @see NameFactory#createNameSpace(GenericName, Map)
066 */
067 @UML(identifier="NameSpace", specification=ISO_19103)
068 public interface NameSpace {
069 /**
070 * Indicates whether this namespace is a "top level" namespace. Global, or top-level
071 * namespaces are not contained within another namespace. The global namespace has no
072 * parent.
073 *
074 * @return {@code true} if this namespace is the global namespace.
075 */
076 @UML(identifier="isGlobal", obligation=MANDATORY, specification=ISO_19103)
077 boolean isGlobal();
078
079 /**
080 * Represents the identifier of this namespace. Namespace identifiers shall be
081 * {@linkplain GenericName#toFullyQualifiedName() fully-qualified names} where:
082 *
083 * <blockquote><code>
084 * name.{@linkplain GenericName#scope() scope()}.{@linkplain #isGlobal()} == true
085 * </code></blockquote>
086 *
087 * @return The identifier of this namespace.
088 */
089 @UML(identifier="name", obligation=MANDATORY, specification=ISO_19103)
090 GenericName name();
091 }