ScopedName (Apache SIS 1.6 API)
JavaScript is disabled on your browser.
   
Skip navigation links
Overview
Class
Use
Tree
New
Deprecated
Index
Search
Help
org.opengis.geoapi
org.opengis.util
ScopedName
Contents 
Description
Method Summary
Method Details
head()
tail()
path()
tip()
toString()
Hide sidebar  Show sidebar
Interface ScopedName
All Superinterfaces:
Comparable<Generic­Name>, Generic­Name
All Known Implementing Classes:
Default­Scoped­Name
@UML(identifier="ScopedName",
specification=ISO_19103)
public interface ScopedName
extends GenericName
A composite of a local name (as head) for locating
another name space, and a generic name (as
tail) valid in that name space. This definition allows for iteration. The
tail may be either a local name or a scoped name.
If it is a scoped name, then another another step towards a remote local
name is taken. In this way, a scoped name may represent an arbitrarily distant
local name simply by the number of times the tail() method
evaluates to a Scoped­Name before finally terminating on a Local­Name.
It may be seen that Scoped­Name is the means by which fully-qualified names are expressed.
However, a Scoped­Name is not, in itself, what is commonly thought of as a fully
qualified name. The Scoped­Name type is one link in the chain, not the entire chain.
A scoped name is a fully qualified name only if its scope is
global.
Example:
The illustration below shows the head, tail, path and name of "org​.opengis​.util​.Record".
org
.opengis
.util
.Record
head
tail
path
tip
Since:
2.0
Method Summary
All MethodsInstance MethodsAbstract Methods
Modifier and Type
Method
Description
Local­Name
head()
Returns the first element in the sequence of parsed names.
Generic­Name
path()
Returns every elements of the parsed names list except for
the tip.
Generic­Name
tail()
Returns every elements of the parsed names list except for
the head.
Local­Name
tip()
Returns the last element in the sequence of parsed names.
String
to­String()
Returns a locale-independent string representation of this scoped name.
Methods inherited from interface Comparable
compare­To
Methods inherited from interface GenericName
depth, get­Parsed­Names, push, scope, to­Fully­Qualified­Name, to­International­String
Method Details
head
@UML(identifier="head",
obligation=MANDATORY,
specification=ISO_19103)
LocalName head()
Returns the first element in the sequence of parsed names.
The head element must exists in the same name space than this
scoped name. In other words, the following relationship must holds:
head()​.scope() equals
this.scope()
This method is similar in purpose to Name​.get(0)
from the Java Naming and Directory Interface.
Example:
If this name is "org​.opengis​.util​.Record", then this method
shall returns "org".
Specified by:
head in interface Generic­Name
Returns:
The first element in the list of parsed names.
Since:
2.2
tail
@UML(identifier="tail",
obligation=MANDATORY,
specification=ISO_19103)
GenericName tail()
Returns every elements of the parsed names list except for
the head. In other words, the following relationship must holds:
tail()​.get­Parsed­Names() equals
this.get­Parsed­Names().sublist(1,
depth)
This method is similar in purpose to Name​.get­Suffix(1) from the Java Naming and Directory Interface.
Returns:
All elements except the first one in the in the list of
parsed names.
Since:
2.1
path
GenericName path()
Returns every elements of the parsed names list except for
the tip. In other words, the following relationship must holds:
tip()​.get­Parsed­Names() equals
this.get­Parsed­Names().sublist(0,
depth-1)
This method is similar in purpose to Name​.get­Prefix(size-1) from the Java Naming and Directory Interface.
Returns:
All elements except the last one in the in the list of
parsed names.
Since:
2.1
tip
LocalName tip()
Returns the last element in the sequence of parsed names.
This method is similar in purpose to Name​.get(size-1) from the Java Naming and Directory Interface.
Specified by:
tip in interface Generic­Name
Returns:
The last element in the list of parsed names.
Since:
2.1
toString
@UML(identifier="scopedName",
obligation=MANDATORY,
specification=ISO_19103)
String toString()
Returns a locale-independent string representation of this scoped name.
This method encapsulates the domain logic which formats the parsed names into a legal string representation of the name. There will be variants on
this theme. XML aficionados may require URIs. For Java classes, a dotted notation is more
appropriate, for C/C++, a double-colon, for directories, a forward or reverse slash,
and for CRS, it
will depend on the mode of expression: URN or Authority:Identifier notation.
Specified by:
to­String in interface Generic­Name
Overrides:
to­String in class Object
Returns:
A local-independent string representation of this name.