Package org.apache.sis.util.iso
Class DefaultNameFactory
Object
AbstractFactory
DefaultNameFactory
- All Implemented Interfaces:
Factory,NameFactory
A factory for creating
AbstractName objects.
This factory provides the following methods for creating name instances:
createTypeName(NameSpace, CharSequence)createMemberName(NameSpace, CharSequence, TypeName)createLocalName(NameSpace, CharSequence)createGenericName(NameSpace, CharSequence[])– for local or scoped names
Thread safety
The sameDefaultNameFactory instance can be safely used by many threads without synchronization
on the part of the caller. Subclasses should make sure that any overridden methods remain safe to call
from multiple threads.- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateGenericName(NameSpace scope, CharSequence... parsedNames) Creates a local or scoped name from an array of parsed names.createInternationalString(Map<Locale, String> strings) Creates an international string from a set of strings in different locales.createLocalName(NameSpace scope, CharSequence name) Creates a local name from the given character sequence.createMemberName(NameSpace scope, CharSequence name, TypeName attributeType) Creates a member name from the given character sequence and attribute type.createNameSpace(GenericName name, Map<String, ?> properties) Returns a namespace having the given name.createTypeName(NameSpace scope, CharSequence name) Creates a type name from the given character sequence and automatically inferred Java type.createTypeName(NameSpace scope, CharSequence name, Type javaType) Creates a type name from the given character sequence and explicit Java type.parseGenericName(NameSpace scope, CharSequence name) Constructs a generic name from a qualified name.toGenericNames(Object value) Converts the given value to an array of generic names.toTypeName(Class<?> valueClass) Suggests a type name for the given class.Methods inherited from class AbstractFactory
getVendor
-
Constructor Details
-
DefaultNameFactory
public DefaultNameFactory()Creates a new factory.
-
-
Method Details
-
createInternationalString
Creates an international string from a set of strings in different locales.- Specified by:
createInternationalStringin interfaceNameFactory- Parameters:
strings- string value for each locale key.- Returns:
- the international string.
- See Also:
-
createNameSpace
Returns a namespace having the given name. Despite the "create" name, this method tries to return an existing instance when possible. The namespace is characterized by the given name, and optionally by the following properties:Recognized properties Property name Purpose "separator"The separator to insert between parsed names in that namespace. "separator.head"The separator to insert between the namespace and the head.
If omitted, then the default is the same value than"separator".Examples:- For URN namespace,
separator=":"is typically sufficient. - For HTTP namespace,
separator.head="://"andseparator=".".
- Specified by:
createNameSpacein interfaceNameFactory- Parameters:
name- the name of the namespace to be returned. This argument can be created usingcreateGenericName(null, namespace).properties- an optional map of properties to be assigned to the namespace, ornullif none.- Returns:
- a namespace having the given name and separator.
- See Also:
- For URN namespace,
-
createTypeName
Creates a type name from the given character sequence and automatically inferred Java type. The default implementation returns a new or an existingDefaultTypeNameinstance. SeeDefaultTypeNamejavadoc for the list of recognized type names.- Specified by:
createTypeNamein interfaceNameFactory- Parameters:
scope- the scope of the type name create, ornullfor a global namespace.name- the type name as a string or an international string.- Returns:
- the type name for the given scope and character sequence.
- Throws:
UnknownNameException- if a mapping from the 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:
-
createTypeName
Creates a type name from the given character sequence and explicit Java type. The default implementation returns a new or an existingDefaultTypeNameinstance.- Parameters:
scope- the scope of the type name to create, ornullfor a global namespace.name- the type name as a string or an international string.javaType- the Java type represented by the name, ornullif none.- Returns:
- the type name for the given scope, character sequence and Java type.
- Since:
- 1.3
- See Also:
-
createMemberName
Creates a member name from the given character sequence and attribute type. The default implementation returns a new or an existingDefaultMemberNameinstance.- Parameters:
scope- the scope of the member name to create, ornullfor a global namespace.name- the member name as a string or an international string.attributeType- the type of the data associated with the member.- Returns:
- the member name for the given character sequence.
- See Also:
-
createLocalName
Creates a local name from the given character sequence. The default implementation returns a new or an existingDefaultLocalNameinstance.- Specified by:
createLocalNamein interfaceNameFactory- Parameters:
scope- the scope of the local name to create, ornullfor a global namespace.name- the local name as a string or an international string.- Returns:
- the local name for the given character sequence.
- See Also:
-
createGenericName
Creates a local or scoped name from an array of parsed names. The default implementation returns an instance ofDefaultLocalNameif the length of theparsedNamesarray is 1, or an instance ofDefaultScopedNameif the length of the array is 2 or more.- Specified by:
createGenericNamein interfaceNameFactory- Parameters:
scope- the scope of the generic name to create, ornullfor a global namespace.parsedNames- the local names as an array ofStringorInternationalStringinstances. This array shall contain at least one element.- Returns:
- the generic name for the given parsed names.
- See Also:
-
parseGenericName
Constructs a generic name from a qualified name. This method splits the given name around a separator inferred from the given scope, or the':'separator if the given scope is null.- Specified by:
parseGenericNamein interfaceNameFactory- Parameters:
scope- the scope of the generic name to create, ornullfor a global namespace.name- the qualified name, as a sequence of names separated by a scope-dependent separator.- Returns:
- a name parsed from the given string.
- See Also:
-
toGenericNames
Converts the given value to an array of generic names. If the given value is an instance ofGenericName,Stringor any other type enumerated below, then it is converted and returned in an array of length 1. If the given value is an array or a collection, then an array of same length is returned where each element has been converted.Allowed types or element types are:
GenericName, to be casted and returned as-is.CharSequence(usually aStringor anInternationalString), to be parsed as a generic name using the':'separator.Identifier, its code to be parsed as a generic name using the':'separator.
valueis an array or a collection containingnullelements, then the corresponding element in the returned array will also benull.- Parameters:
value- the object to cast into an array of generic names, ornull.- Returns:
- the generic names, or
nullif the givenvaluewas null. Note that it may be thevaluereference itself casted toGenericName[]. - Throws:
ClassCastException- ifvaluecannot be casted.- Since:
- 0.5
-
toTypeName
Suggests a type name for the given class. Apache SIS provides a mapping betweenClassandTypeNameobjects as documented in theDefaultTypeNamejavadoc. The givenvalueClasscan be fetched back byDefaultTypeName.toJavaType().- Parameters:
valueClass- the Java class for which to get a type name, ornull.- Returns:
- a suggested type name, or
nullif the given class was null. - Since:
- 0.5
- See Also:
-