org.eclipse.birt.report.engine.api.script.element
Interface IDataSet

public interface IDataSet

Script wrapper of OdaDataSetHandle

Method Summary

java.util.List	getCachedResultSetColumns() Gets result set column of cached metadata.
IDataSource	getDataSource() Returns IDataSource for this data set.
java.lang.String	getPrivateDriverProperty(java.lang.String name) Returns a private driver property value with the given property name.
java.lang.String	getQueryText() Returns the query text.
void	setPrivateDriverProperty(java.lang.String name, java.lang.String value) Sets a private driver property value with the given name and value.
void	setQueryText(java.lang.String query) Sets the query text.

Method Detail

getDataSource

IDataSource getDataSource()

Returns IDataSource for this data set.

Returns:

IDataSource

getQueryText

java.lang.String getQueryText()

Returns the query text.

Returns:

the query text.

setQueryText

void setQueryText(java.lang.String query)
                  throws ScriptException

Sets the query text.

Parameters:

query - the text to set

Throws:

ScriptException - if this property is locked.

getPrivateDriverProperty

java.lang.String getPrivateDriverProperty(java.lang.String name)

Returns a private driver property value with the given property name.

Parameters:

name - the name of a public driver property

Returns:

a public driver property value

setPrivateDriverProperty

void setPrivateDriverProperty(java.lang.String name,
                              java.lang.String value)
                              throws ScriptException

Sets a private driver property value with the given name and value. If the property does not exist, it will be added into the property list. If the property already exists, the value of the property will be overwritten.

Parameters:

name - the name of a public driver property

value - the value of a public driver property

Throws:

ScriptException - if name is null or an empty string after trimming.

getCachedResultSetColumns

java.util.List getCachedResultSetColumns()

Gets result set column of cached metadata.

Returns:

collection each iteam is IResultSetColumn.