- Type Parameters:
E- the type of elements associated with the names.
public class FeatureNaming<E> extends ObjectHelper class for mapping
GenericNameinstances and their shortened names to features. The features are typically represented by instances of
Coverage(sometime seen as a kind of features), but this class actually puts no restriction on the kind of object associated to
DataStoreimplementations are free to choose their internal object. Those objects can be stored and fetched using the
Stringrepresentation of their name as given by
GenericName.toString(), or a shortened name when there is no ambiguity.Example: a data store may contain aNote that contrarily to the standard
"foo:bar". If that feature type has been binded like below:
Then the two following lines return the same instance:
FeatureNaming<FeatureType> binding = new FeatureNaming<>(); FeatureType myFooBar = ...; // Some type named "foo:bar" for this example. binding.add(null, myFooBar.getName(), myFooBar);
assert binding.get(null, "foo:bar") == myFooBar; assert binding.get(null, "bar") == myFooBar; // Allowed only if there is no ambiguity.
Map.get(Object)method contract, the
get(…)method defined in this class throws an exception instead than returning
nullif no unambiguous mapping can be established for the given name. This behavior allows
FeatureNamingto produce an error message telling why the operation can not succeed.Managing the list of generic namesThis class does not memorize the list of added
GenericNameinstances. Instead this class memorizes only their string representations, thus protecting the binding from any change in the original
GenericNameinstances. The list of feature names should instead be included in the ISO 19115 metadata returned by
DataStore.getMetadata(). The path to feature names is:
Note that above metadata information are not necessarily structured as a flat list; a
DataStoremay group some feature information in different
FeatureCatalogueDescriptioninstances. This is one reason why we let the data store manages
GenericNamelists itself.Thread safetyA
FeatureNaminginstance is thread-safe only if constructed once and never modified after publication. For example it is safe to initialize a
DataStoreProviderconstructor if the result is stored in a private final field with no public accessor and no call to
remove(…)methods after construction. If this condition does not hold, then synchronization (if desired) is caller's responsibility. The caller is typically the
DataStoreimplementation which contains this
Constructors Constructor Description
FeatureNaming()Creates a new "
GenericNameto object" mapping.
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
add(DataStore store, GenericName name, E value)Adds a value for the given name if none exist.
get(DataStore store, String name)Returns the value associated to the given name.
remove(DataStore store, GenericName name)Removes the value associated to the given name.
public E get(DataStore store, String name) throws IllegalNameExceptionReturns the value associated to the given name.
store- the data store for which to get a value, or
name- the name for which to get a value.
- value associated to the given object.
IllegalNameException- if the given name was not found or is ambiguous.
public void add(DataStore store, GenericName name, E value) throws IllegalNameExceptionAdds a value for the given name if none exist. If a previous value already exists for the given name, then an exception is thrown.
store- the data store for which to add a value, or
name- the name for which to add a value.
value- the value to add (can not be null).
IllegalNameException- if another element is already registered for the given name.
public boolean remove(DataStore store, GenericName name) throws IllegalNameExceptionRemoves the value associated to the given name. If no value is associated to the given name, then this method does nothing.
store- the data store for which to remove a value, or
name- the name for which to remove value.
trueif the value was removed, or
falseif no value was defined for the given name.
IllegalNameException- if inconsistency are found between the given name and the one which was given to the
add(…)method. An example of inconsistency is a name having the same string representation, but for which
ScopedName.tail()returns different values.