001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2013 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.List;
035 import java.util.Collections;
036 import org.opengis.annotation.UML;
037
038 import static org.opengis.annotation.Obligation.*;
039 import static org.opengis.annotation.Specification.*;
040
041
042 /**
043 * Identifier within a {@linkplain NameSpace name space} for a local object. Local names are names
044 * which are directly accessible to and maintained by a {@linkplain NameSpace name space}. Names are
045 * local to one and only one name space. The name space within which they are local is indicated by
046 * the {@linkplain #scope scope}.
047 *
048 * @author Martin Desruisseaux (IRD)
049 * @author Bryce Nordgren (USDA)
050 * @version 3.0
051 * @since 2.0
052 *
053 * @see NameFactory#createLocalName(NameSpace, CharSequence)
054 */
055 @UML(identifier="LocalName", specification=ISO_19103)
056 public interface LocalName extends GenericName {
057 /**
058 * Returns the number of levels specified by this name, which is always 1 for a local name.
059 */
060 @Override
061 int depth();
062
063 /**
064 * Returns the sequence of local name. Since this object is itself a locale name,
065 * this method always returns a {@linkplain Collections#singleton singleton}
066 * containing only {@code this}.
067 */
068 @Override
069 @UML(identifier="parsedName", obligation=MANDATORY, specification=ISO_19103)
070 List<? extends LocalName> getParsedNames();
071
072 /**
073 * Returns {@code this} since this object is already a local name.
074 *
075 * @since 2.2
076 */
077 @Override
078 LocalName head();
079
080 /**
081 * Returns {@code this} since this object is already a local name.
082 *
083 * @since 2.1
084 */
085 @Override
086 LocalName tip();
087
088 /**
089 * Returns a locale-independent string representation of this local name.
090 */
091 @Override
092 @UML(identifier="aName", obligation=MANDATORY, specification=ISO_19103)
093 String toString();
094 }