com.yahoo.bard.webservice.config

Class ConfigurationGraph

java.lang.Object

com.yahoo.bard.webservice.config.ConfigurationGraph

public class ConfigurationGraph
extends Object

Graph representing a set of module configurations with dependencies mapped by name inside the configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEPENDENT_MODULE_KEY The special property which identifies dependent modules.
static String	MODULE_NAME_KEY The special property which uniquely identifies the name of the module.

Constructor Summary

Constructors

Constructor and Description
ConfigurationGraph(Map<org.apache.commons.configuration.Configuration,String> configurationNamePairs, Consumer<String> nameValidator) Create a configuration graph from a collection of Configuration, resource name pairs and a name validation function.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
org.apache.commons.configuration.Configuration	getConfiguration(String nodeName) Return the configuration corresponding to a module name.
int	hashCode()
Stream<String>	preOrderRightToLeftTraversal(String nodeName) Find the prioritized stream of configurations for a given module (inclusive of the module itself).
protected Stream<String>	preOrderRightToLeftTraversal(String nodeName, List<String> path) Find the prioritized stream of configurations for a given module (inclusive of the module itself).

Methods inherited from class java.lang.Object

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

Field Detail

MODULE_NAME_KEY

public static final String MODULE_NAME_KEY

The special property which uniquely identifies the name of the module.

See Also:

Constant Field Values

DEPENDENT_MODULE_KEY

public static final String DEPENDENT_MODULE_KEY

The special property which identifies dependent modules.

See Also:

Constant Field Values

Constructor Detail

ConfigurationGraph

public ConfigurationGraph(Map<org.apache.commons.configuration.Configuration,String> configurationNamePairs,
                          Consumer<String> nameValidator)

Create a configuration graph from a collection of Configuration, resource name pairs and a name validation function.

Parameters:

configurationNamePairs - A map whose keys are configurations and values are the resource names use to report errors while processing configurations.

nameValidator - A function which throws exceptions on module names which are not valid.

Method Detail

getConfiguration

public org.apache.commons.configuration.Configuration getConfiguration(String nodeName)

Return the configuration corresponding to a module name.

Parameters:

nodeName - The module name for the graph

Returns:

The configuration of a module

preOrderRightToLeftTraversal

public Stream<String> preOrderRightToLeftTraversal(String nodeName)
                                            throws SystemConfigException

Find the prioritized stream of configurations for a given module (inclusive of the module itself).

Parameters:

nodeName - The name of the initial module whose dependency should be resolved

Returns:

A list of modules returned in the order of increasing precedence

Throws:

SystemConfigException - if the graph can't be resolved

preOrderRightToLeftTraversal

protected Stream<String> preOrderRightToLeftTraversal(String nodeName,
                                                      List<String> path)
                                               throws SystemConfigException

Find the prioritized stream of configurations for a given module (inclusive of the module itself).

Parameters:

nodeName - The name of the initial module whose dependencies to load (inclusively)

path - The list of nodes back to the root of the tree parse

Returns:

A list of modules returned in the order of increasing precedence

Throws:

SystemConfigException - if there is a broken or circular dependency link

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object