Class DefaultTypeName

Object

AbstractName

DefaultLocalName

DefaultTypeName

All Implemented Interfaces:

Serializable, Comparable<Generic­Name>, Generic­Name, Local­Name, Type­Name

public class DefaultTypeName
extends DefaultLocalName
implements TypeName

The name of an attribute type associated with a member name. Default­Type­Name can be instantiated by any of the following methods:

• Default­Name­Factory.create­Type­Name(Name­Space, Char­Sequence)
• Default­Name­Factory.to­Type­Name(Class)

Mapping Java classes to type names

A bidirectional mapping is defined between Type­Name and Java Class. When an UML identifier from an OGC standard exists for a given Class, Apache SIS uses that identifier prefixed by the "OGC" namespace. Note that this is not a standard practice. A more standard practice would be to use the data type URN standard values (third column in the table below), but the set of data type identifiers defined by OGC is currently small and is sometimes not an exact match.

Mapping from Java classes to type names (non-exhaustive list)

Java class	Scoped type name	Data type URN standard values	URL in Web Services
InternationalString	OGC:FreeText
String	OGC:CharacterString	urn:ogc:def:dataType:OGC::string	http://www.w3.org/2001/XMLSchema#string
URI	OGC:URI	urn:ogc:def:dataType:OGC::anyURI
Boolean	OGC:Boolean	urn:ogc:def:dataType:OGC::boolean	http://www.w3.org/2001/XMLSchema#boolean
Integer	OGC:Integer	urn:ogc:def:dataType:OGC::nonNegativeInteger	http://www.w3.org/2001/XMLSchema#integer
BigDecimal	OGC:Decimal		http://www.w3.org/2001/XMLSchema#decimal
Double	OGC:Real		http://www.w3.org/2001/XMLSchema#double
Float	OGC:Real		http://www.w3.org/2001/XMLSchema#float
Date	OGC:DateTime
Locale	OGC:PT_Locale
Metadata	OGC:MD_Metadata
Geometry	OGC:Geometry
Unknown Java class	class:<the class name>

The mapping defined by Apache SIS may change in any future version depending on standardization progress. To protect against such changes, users are encouraged to rely on methods or constructors like to­Java­Type() or Default­Name­Factory.to­Type­Name(Class) instead of parsing the name.

Immutability and thread safety

This class is immutable and thus inherently thread-safe if the Name­Space and Char­Sequence 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 Type­Name state.

Since:

0.3

See Also:

• Default­Member­Name
• Default­Name­Factory
• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Default­Type­Name(Name­Space scope, Char­Sequence name)	Constructs a type name from the given character sequence and infers automatically a Java type.
protected	Default­Type­Name(Name­Space scope, Char­Sequence name, Type java­Type)	Constructs a type name from the given character sequence and explicit Java type.

Method Summary

Modifier and Type	Method	Description
static Default­Type­Name	cast­Or­Copy(Type­Name object)	Returns a SIS type name implementation with the values of the given arbitrary implementation.
boolean	equals(Object object)	Compares this type name with the specified object for equality.
Optional<Type>	to­Java­Type()	Returns the Java type represented by this name.

Methods inherited from class DefaultLocalName

cast­Or­Copy, compare­To, depth, get­Parsed­Names, head, scope, tip, to­International­String, to­String

Modifier and Type	Method	Description
static Default­Local­Name	cast­Or­Copy(Local­Name object)	Returns a SIS local name implementation with the values of the given arbitrary implementation.
int	compare­To(Generic­Name name)	Compares this name with the specified object for order.
final int	depth()	Returns the depth, which is always 1 for a local name.
final List<Default­Local­Name>	get­Parsed­Names()	Returns the sequence of local name for this name.
final Local­Name	head()	Returns this since this object is already a local name.
Name­Space	scope()	Returns the scope (name space) in which this name is local.
final Local­Name	tip()	Returns this since this object is already a local name.
International­String	to­International­String()	Returns a local-dependent string representation of this local name.
String	to­String()	Returns a locale-independent string representation of this local name.

Methods inherited from class AbstractName

cast­Or­Copy, hash­Code, push, to­Fully­Qualified­Name

Modifier and Type	Method	Description
static Abstract­Name	cast­Or­Copy(Generic­Name object)	Returns a SIS name implementation with the values of the given arbitrary implementation.
int	hash­Code()	Returns a hash code value for this generic name.
Scoped­Name	push(Generic­Name scope)	Returns this name expanded with the specified scope.
Generic­Name	to­Fully­Qualified­Name()	Returns a view of this name as a fully-qualified name.

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

DefaultTypeName

protected DefaultTypeName(NameSpace scope,
 CharSequence name)
                   throws UnknownNameException

Constructs a type name from the given character sequence and infers automatically a Java type. The scope and name arguments are given unchanged to the super-class constructor. Then the Java type is inferred in a way that depends on the specified scope:

• If the scope is "OGC", then:
  • If the name is "Character­String", "Integer", "Real" or other recognized names (see class javadoc), then the corresponding Java class is associated with this type name.
  • Otherwise Unknown­Name­Exception is thrown.
• Else if the scope is "class", then:
  • If the name is accepted by Class.for­Name(String), then that Java class is associated with this type name.
  • Otherwise Unknown­Name­Exception is thrown.
• Else if the scope is global, then:
  • If the name is one of the names recognized in "OGC" scope (see above), then the corresponding class is associated with this type name.
  • Otherwise no Java class is associated with this type name. No exception is thrown because names in the global namespace could be anything; this constructor cannot know if the given name was wrong.
• Otherwise no Java class is associated with this type name, because this method cannot check the validity of names in other namespaces.

Parameters:

scope - the scope of this name, or null for a global scope.

name - the local name (never null).

Throws:

Unknown­Name­Exception - if a mapping from this name to a Java class was expected to exist (because the specified scope is "OGC" or "class") but the associated Java class cannot be found.

See Also:

• Default­Name­Factory.create­Type­Name(Name­Space, Char­Sequence)

DefaultTypeName

protected DefaultTypeName(NameSpace scope,
 CharSequence name,
 Type javaType)

Constructs a type name from the given character sequence and explicit Java type. The scope and name arguments are given unchanged to the super-class constructor.

Parameters:

scope - the scope of this name, or null for a global scope.

name - the local name (never null).

java­Type - the value type to be returned by to­Java­Type(), or null if none.

Since:

1.3

See Also:

• Default­Name­Factory.create­Type­Name(Name­Space, Char­Sequence, Type)

Method Details

castOrCopy

public static DefaultTypeName castOrCopy(TypeName object)

Returns a SIS type name implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:

• If the given object is null, then this method returns null.
• Otherwise if the given object is already an instance of Default­Type­Name, then it is returned unchanged.
• Otherwise a new Default­Type­Name instance is created with the same values as the given name.

Parameters:

object - the object to get as a SIS implementation, or null if none.

Returns:

a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

0.5

toJavaType

public Optional<Type> toJavaType()

Returns the Java type represented by this name. This is the type either specified explicitly at construction time or inferred from the type name.

Returns:

the Java type (usually a Class) for this type name.

Since:

1.3

See Also:

• Names.to­Class(Type­Name)

equals

public boolean equals(Object object)

Compares this type name with the specified object for equality.

Overrides:

equals in class Default­Local­Name

Parameters:

object - the object to compare with this type for equality.

Returns:

true if the given object is equal to this name.