Class IterableLabeledRegistry<T extends fr.inria.rules.dlgpemodel.api.sentences.HasItemInfo, C extends Iterable<T>>

java.lang.Object

fr.inria.rules.integraal.api.external.registries.BasicRegistry<C>

fr.inria.rules.integraal.api.external.registries.IterableLabeledRegistry<T,C>

Type Parameters:

T - the type of labeled values contained in the containers

C - the type of container, which must be Iterable<T>

public class IterableLabeledRegistry<T extends fr.inria.rules.dlgpemodel.api.sentences.HasItemInfo, C extends Iterable<T>>
extends BasicRegistry<C>

A registry of containers (collections of labeled values) that optionally indexes the individual values into a separate LabeledRegistry.

This class extends BasicRegistry, storing containers under string keys, while also providing flat access to individual labeled values if an elementRegistry is provided at construction time.

Field Summary

Fields inherited from class BasicRegistry

UNDEFINED

Constructor Summary

Constructors

Constructor	Description
IterableLabeledRegistry(String containerPrefix, LabeledRegistry<T> valuesRegistry)	Constructs an IterableLabeledRegistry with the given container key prefix and an optional labeled registry for individual elements.

Method Summary

Modifier and Type	Method	Description
ArrayList<String>	getContainedKeys(String key)	Returns the identifiers of all values contained in the container stored under the given key.
protected String	insert(String key, C container)	Performs the actual insertion of the key-value pair into the map.
String	put(C container)	Convenience method that inserts the given value using an auto-generated key.
String	put(String key, C container)	Inserts a value into the registry under the given key, or generates a key if none is provided.
void	putAll(BasicRegistry<? extends C> other)	Registers all containers and their values from another BasicRegistry.
void	putAll(Map<? extends String, ? extends C> other)	Registers all containers and their values from the given map.
protected void	validateParams(String key, C container)	Validates that the key-value pair can be safely inserted into the map.

Methods inherited from class BasicRegistry

clear, containsKey, containsValue, entrySet, generateKey, get, isEmpty, keySet, remove, rollback, size, values

Methods inherited from class Object

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

Constructor Details

IterableLabeledRegistry

public IterableLabeledRegistry(String containerPrefix,
 LabeledRegistry<T> valuesRegistry)

Constructs an IterableLabeledRegistry with the given container key prefix and an optional labeled registry for individual elements.

Parameters:

containerPrefix - the prefix to use for auto-generated container keys

valuesRegistry - the registry to use for indexing individual labeled values; may be null to disable element-level access

Method Details

put

public String put(C container)
           throws NullPointerException,
IllegalArgumentException,
IllegalStateException

Description copied from class: BasicRegistry

Convenience method that inserts the given value using an auto-generated key.

This is a shorthand for calling BasicRegistry.put(String, Object) with UNDEFINED as the key, triggering automatic key generation.

Overrides:

put in class BasicRegistry<C extends Iterable<T>>

Parameters:

container - the value to insert; must not be null

Returns:

the generated key used for insertion

Throws:

NullPointerException - if the value is null

IllegalStateException - if a unique key could not be generated or validation fails

IllegalArgumentException

See Also:

• BasicRegistry.put(String, Object)

validateParams

protected void validateParams(String key,
 C container)
                       throws IllegalStateException

Description copied from class: BasicRegistry

Validates that the key-value pair can be safely inserted into the map.

By default, this method checks that if the key already exists, it must be associated with the same object instance (reference equality).

Subclasses can override this method to implement custom validation logic.

Overrides:

validateParams in class BasicRegistry<C extends Iterable<T>>

Parameters:

key - the key to validate

container - the value to validate

Throws:

IllegalStateException - if the key already exists and is mapped to a different value

insert

protected String insert(String key,
 C container)
                 throws RegistryInsertionException

Description copied from class: BasicRegistry

Performs the actual insertion of the key-value pair into the map.

This method should not perform validation, but rather assume the key and value have been verified already. The default implementation inserts the pair into the map and returns the key.

Subclasses may override to perform custom insertion strategies.

Overrides:

insert in class BasicRegistry<C extends Iterable<T>>

Parameters:

key - the key to insert

container - the value to associate with the key

Returns:

the key used for insertion

Throws:

RegistryInsertionException - if the insertion fails unexpectedly

put

public String put(String key,
 C container)
           throws NullPointerException,
IllegalArgumentException,
IllegalStateException

Description copied from class: BasicRegistry

Inserts a value into the registry under the given key, or generates a key if none is provided.

If the specified key is UNDEFINED, a unique key will be generated using a NamesGenerator. Otherwise, the provided key is used. In both cases, the method ensures the key is not already associated with a different value.

Unlike Map.put(Object, Object), this method returns the actual key used, not the value. This is intentional to allow retrieval of auto-generated keys.

This method delegates to four other methods to fulfill its responsibilities:

• BasicRegistry.generateKey(String, Object): Resolves the final key to use
• BasicRegistry.validateParams(String, Object): Ensures the key-value pair can be safely added
• BasicRegistry.insert(String, Object): Actually inserts the entry into the map
• BasicRegistry.rollback(String, Object, RuntimeException): Handles insertion failure (optional override)

Overrides:

put in class BasicRegistry<C extends Iterable<T>>

Parameters:

key - the desired key to associate with the value. If UNDEFINED, a new key is auto-generated.

container - the non-null value to insert into the registry

Returns:

the key used to store the value (either provided or generated)

Throws:

NullPointerException - if either key or value is null

IllegalStateException - if:

• the key already exists and is associated with a different value
• a unique key could not be generated within the allowed attempts

IllegalArgumentException

putAll

public void putAll(Map<? extends String, ? extends C> other)
            throws NullPointerException,
IllegalArgumentException,
IllegalStateException

Registers all containers and their values from the given map. All entries are validated before insertion.

Overrides:

putAll in class BasicRegistry<C extends Iterable<T>>

Parameters:

other - the map of key-container pairs to insert

Throws:

NullPointerException - if the map, any key, or any value is null

IllegalArgumentException - if any value violates label constraints

IllegalStateException - if any key already exists

putAll

public void putAll(BasicRegistry<? extends C> other)
            throws NullPointerException,
IllegalStateException,
IllegalArgumentException

Registers all containers and their values from another BasicRegistry.

Overrides:

putAll in class BasicRegistry<C extends Iterable<T>>

Parameters:

other - another registry containing containers of labeled values

Throws:

NullPointerException - if the registry or any of its entries is null

IllegalArgumentException - if any value violates label constraints

IllegalStateException - if any key already exists

getContainedKeys

public ArrayList<String> getContainedKeys(String key)

Returns the identifiers of all values contained in the container stored under the given key.

Parameters:

key - the key of the container to inspect

Returns:

the contained value identifiers