edu.emory.cci.aiw.cvrg.eureka.cas

Class AbstractProperties

java.lang.Object

edu.emory.cci.aiw.cvrg.eureka.cas.AbstractProperties

Direct Known Subclasses:

ApplicationProperties

public abstract class AbstractProperties
extends Object

Author:

hrathod

Constructor Summary

Constructors

Constructor and Description
AbstractProperties()

Method Summary

Modifier and Type	Method and Description
String	getApplicationUrl() Get the base URL for the application front-end for external users.
String	getCasDotPropertiesPathname()
String	getConfigDir() Gets the user-configured directory where the INI configuration files for Protempa are located.
protected int	getIntValue(String propertyName, int defaultValue) Utility method to get an int from the properties file.
protected List<String>	getStringListValue(String inPropertyName) Reads in a property value as a whitespace-delimited list of items.
protected List<String>	getStringListValue(String inPropertyName, List<String> defaultValue) Reads in a property value as a whitespace-delimited list of items.
protected String	getValue(String propertyName) Returns the String value of the given property name.
protected String	getValue(String propertyName, String defaultValue) Returns the String value of the given property name, or the given default if the given property name does not exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProperties

public AbstractProperties()

Method Detail

getCasDotPropertiesPathname

public String getCasDotPropertiesPathname()

getConfigDir

public final String getConfigDir()

Gets the user-configured directory where the INI configuration files for Protempa are located.

Returns:

A string containing the path to the directory containing Protempa INI configuration files.

getApplicationUrl

public String getApplicationUrl()

Get the base URL for the application front-end for external users.

Returns:

The base URL.

getValue

protected String getValue(String propertyName)

Returns the String value of the given property name.

Parameters:

propertyName - The property name to fetch the value for.

Returns:

A String containing the value of the given property name, or null if the property name does not exist.

getValue

protected String getValue(String propertyName,
                          String defaultValue)

Returns the String value of the given property name, or the given default if the given property name does not exist.

Parameters:

propertyName - The name of the property to fetch a value for.

defaultValue - The default value to return if the property name does not exist.

Returns:

A string containing either the value of the property, or the default value.

getStringListValue

protected List<String> getStringListValue(String inPropertyName)

Reads in a property value as a whitespace-delimited list of items.

Parameters:

inPropertyName - The name of the property to read.

Returns:

A list containing the items in the value, or null if the property is not found.

getStringListValue

protected List<String> getStringListValue(String inPropertyName,
                                          List<String> defaultValue)

Reads in a property value as a whitespace-delimited list of items.

Parameters:

inPropertyName - The name of the property to read.

defaultValue - The value to return if the property is not found.

Returns:

A list containing the items in the value.

getIntValue

protected int getIntValue(String propertyName,
                          int defaultValue)

Utility method to get an int from the properties file.

Parameters:

propertyName - The name of the property.

defaultValue - The default value to return, if the property is not found, or is malformed.

Returns:

The property value, as an int.