org.lsst.ccs.config.utilities

Class ConfigUtils

java.lang.Object

org.lsst.ccs.config.utilities.ConfigUtils

public class ConfigUtils
extends Object

Author:

bamade

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CAT
static String	DEFAULT_CONFIG_NAME

Method Summary

Modifier and Type	Method and Description
static String	baseNameFromNames(String configName, String tagName)
static String	baseNameFromNames(String configName, String tagName, String catName)
static NamesAndTag	namesFromDescriptionPath(String pathName)
static NamesAndTag	namesFromPath(String pathName) gets subsystem name, configName and tag name from pathName
static NamesAndTag	namesFromPaths(String descriptionName, String configurationName) gets subsystem name, configName and tag name from the description and configuration path names rules: the subsystem name in both file names should be the same if the configuration name in the description file name is not set then the configuration name is in the configuration file name.
static Set<String>	parseCategories(Set<String> categorySet, String... categories)
static Map<String,String>	parseConfigurationString(Set<String> categorySet, String... configNames) Parses a string of tagged categories.
static Map<String,String>	parseConfigurationStringWithDefaults(Set<String> categories, String... taggedCategories)
static Map<String,String>	rawParseConfigurationString(String... configNames) ParseConfigurationString without checking for category consistency

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIG_NAME

public static final String DEFAULT_CONFIG_NAME

See Also:

Constant Field Values

DEFAULT_CAT

public static final String DEFAULT_CAT

See Also:

Constant Field Values

Method Detail

namesFromPath

public static NamesAndTag namesFromPath(String pathName)

gets subsystem name, configName and tag name from pathName

Parameters:

pathName -

Returns:

a NamesAndTag object structuring the names extracted from the path name.

namesFromDescriptionPath

public static NamesAndTag namesFromDescriptionPath(String pathName)

namesFromPaths

public static NamesAndTag namesFromPaths(String descriptionName,
                                         String configurationName)

gets subsystem name, configName and tag name from the description and configuration path names
rules:

• the subsystem name in both file names should be the same
• if the configuration name in the description file name is not set then the configuration name is in the configuration file name. Otherwise there is a name clash if it is set in the configuration file name and it differs.
• Same rule applies for the tag name.

Parameters:

descriptionName -

configurationName -

Returns:

a NamesAndTag object representing the extracted names from the description and configuration names.

Throws:

IllegalArgumentException - if subsystem, config and tag names are not consistent in description and configuration file names.

baseNameFromNames

public static String baseNameFromNames(String configName,
                                       String tagName)

baseNameFromNames

public static String baseNameFromNames(String configName,
                                       String tagName,
                                       String catName)

rawParseConfigurationString

public static Map<String,String> rawParseConfigurationString(String... configNames)

ParseConfigurationString without checking for category consistency

Parameters:

configNames -

Returns:

a map with category as keys and their configuration name as values

parseConfigurationString

public static Map<String,String> parseConfigurationString(Set<String> categorySet,
                                                          String... configNames)

Parses a string of tagged categories.

Parameters:

categorySet -

configNames -

Returns:

a map with category as keys and their configuration name as values

Throws:

IllegalArgumentException - if one of the categories is not present in categorySet.

parseConfigurationStringWithDefaults

public static Map<String,String> parseConfigurationStringWithDefaults(Set<String> categories,
                                                                      String... taggedCategories)

parseCategories

public static Set<String> parseCategories(Set<String> categorySet,
                                          String... categories)