| java.lang.Object
 org.geotools.util.GenericName
org.geotools.util.LocalName
All known Subclasses: org.geotools.util.MemberNameImpl,
| LocalName | | public class LocalName extends org.geotools.util.GenericName implements org.opengis.util.LocalName(Code) | | 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:
2.1
version:
$Id: LocalName.java 22443 2006-10-27 20:47:22Z desruisseaux $
author:
Martin Desruisseaux
See Also: NameFactory |
| Constructor Summary | |
| public | LocalName(CharSequence name)
Constructs a local name from the specified string with no scope.
If the specified name is an
InternationalString , then the
(null)
method will be used in order to fetch an unlocalized name. | | | LocalName(ScopedName asScopedName, CharSequence name)
Constructs a local name from the specified international string. |
| Method Summary | |
| public org.opengis.util.LocalName | asLocalName()
Returns a view of this object as a local name. | | public ScopedName | asScopedName()
Returns a view of this object as a scoped name,
or
null if this name has no scope. | | public int | compareTo(Object object)
Compares this name with the specified object for order. | | public int | depth()
Returns the depth, which is always 1 for a local name. | | public boolean | equals(Object object)
Compares this local name with the specified object for equality. | | public List | getParsedNames()
Returns the sequence of local name for this
. | | public GenericName | getScope()
Returns the scope (name space) of this generic name. | | public int | hashCode()
Returns a hash code value for this local name. | | public org.opengis.util.LocalName | name()
Returns
this since this object is already a local name. | | public ScopedName | push(GenericName scope)
Returns this name expanded with the specified scope. | | public NameSpace | scope()
Returns the scope (name space) in which this name is local. | | public GenericName | toFullyQualifiedName()
Returns a view of this name as a fully-qualified name. | | public InternationalString | toInternationalString()
Returns a local-dependent string representation of this locale name. | | public String | toString()
Returns a locale-independant string representation of this local name. |
| LocalName | | public LocalName(CharSequence name)(Code) | | Constructs a local name from the specified string with no scope.
If the specified name is an
InternationalString , then the
(null)
method will be used in order to fetch an unlocalized name. Otherwise, the
() method will be used.
Parameters:
name - The local name (never null ). |
| LocalName | | LocalName(ScopedName asScopedName, CharSequence name)(Code) | | Constructs a local name from the specified international string.
This constructor is not public since it can't be used from outside
of
org.geotools.util.ScopedName constructor (otherwise some
methods in this class may have the wrong semantic).
Parameters:
asScopedName - The view of this object as a scoped name.
Parameters:
name - The local name (never null ). |
| asLocalName | | public org.opengis.util.LocalName asLocalName()(Code) | | Returns a view of this object as a local name. Since this object is already
a local name, this method always returns
this .
LocalName.name() |
| compareTo | | public int compareTo(Object object)(Code) | | Compares this name with the specified object for order. Returns a negative integer,
zero, or a positive integer as this name lexicographically precedes, is equals to,
or follows the specified object. The comparaison is case-insensitive.
|
| depth | | public int depth()(Code) | | Returns the depth, which is always 1 for a local name.
since:
2.3 |
| equals | | public boolean equals(Object object)(Code) | | Compares this local name with the specified object for equality.
|
| getParsedNames | | public List getParsedNames()(Code) | | Returns the sequence of local name for this
.
Since this object is itself a locale name, this method always returns a singleton
containing only
this .
|
| hashCode | | public int hashCode()(Code) | | Returns a hash code value for this local name.
|
| name | | public org.opengis.util.LocalName name()(Code) | | Returns
this since this object is already a local name.
since:
2.3 |
| push | | public ScopedName push(GenericName scope)(Code) | | Returns this name expanded with the specified scope. One may represent this operation
as a concatenation of the specified
name with
this . In pseudo-code,
the following relationships must hold:
push(name).getParsedList() ==
name.getParsedList().addAll(
)push(name).scope() == name.
Note: Those conditions can be understood in terms of the Java
Object.equals equals method instead of the Java identity comparator
== .
since:
2.3 |
| scope | | public NameSpace scope()(Code) | | Returns the scope (name space) in which this name is local. The scope is set on creation
and is not modifiable. The scope of a name determines where a name "starts". For instance,
if a name has a
of two (
"util.GenericName" ) and is
associated with a
having the name
"org.opengis" ,
then the fully qualified name would be
"org.opengis.util.GenericName" .
since:
2.3 |
| toFullyQualifiedName | | public GenericName toFullyQualifiedName()(Code) | | Returns a view of this name as a fully-qualified name. The
of a fully qualified name must be
. This method
never returns
null .
since:
2.3 |
| toInternationalString | | public InternationalString toInternationalString()(Code) | | Returns a local-dependent string representation of this locale name.
|
| toString | | public String toString()(Code) | | Returns a locale-independant string representation of this local name.
This string do not includes the scope, which is consistent with the
definition.
|
| Fields inherited from org.geotools.util.GenericName | final public static char DEFAULT_SEPARATOR(Code)(Java Doc)
|
|
|