Package org.apache.sis.feature

Class CharacteristicMap

java.lang.Object

org.apache.sis.internal.util.AbstractMap<String,AbstractAttribute<?>>

org.apache.sis.feature.CharacteristicMap

All Implemented Interfaces:

Cloneable, Map<String,AbstractAttribute<?>>

final class CharacteristicMap
extends AbstractMap<String,AbstractAttribute<?>>
implements Cloneable

Implementation of AbstractAttribute.characteristics() map. This map holds only the attribute characteristics which have been explicitly set or requested.

Since:

0.5

Version:

0.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	CharacteristicMap.Entry	An entry returned by the AbstractMap.entrySet() iterator.

Nested classes/interfaces inherited from class org.apache.sis.internal.util.AbstractMap

AbstractMap.EntryIterator<K,V>, AbstractMap.IteratorAdapter<K,V>, AbstractMap.KeyIterator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) AbstractAttribute<?>[]	characterizedBy	Characteristics of the source attribute, created when first needed.
private final AbstractAttribute<?>	source	The attribute source for which to provide characteristics.
(package private) final CharacteristicTypeMap	types	Description of the attribute characteristics.

Constructor Summary

Constructors

Constructor	Description
CharacteristicMap(AbstractAttribute<?> source, CharacteristicTypeMap types)	Creates an initially empty map of attribute characteristics.

Method Summary

Modifier and Type	Method	Description
protected boolean	addKey(String name)	If no characteristic exists for the given name and that name is valid, creates a new map entry with a default Attribute characteristic.
protected boolean	addValue(AbstractAttribute<?> value)	Adds the given characteristic if none is currently associated for the same characteristic name.
void	clear()	Removes all entries in this map.
CharacteristicMap	clone()	Returns a copy of this map.
protected AbstractMap.EntryIterator<String,AbstractAttribute<?>>	entryIterator()	Returns an iterator over the entries.
AbstractAttribute<?>	get(Object key)	Returns the attribute characteristic for the given name, or null if none.
private int	indexOf(String key)	Returns the index for the characteristic of the given name.
boolean	isEmpty()	Returns false if this map contains at least one characteristic.
AbstractAttribute<?>	put(String key, AbstractAttribute<?> value)	Sets the attribute characteristic for the given name.
AbstractAttribute<?>	remove(Object key)	Removes the attribute characteristic for the given name.
int	size()	Returns the number of attribute characteristics.
(package private) final void	verifyAttributeType(int index, DefaultAttributeType<?> type)	Ensures that the given attribute type is the instance that we expect at the given index.

Methods inherited from class org.apache.sis.internal.util.AbstractMap

containsKey, containsValue, entrySet, equals, getOrDefault, hashCode, keySet, putAll, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Details

source

private final AbstractAttribute<?> source

The attribute source for which to provide characteristics.

characterizedBy

AbstractAttribute<?>[] characterizedBy

Characteristics of the source attribute, created when first needed.

types

final CharacteristicTypeMap types

Description of the attribute characteristics.

Constructor Details

CharacteristicMap

CharacteristicMap(AbstractAttribute<?> source,
 CharacteristicTypeMap types)

Creates an initially empty map of attribute characteristics.

Parameters:

source - the attribute which is characterized by characterizedBy.

types - description of the characteristics of source.

Method Details

clone

public CharacteristicMap clone()
                        throws CloneNotSupportedException

Returns a copy of this map. Characteristics are also cloned.

Overrides:

clone in class Object

Returns:

a copy of this map.

Throws:

CloneNotSupportedException

clear

public void clear()

Removes all entries in this map.

Specified by:

clear in interface Map<String,AbstractAttribute<?>>

Overrides:

clear in class AbstractMap<String,AbstractAttribute<?>>

isEmpty

public boolean isEmpty()

Returns false if this map contains at least one characteristic.

Specified by:

isEmpty in interface Map<String,AbstractAttribute<?>>

Overrides:

isEmpty in class AbstractMap<String,AbstractAttribute<?>>

Returns:

true if this map contains no element.

size

public int size()

Returns the number of attribute characteristics.

Specified by:

size in interface Map<String,AbstractAttribute<?>>

Overrides:

size in class AbstractMap<String,AbstractAttribute<?>>

get

public AbstractAttribute<?> get(Object key)

Returns the attribute characteristic for the given name, or null if none.

Specified by:

get in interface Map<String,AbstractAttribute<?>>

remove

public AbstractAttribute<?> remove(Object key)

Removes the attribute characteristic for the given name.

Specified by:

remove in interface Map<String,AbstractAttribute<?>>

Overrides:

remove in class AbstractMap<String,AbstractAttribute<?>>

Parameters:

key - the key of the entry to remove.

Returns:

the previous value, or null if none.

indexOf

private int indexOf(String key)

Returns the index for the characteristic of the given name.

Parameters:

key - the name for which to get the characteristic index.

Returns:

the index for the characteristic of the given name.

Throws:

IllegalArgumentException - if the given key is not the name of a characteristic in this map.

verifyAttributeType

final void verifyAttributeType(int index,
 DefaultAttributeType<?> type)

Ensures that the given attribute type is the instance that we expect at the given index. If the given instance is not the expected one, then an IllegalArgumentException will be thrown with an error message formatted using the name of expected and given types.

Parameters:

index - index of the expected attribute type.

type - the actual attribute type.

put

public AbstractAttribute<?> put(String key,
 AbstractAttribute<?> value)

Sets the attribute characteristic for the given name.

Specified by:

put in interface Map<String,AbstractAttribute<?>>

Overrides:

put in class AbstractMap<String,AbstractAttribute<?>>

Parameters:

key - the name of the characteristic to set.

value - the value to associate to the given key.

Returns:

the previous value, or null if none.

Throws:

IllegalArgumentException - if the given key is not the name of a characteristic in this map.

addKey

protected boolean addKey(String name)

If no characteristic exists for the given name and that name is valid, creates a new map entry with a default Attribute characteristic.

Overrides:

addKey in class AbstractMap<String,AbstractAttribute<?>>

Parameters:

name - the name of the characteristic to create, if it does not already exist.

Returns:

true if a new characteristic has been created for the given name.

Throws:

IllegalArgumentException - if the given key is not the name of a characteristic in this map.

addValue

protected boolean addValue(AbstractAttribute<?> value)

Adds the given characteristic if none is currently associated for the same characteristic name.

Overrides:

addValue in class AbstractMap<String,AbstractAttribute<?>>

Parameters:

value - the characteristic to add.

Returns:

true if the characteristic has been added.

Throws:

IllegalArgumentException - if given characteristic is not valid for this map.

IllegalStateException - if another characteristic already exists for the characteristic name.

entryIterator

protected AbstractMap.EntryIterator<String,AbstractAttribute<?>> entryIterator()

Returns an iterator over the entries.

Specified by:

entryIterator in class AbstractMap<String,AbstractAttribute<?>>

Returns:

an iterator over the entries in this map, or null.