org.linqs.psl.config

Class Config

java.lang.Object

org.linqs.psl.config.Config

public class Config
extends Object

The storage for all configuration values used in PSL. No prefixes are used (unlike previous config infrastructure). All access to configuration is static. Properties can be managed through the following methods: loadResource(), addProperty(), setProperty(), clearProperty(), clear(). PSL will statically try to load a properties file pointed to by the "psl.configuration" system property ("psl.properties" by default.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROJECT_PROPS
static String	PSL_CONFIG
static String	PSL_CONFIG_DEFAULT

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
static void	addProperty(String key, Object value) Add a property to the configuration.
static String	asString()
static void	clear() Remove all properties from the configuration.
static void	clearProperty(String key) Remove a property from the configuration.
static BigDecimal	getBigDecimal(String key, BigDecimal defaultValue)
static BigInteger	getBigInteger(String key, BigInteger defaultValue)
static boolean	getBoolean(String key, boolean defaultValue)
static Boolean	getBoolean(String key, Boolean defaultValue)
static byte	getByte(String key, byte defaultValue)
static Byte	getByte(String key, Byte defaultValue)
static double	getDouble(String key, double defaultValue)
static Double	getDouble(String key, Double defaultValue)
static float	getFloat(String key, float defaultValue)
static Float	getFloat(String key, Float defaultValue)
static int	getInt(String key, int defaultValue)
static Integer	getInteger(String key, Integer defaultValue)
static List<String>	getList(String key, List<String> defaultValue)
static long	getLong(String key, long defaultValue)
static Long	getLong(String key, Long defaultValue)
static Object	getNewObject(String key, String defaultValue) Returns a new instance of the class whose name associated with the given configuration key.
static Object	getProperty(String key) Get a property from the configuration.
static short	getShort(String key, short defaultValue)
static Short	getShort(String key, Short defaultValue)
static String	getString(String key, String defaultValue)
static void	init() (Re)create and populate the initial config.
static void	loadResource(InputStream stream, String resourceName)
static void	loadResource(String path)
static void	setProperty(String key, Object value) Set a property, this will replace any previously set values.

Methods inherited from class java.lang.Object

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

Field Detail

PROJECT_PROPS

public static final String PROJECT_PROPS

See Also:

Constant Field Values

PSL_CONFIG

public static final String PSL_CONFIG

See Also:

Constant Field Values

PSL_CONFIG_DEFAULT

public static final String PSL_CONFIG_DEFAULT

See Also:

Constant Field Values

Constructor Detail

Config

public Config()

Method Detail

init

public static void init()

(Re)create and populate the initial config.

loadResource

public static void loadResource(InputStream stream,
                                String resourceName)

loadResource

public static void loadResource(String path)

addProperty

public static void addProperty(String key,
                               Object value)

Add a property to the configuration. If it already exists then the value stated here will be added to the configuration entry. For example, if the property:

 resource.loader = file
 

is already present in the configuration and you call

 addProperty("resource.loader", "classpath")
 

Then you will end up with a List like the following:

 ["file", "classpath"]
 

Parameters:

key - The key to add the property to.

value - The value to add.

setProperty

public static void setProperty(String key,
                               Object value)

Set a property, this will replace any previously set values. Set values is implicitly a call to clearProperty(key), addProperty(key, value).

Parameters:

key - the key to remove along with corresponding value.

clearProperty

public static void clearProperty(String key)

Remove a property from the configuration.

Parameters:

key - the key to remove along with corresponding value.

clear

public static void clear()

Remove all properties from the configuration.

getProperty

public static Object getProperty(String key)

Get a property from the configuration. Typically, a more specific method should be used.

Parameters:

key - The configuration key

Returns:

The associated Object (or null if undefined)

getBoolean

public static boolean getBoolean(String key,
                                 boolean defaultValue)

getBoolean

public static Boolean getBoolean(String key,
                                 Boolean defaultValue)

getDouble

public static Double getDouble(String key,
                               Double defaultValue)

getString

public static String getString(String key,
                               String defaultValue)

getByte

public static byte getByte(String key,
                           byte defaultValue)

getByte

public static Byte getByte(String key,
                           Byte defaultValue)

getDouble

public static double getDouble(String key,
                               double defaultValue)

getFloat

public static float getFloat(String key,
                             float defaultValue)

getFloat

public static Float getFloat(String key,
                             Float defaultValue)

getInt

public static int getInt(String key,
                         int defaultValue)

getInteger

public static Integer getInteger(String key,
                                 Integer defaultValue)

getLong

public static long getLong(String key,
                           long defaultValue)

getLong

public static Long getLong(String key,
                           Long defaultValue)

getShort

public static short getShort(String key,
                             short defaultValue)

getShort

public static Short getShort(String key,
                             Short defaultValue)

getBigDecimal

public static BigDecimal getBigDecimal(String key,
                                       BigDecimal defaultValue)

getBigInteger

public static BigInteger getBigInteger(String key,
                                       BigInteger defaultValue)

getList

public static List<String> getList(String key,
                                   List<String> defaultValue)

getNewObject

public static Object getNewObject(String key,
                                  String defaultValue)

Returns a new instance of the class whose name associated with the given configuration key. The default constructor will be used.

asString

public static String asString()