Package org.opengis.util

Interface TypeName

All Superinterfaces:

Comparable<GenericName>, GenericName, LocalName

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

A local name that references a record type in a record schema. Can also be used as the name of a feature type.

TypeNames are returned by the following methods:

• RecordType.getTypeName() for the name of the type definition.
• MemberName.getAttributeType() as a reference to the type definition of the attribute.

Comparison with the Java language

A TypeName is similar to the name of a java Class. By contrast, a MemberName is similar to the name of a field in a Java class.

It is sometime useful to establish a mapping between TypeName and Class. Such mapping is left to implementors, but the following table can be used as an example. This example uses UML identifiers, arbitrarily prefixed by the "OGC" namespace (this is not a standard practice, and should not be used for types not found in OGC standards). The definition identifiers in OGC namespace are also shown for information purpose. Those identifiers would be a more standard alternative, but cover only a small subset of types and sometime do not provide an exact match. Available OGC identifiers can be browsed on http://schemas.opengis.net/definitions/.

Examples of mapping from Java classes to type names

Java class	Name example	Definition identifier in OGC namespace
String	"OGC:CharacterString"	urn:ogc:def:dataType:OGC::string
Date	"OGC:DateTime"
Double	"OGC:Real"
Integer	"OGC:Integer"	urn:ogc:def:dataType:OGC::nonNegativeInteger
Boolean	"OGC:Boolean"	urn:ogc:def:dataType:OGC::boolean
Metadata	"OGC:MD_Metadata"

Since:

2.1

See Also:

NameFactory.createTypeName(NameSpace, CharSequence)

Method Summary

Modifier and Type	Method	Description
String	toString()	Returns the local name of the type as a String.

Methods inherited from interface GenericName

compareTo, push, scope, toFullyQualifiedName, toInternationalString

Methods inherited from interface LocalName

depth, getParsedNames, head, tip

Method Detail

toString

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

Returns the local name of the type as a String. Type names typically use a '.' or ':' navigation separator, so that their fully qualified name is of the form "[package].[class]" or "[schema]:[type]".

Specified by:

toString in interface GenericName

Specified by:

toString in interface LocalName

Overrides:

toString in class Object

Returns:

the local name of the type.