Package org.apache.sis.util.iso
Class DefaultScopedName
Object
AbstractName
DefaultScopedName
- All Implemented Interfaces:
- Serializable,- Comparable<GenericName>,- GenericName,- ScopedName
A composite of a name space (as a local name)
 and a generic name valid in that name space.
 See the GeoAPI javadoc for more information.
 
DefaultScopedName can be instantiated by any of the following methods:
- DefaultNameFactory.createGenericName(NameSpace, CharSequence[])with an array of length 2 or more.
- DefaultNameFactory.parseGenericName(NameSpace, CharSequence)with at least one occurrence of the separator in the path.
- Similar static convenience methods in Names.
Immutability and thread safety
This class is immutable and thus inherently thread-safe if theNameSpace and all CharSequence
 elements in the arguments given to the constructor are also immutable. Subclasses shall make sure that any
 overridden methods remain safe to call from multiple threads and do not change any public LocalName
 state.- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedDefaultScopedName(GenericName path, String separator, CharSequence tail) Constructs a scoped name as the concatenation of the given generic name with a single character sequence.protectedDefaultScopedName(GenericName path, GenericName tail) Constructs a scoped name as the concatenation of the given generic names.protectedDefaultScopedName(NameSpace scope, List<? extends CharSequence> names) Constructs a scoped name from the specified list of strings.
- 
Method SummaryModifier and TypeMethodDescriptionList<? extends LocalName>Returns the sequence of local name for this generic name.path()Returns every element in the sequence of parsed names except for the tip.scope()Returns the scope (name space) in which this name is local.tail()Returns every elements in the sequence of parsed names except for the head.Methods inherited from class AbstractNamecastOrCopy, compareTo, depth, equals, hashCode, head, push, tip, toFullyQualifiedName, toInternationalString, toStringMethods inherited from class Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface ComparablecompareToMethods inherited from interface GenericNamedepth, push, toFullyQualifiedName, toInternationalStringMethods inherited from interface ScopedNamehead, tip, toString
- 
Constructor Details- 
DefaultScopedNameConstructs a scoped name from the specified list of strings. If any of the given names is an instance ofInternationalString, then itstoString(Locale.ROOT)method will be invoked for fetching an unlocalized name. Otherwise theCharSequence.toString()method will be used.- Parameters:
- scope- the scope of this name, or- nullfor the global scope.
- names- the local names. This list must have at least two elements.
 
- 
DefaultScopedNameConstructs a scoped name as the concatenation of the given generic names. The scope of the new name will be the scope of thepathargument.- Parameters:
- path- the first part to concatenate.
- tail- the second part to concatenate.
 
- 
DefaultScopedNameConstructs a scoped name as the concatenation of the given generic name with a single character sequence. The scope of the new name will be the scope of thepathargument. The tail is a local name created from the given character sequence.- Parameters:
- path- the first part to concatenate.
- separator- the separator between the head and the tail, or- nullfor inheriting the same separator than the given path.
- tail- the second part to concatenate.
- Since:
- 0.8
- See Also:
 
 
- 
- 
Method Details- 
scopeReturns the scope (name space) in which this name is local. For example if a fully qualified name is"org.opengis.util.Record"and if this instance is the"util.Record"part, then its scope is named"org.opengis".Continuing with the above example, the full "org.opengis.util.Record"name has no scope. If this method is invoked on such name, then the SIS implementation returns a global scope instance (i.e. an instance for whichDefaultNameSpace.isGlobal()returnstrue) which is unique and named"global".- Specified by:
- scopein interface- GenericName
- Specified by:
- scopein class- AbstractName
- Returns:
- the scope of this name.
 
- 
tailReturns every elements in the sequence of parsed names except for the head.- Specified by:
- tailin interface- ScopedName
- Returns:
- all elements except the first one in the in the list of parsed names.
 
- 
pathReturns every element in the sequence of parsed names except for the tip.- Specified by:
- pathin interface- ScopedName
- Returns:
- all elements except the last one in the in the list of parsed names.
 
- 
getParsedNamesReturns the sequence of local name for this generic name.- Specified by:
- getParsedNamesin interface- GenericName
- Specified by:
- getParsedNamesin class- AbstractName
- Returns:
- the local names making this generic name, without the scope.
         Shall never be nullneither empty.
 
 
-