Package es.urjc.etsii.grafo.autoconfig.inventory

Class AlgorithmInventoryService

java.lang.Object

es.urjc.etsii.grafo.autoconfig.inventory.AlgorithmInventoryService

@Service
public class AlgorithmInventoryService
extends Object

Manage algorithm components at runtime. When starting the application, discovers all available components. Can build any configured component easily from string, as long as there is a matching constructor in the algorithm component.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AlgorithmInventoryService.AlgorithmInventory

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	aliases
protected Map<String,Class<?>>	componentByName
protected Map<Class<?>,Collection<Class<?>>>	componentsByType
protected Map<String,AlgorithmComponentFactory>	factories
protected String	pkgs

Constructor Summary

Constructors

Constructor	Description
AlgorithmInventoryService(IInventoryFilter filterStrategy, List<AlgorithmComponentFactory> factoryList, List<ParameterProvider> paramProviders)

Method Summary

Modifier and Type	Method	Description
protected boolean	checkComponentName(Set<String> invalidNames, String name)
AlgorithmComponentFactory	getFactoryFor(Class<?> clazz)
AlgorithmInventoryService.AlgorithmInventory	getInventory()	Get current algorithm inventory, ie the sum of all algorithm components, either autodetected or manually registered
void	registerAlias(String alias, String target)	Create an alias for target with name alias.
void	registerFactory(AlgorithmComponentFactory factory)	Provide a function that given a parameter map can create components with id 'name'
protected void	runComponentDiscovery()
void	runComponentDiscovery(String pkgs)

Methods inherited from class java.lang.Object

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

Field Details

componentsByType

protected Map<Class<?>,Collection<Class<?>>> componentsByType

componentByName

protected Map<String,Class<?>> componentByName

aliases

protected Map<String,String> aliases

factories

protected Map<String,AlgorithmComponentFactory> factories

pkgs

@Value("${advanced.scan-pkgs:es.urjc.etsii}")
protected String pkgs

Constructor Details

AlgorithmInventoryService

public AlgorithmInventoryService(IInventoryFilter filterStrategy,
 List<AlgorithmComponentFactory> factoryList,
 List<ParameterProvider> paramProviders)

Method Details

registerAlias

public void registerAlias(String alias,
 String target)

Create an alias for target with name alias. Example registerAlias("ILS", "IteratedLocalSearch")

Parameters:

alias - New name, reference target

target - target name

registerFactory

public void registerFactory(AlgorithmComponentFactory factory)

Provide a function that given a parameter map can create components with id 'name'

Parameters:

factory - function to execute such as f(params) --> returns component of type name

runComponentDiscovery

@PostConstruct
protected void runComponentDiscovery()

checkComponentName

protected boolean checkComponentName(Set<String> invalidNames,
 String name)

runComponentDiscovery

public void runComponentDiscovery(String pkgs)

getInventory

public AlgorithmInventoryService.AlgorithmInventory getInventory()

Get current algorithm inventory, ie the sum of all algorithm components, either autodetected or manually registered

Returns:

unmodifiable algorithm inventory. Do not attempt to modify its data structures

getFactoryFor

public AlgorithmComponentFactory getFactoryFor(Class<?> clazz)