org.eurekaclinical.standardapis.props

Class EurekaClinicalProperties

java.lang.Object

org.eurekaclinical.standardapis.props.EurekaClinicalProperties

Direct Known Subclasses:

CasEurekaClinicalProperties

public abstract class EurekaClinicalProperties
extends Object

Author:

hrathod

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EurekaClinicalProperties(String defaultConfigDir) Loads the application configuration.

Method Summary

Modifier and Type	Method and Description
String	getConfigDir()
String	getDomainUrl() A URL representing the domain in which Eureka Clinical is installed.
protected int	getIntValue(String propertyName, int defaultValue) Utility method to get an int from the properties file.
String	getStage()
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.
abstract String	getUrl()
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

EurekaClinicalProperties

protected EurekaClinicalProperties(String defaultConfigDir)

Loads the application configuration. There are two potential sources of application configuration. The fallback configuration should always be there. The default configuration directory, provided as an argument to this constructor, may optionally have an application.properties file within it that overrides the fallback configuration for each configuration property that is specified. The eureka.config.dir system property allows specifying an alternative configuration directory.

Parameters:

defaultConfigDir - the default location of configuration file, based on the operating system. Cannot be null.

Method Detail

getConfigDir

public String getConfigDir()

getStage

public String getStage()

getDomainUrl

public String getDomainUrl()

A URL representing the domain in which Eureka Clinical is installed.

Returns:

a URL string.

getUrl

public abstract String getUrl()

getValue

protected final 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 final 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 final 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 final 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 final 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.