sparksee.SparkseeProperties Class Reference

Sparksee properties file. More...

Public Member Functions
def	clear (self)
	Remove all the properties.
def	get (self, key, def)
	Gets a property. More...
def	get_integer (self, key, def)
	Gets a property as an integer. More...
def	set_h_i (self, value)
	YOU SHOULD NOT USE THIS METHOD. More...
def	load (self, path)
	Loads properties from the given file path. More...
def	get_time_unit (self, key, def)
	Gets a property as a time unit. More...
def	get_boolean (self, key, def)
	Gets a property as a boolean. More...

Detailed Description

Sparksee properties file.

This class is implemented as a singleton, so all public methods are static.

It allows for getting the property values stored in a properties file. A properties file is a file where there is one line per property. A property is defined by a key and a value as follows: key=value

By default, this loads properties from the file './sparksee.cfg'. The user may choose to load a different file by calling the method Load().

If the default properties file or the one loaded by the user do not exist, then this behaves as loading an empty properties file.

Member Function Documentation

def sparksee.SparkseeProperties.get	(		self,
			key,
			def
	)

Gets a property.

Parameters

key	[in] The name of the property to lookup.
def	[in] Default value to be returned in case there is no property with the name key.

Returns

The value of the property, or def if the key is not found.

def sparksee.SparkseeProperties.get_boolean	(		self,
			key,
			def
	)

Gets a property as a boolean.

Parameters

key	[in] The name of the property to lookup.
def	[in] Default value to be returned in case there is no property with the name key.

Returns

The property value, or def if the key is not found or in case of error.

def sparksee.SparkseeProperties.get_integer	(		self,
			key,
			def
	)

Gets a property as an integer.

Parameters

key	[in] The name of the property to lookup.
def	[in] Default value to be returned in case there is no property with the name key.

Returns

The property value, or def if the key is not found or in case of error.

def sparksee.SparkseeProperties.get_time_unit	(		self,
			key,
			def
	)

Gets a property as a time unit.

A time unit is a string representation of a time duration with a time unit such as '10s' or '3H'.

Valid format for the string representation: Blanks at the begining or at the end are ignored. No blanks are allowed between the time duration and the unit time.

Allowed time units: 'D' for days, 'H' for hours, 'M' for minutes, 'S' o 's' for seconds, 'm' for milliseconds and 'u' for microseconds.

There is a special case: If no time unit is given, seconds is the default. So, '10' means 10 seconds.

Parameters

key	[in] The name of the property to lookup.
def	[in] The default value (in microseconds) to be returned in case there is no property with the name key.

Returns

The time duration in microseconds, or def if the key is not found or in case of error.

def sparksee.SparkseeProperties.load	(		self,
			path
	)

Loads properties from the given file path.

Parameters

path	[in] File path to load properties from.

def sparksee.SparkseeProperties.set_h_i	(		self,
			value
	)

YOU SHOULD NOT USE THIS METHOD.

This method exists only for a specific service.

Parameters

value

null