org.opengis.util

Interface LocalName

All Superinterfaces:

java.lang.Comparable, GenericName

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

Identifier within a name space for a local object. This could be the target object of the GenericName, or a pointer to another name space (with a new GenericName) one step closer to the target of the identifier.

Since:

GeoAPI 2.0

See Also:

NameFactory.createLocalName(org.opengis.util.GenericName, java.lang.String, org.opengis.util.InternationalString)

Method Summary

Modifier and Type	Method and Description
LocalName	asLocalName() Returns a view of this object as a local name.
java.util.List<LocalName>	getParsedNames() Returns the sequence of local name for this generic name.
GenericName	getScope() Returns the scope (name space) of this generic name.
java.lang.String	toString() Returns a locale-independant string representation of this local name.

Methods inherited from interface org.opengis.util.GenericName

asScopedName, toInternationalString

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getScope

@UML(identifier="scope",
     obligation=OPTIONAL,
     specification=ISO_19103)
GenericName getScope()

Returns the scope (name space) of this generic name. This method returns the same value than the one returned by the scoped version of this name. In other words, the following relation shall be respected:

ScopedName.asLocalName()	.getScope() ==	ScopedName	.getScope()
(a locale name)		(a scoped name)

Specified by:

getScope in interface GenericName

getParsedNames

@UML(identifier="parsedName",
     obligation=MANDATORY,
     specification=ISO_19103)
java.util.List<LocalName> getParsedNames()

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

Specified by:

getParsedNames in interface GenericName

asLocalName

@Extension
LocalName asLocalName()

Returns a view of this object as a local name. Some implementations may returns this since this object is already a local name.

Specified by:

asLocalName in interface GenericName

toString

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

Returns a locale-independant string representation of this local name. This string do not includes the scope, which is consistent with the parsed names definition.

Specified by:

toString in interface GenericName

Overrides:

toString in class java.lang.Object