TSLDirectImportDriver::Configuration Class Reference

Detailed Description

A configuration object for a direct import driver.

Public Member Functions
	Configuration ()
	Constructor.
	Configuration (const Configuration &obj)
	Copy Constructor.
virtual	~Configuration ()
	Destructor.
bool	load (const char *file)
bool	save (const char *file)
const char *	getValue (const char *key)
void	setValue (const char *key, const char *val)
void	clearValue (const char *key)
unsigned int	numEntries () const
bool	getEntry (unsigned int index, TSLSimpleString &key, TSLSimpleString &value) const
bool	operator== (const TSLDirectImportDriver::Configuration &obj)
	Equality operator.
void	operator= (const TSLDirectImportDriver::Configuration &obj)
	Assignment operator.

Constructor & Destructor Documentation

Configuration() [1/2]

TSLDirectImportDriver::Configuration::Configuration

(

)

Constructor.

Configuration() [2/2]

TSLDirectImportDriver::Configuration::Configuration

(

const Configuration &

obj

)

Copy Constructor.

~Configuration()

virtual TSLDirectImportDriver::Configuration::~Configuration ( )

virtual

Destructor.

Member Function Documentation

clearValue()

void TSLDirectImportDriver::Configuration::clearValue

(

const char *

key

)

Clear a configuration value

Parameters

key	The key of the configuration value

getEntry()

bool TSLDirectImportDriver::Configuration::getEntry	(	unsigned int	index,
		TSLSimpleString &	key,
		TSLSimpleString &	value ) const

Query a configuration entry

Parameters

index	The index of the entry to query
key	Will be set to the key of the requested entry
value	Will be set to the value of the requested entry

Returns

true if the entry was queried, false otherwise

getValue()

const char * TSLDirectImportDriver::Configuration::getValue

(

const char *

key

)

Query a configuration value

Parameters

key	The key of the configuration value

Returns

The requested value, or NULL if the key was invalid

load()

bool TSLDirectImportDriver::Configuration::load

(

const char *

file

)

Load the configuration from a file

Example format:

 a.b.c.property=value
 anotherproperty=anothervalue

This configuration is provided to the driver in order to specify settings for the data import process.

Parameters

file	The configuration file to load from

Returns

true if the file was loaded, false otherwise

numEntries()

unsigned int TSLDirectImportDriver::Configuration::numEntries

(

)

const

Query the number of configuration entries

Returns

The number of entries in the configuration

operator=()

void TSLDirectImportDriver::Configuration::operator=

(

const TSLDirectImportDriver::Configuration &

obj

)

Assignment operator.

operator==()

bool TSLDirectImportDriver::Configuration::operator==

(

const TSLDirectImportDriver::Configuration &

obj

)

Equality operator.

save()

bool TSLDirectImportDriver::Configuration::save

(

const char *

file

)

Save the configuration to a file

Parameters

file	The configuration file to save to

Returns

true if the file was saved, false otherwise

setValue()

void TSLDirectImportDriver::Configuration::setValue	(	const char *	key,
		const char *	val )

Set a configuration value

Parameters

key	The key of the configuration value
val	The configuration value to store