DataSourceParameter Class Reference

Provides access to properties of a DataSourceParameter. More...

Public Member Functions
void	dispose () throws TFormerException
	Releases the resources allocated by this instance. More...
void	dump (PrintStream s) throws IOException, TFormerException
	Dumps the current instance into a text stream. More...
String	getCaption () throws TFormerException
	Gets the caption of the DataSourceParameter. More...
String	getComment () throws TFormerException
	Gets the comment of the DataSourceParameter. More...
String	getDefaultValue () throws TFormerException
	Gets the default value of the DataSourceParameter. More...
String	getDescription () throws TFormerException
	Gets the description of the DataSourceParameter. More...
String	getDisplayOrder () throws TFormerException
	Gets the display order of the DataSourceParameter. More...
String	getName () throws TFormerException
	Gets the name of the DataSourceParameter. More...
DataSourceParameter	getNext () throws TFormerException
	Gets the next DataSourceParameter defined in the DataSource. More...
void	setCaption (String sCaption) throws TFormerException
	Sets the caption of the DataSourceParameter. More...
void	setComment (String sComment) throws TFormerException
	Gets the comment of the DataSourceParameter. More...
void	setDefaultValue (String sDefaultValue) throws TFormerException
	Sets the default value of the DataSourceParameter. More...
void	setDescription (String sDescription) throws TFormerException
	Gets the description of the DataSourceParameter. More...
void	setDisplayOrder (String sDisplayOrder) throws TFormerException
	Sets the display order of the DataSourceParameter. More...
void	setName (String sName) throws TFormerException
	Sets the name of the DataSourceParameter. More...
String	toString ()
	Returns a string representation of the instance. More...

Detailed Description

Provides access to properties of a DataSourceParameter.

Overview

A DataSourceParameter controls certain aspects of a DataSource during runtime (e.g. the filename of a DataSourceCsv, the SELECT statement of a DataSourceOdbc).

DataSourceParameters provide an elegant way to implement dynamic DataSources, without modifying the DataSource definition. They can be used to parameterize ODBC DataSources (DataSourceOdbc) and file-based DataSources (DataSourceCsv, DataSourceXml).

A typical scenario is the use of DataSourceParameters in the SQL SELECT statement of an DataSourceOdbc. By this technique TFORMer can be instructed to fetch only specific records of a table or to change the sorting order via parameters.

DataSourceParameters can also be used in ComputedFields.

Example

Sample for using a data source parameter named parOrder:

Assume we have a Parameter named parOrder and want to use it in an SQL select statement.

SELECT * FROM tblOrders WHERE Order = [GetDSParam("parOrder")] 

Providing a parameter value of 4711 would result in the following statement:

SELECT * FROM tblOrders WHERE Order = 4711 

Member Function Documentation

void dispose

(

)

throws TFormerException

Releases the resources allocated by this instance.

Call this method in every case (even in case of exceptions) is this instance is not required anymore.

void dump

(

PrintStream

s

)

throws IOException, TFormerException

Dumps the current instance into a text stream.

Parameters

s	Instance of the stream

String getCaption

(

)

throws TFormerException

Gets the caption of the DataSourceParameter.

Returns

The caption of the DataSourceParameter

String getComment

(

)

throws TFormerException

Gets the comment of the DataSourceParameter.

Returns

The comment of the DataSourceParameter

String getDefaultValue

(

)

throws TFormerException

Gets the default value of the DataSourceParameter.

Returns

The default value of the DataSourceParameter

String getDescription

(

)

throws TFormerException

Gets the description of the DataSourceParameter.

Returns

The description of the DataSourceParameter

String getDisplayOrder

(

)

throws TFormerException

Gets the display order of the DataSourceParameter.

Returns

The display order of the DataSourceParameter

String getName

(

)

throws TFormerException

Gets the name of the DataSourceParameter.

Returns

The name of the DataSourceParameter

DataSourceParameter getNext

(

)

throws TFormerException

Gets the next DataSourceParameter defined in the DataSource.

A DataSource stores a list of DataSourceParameter objects. You can use this method to iterate through the list. To retrieve the first DataSourceParameter in the Project see DataSource.getFirstParameter.

Returns

The next DataSourceParameter object in the list or null

void setCaption

(

String

sCaption

)

throws TFormerException

Sets the caption of the DataSourceParameter.

Parameters

sCaption

The caption of the DataSourceParameter

void setComment

(

String

sComment

)

throws TFormerException

Gets the comment of the DataSourceParameter.

Parameters

sComment

The comment of the DataSourceParameter

void setDefaultValue

(

String

sDefaultValue

)

throws TFormerException

Sets the default value of the DataSourceParameter.

Parameters

sDefaultValue

The default value of the DataSourceParameter

void setDescription

(

String

sDescription

)

throws TFormerException

Gets the description of the DataSourceParameter.

Parameters

sDescription

The description of the DataSourceParameter

void setDisplayOrder

(

String

sDisplayOrder

)

throws TFormerException

Sets the display order of the DataSourceParameter.

Parameters

sDisplayOrder

The display order of the DataSourceParameter

void setName

(

String

sName

)

throws TFormerException

Sets the name of the DataSourceParameter.

Parameters

sName

The name of the DataSourceParameter

String toString

(

)

Returns a string representation of the instance.

Returns

A string representation of the instance