Package org.apache.sis.referencing

Class PropertiesConverter

java.lang.Object

org.apache.sis.internal.converter.SurjectiveConverter<String,String>

org.apache.sis.referencing.PropertiesConverter

All Implemented Interfaces:

Function<String,String>, ObjectConverter<String,String>

final class PropertiesConverter
extends SurjectiveConverter<String,String>

Converts AbstractIdentifiedObject entries to NamedIdentifier entries. This converter:

• Exclude remarks, because they will be taken by AbstractIdentifiedObject and we don't want to duplicate them in NamedIdentifier.
• Optionally rename de NAME_KEY as CODE_KEY in order to allow NamedIdentifier to inherit the name given to AbstractIdentifiedObject if no code were explicitly given.

Since:

0.4

Version:

0.4

Field Summary

Fields

Modifier and Type	Field	Description
private static final PropertiesConverter	CODE_INCLUDED	The converter to use if the map already contains a CODE_KEY.
private static final PropertiesConverter	CODE_INFERED	The converter to use if the does not contain a CODE_KEY, in which case it needs to be inferred from the NAME_KEY.
private final boolean	rename	true for renaming NAME_KEY as CODE_KEY, or false for excluding the NAME_KEY instead.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PropertiesConverter(boolean rename)	Constructor for static constants only.

Method Summary

Modifier and Type	Method	Description
String	apply(String key)	Converts a key as documented in class javadoc.
(package private) static Map<String,?>	convert(Map<String,?> properties)	Converts the given map.
Class<String>	getSourceClass()	Returns the type of keys before conversion.
Class<String>	getTargetClass()	Returns the type of keys after conversion.

Methods inherited from class org.apache.sis.internal.converter.SurjectiveConverter

inverse, properties, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose

Field Details

CODE_INCLUDED

private static final PropertiesConverter CODE_INCLUDED

The converter to use if the map already contains a CODE_KEY.

CODE_INFERED

private static final PropertiesConverter CODE_INFERED

The converter to use if the does not contain a CODE_KEY, in which case it needs to be inferred from the NAME_KEY.

rename

private final boolean rename

true for renaming NAME_KEY as CODE_KEY, or false for excluding the NAME_KEY instead.

Constructor Details

PropertiesConverter

private PropertiesConverter(boolean rename)

Constructor for static constants only.

Method Details

convert

static Map<String,?> convert(Map<String,?> properties)

Converts the given map.

getSourceClass

public Class<String> getSourceClass()

Returns the type of keys before conversion.

Returns:

the type of objects to convert.

getTargetClass

public Class<String> getTargetClass()

Returns the type of keys after conversion.

Returns:

the type of converted objects.

apply

public String apply(String key)

Converts a key as documented in class javadoc.

Parameters:

key - the object to convert, or null.

Returns:

the converted object, or null.