Module org.opengis.geoapi

Package org.opengis.util

Interface LocalName

All Superinterfaces:

Comparable<GenericName>, GenericName

All Known Subinterfaces:

MemberName, TypeName

@UML(identifier="LocalName",
     specification=ISO_19103)
public interface LocalName
extends GenericName

Identifier within a name space for a local object. Local names are names which are directly accessible to and maintained by a NameSpace. Names are local to one and only one name space. The name space within which they are local is indicated by the scope.

Since:

2.0

See Also:

• NameFactory.createLocalName(NameSpace, CharSequence)

Method Summary

Modifier and Type	Method	Description
default int	depth()	Returns the number of levels specified by this name, which is always 1 for a local name.
default List<? extends LocalName>	getParsedNames()	Returns the sequence of local names.
default LocalName	head()	Returns this since this object is already a local name.
default LocalName	tip()	Returns this since this object is already a local name.
String	toString()	Returns a locale-independent string representation of this local name.

Methods inherited from interface org.opengis.util.GenericName

compareTo, push, scope, toFullyQualifiedName, toInternationalString

Method Details

depth

@UML(identifier="depth",
     obligation=MANDATORY,
     specification=ISO_19103)
default int depth()

Returns the number of levels specified by this name, which is always 1 for a local name.

Specified by:

depth in interface GenericName

Returns:

always 1 for a local name.

getParsedNames

@UML(identifier="parsedName",
     obligation=MANDATORY,
     specification=ISO_19103)
default List<? extends LocalName> getParsedNames()

Returns the sequence of local names. Since this object is itself a locale name, this method always returns a singleton list containing only this.

Specified by:

getParsedNames in interface GenericName

Returns:

a singleton containing only this.

head

default LocalName head()

Returns this since this object is already a local name.

Specified by:

head in interface GenericName

Returns:

the first element in the list of parsed names.

tip

default LocalName tip()

Returns this since this object is already a local name.

Specified by:

tip in interface GenericName

Returns:

the last element in the list of parsed names.

toString

@UML(identifier="aName",
     obligation=MANDATORY,
     specification=ISO_19103)
String toString()

Returns a locale-independent string representation of this local name.

Specified by:

toString in interface GenericName

Overrides:

toString in class Object

Returns:

the local-independent string representation of this name.