org.eclipse.birt.data.engine.api.script
Interface IDataSetInstanceHandle

All Superinterfaces:

IJavascriptContext

public interface IDataSetInstanceHandle

extends IJavascriptContext

A runtime instance of a data set. Java scripts associated with a data source can use this interface to get/set data source properties.

Method Summary

java.util.Map	getAllExtensionProperties() Gets the data set extension properties, in the form of a ( name [String], value [String] ) map.
IDataSourceInstanceHandle	getDataSource()
java.lang.String	getExtensionID() Gets the unique id that identifies the type of the data set, assigned by the extension providing the implementation of this data set.
java.lang.String	getExtensionProperty(java.lang.String name) Get the value of a data set extension property.
java.lang.String	getName() Gets the name of this data set
java.lang.String	getQueryText() Gets the query text of the data set.
IResultMetaData	getResultMetaData() Gets the current data set's column metadata, if available.
void	setExtensionProperty(java.lang.String name, java.lang.String value) Set the value of an extension property
void	setQueryText(java.lang.String queryText) Sets the query text of the data set.

Methods inherited from interface org.eclipse.birt.data.engine.api.script.IJavascriptContext

getScriptScope

Method Detail

getName

public java.lang.String getName()

Gets the name of this data set

getDataSource

public IDataSourceInstanceHandle getDataSource()

Returns:

The runtime data source associated with this data set

getExtensionID

public java.lang.String getExtensionID()

Gets the unique id that identifies the type of the data set, assigned by the extension providing the implementation of this data set.

Returns:

The id fo the type of data set type as referenced by an ODA driver. Null if none is defined.

getResultMetaData

public IResultMetaData getResultMetaData()
                                  throws org.eclipse.birt.core.exception.BirtException

Gets the current data set's column metadata, if available.

Returns:

column metadata, or null if no metadata is available (e.g., data set is not yet open).

Throws:

org.eclipse.birt.core.exception.BirtException

getQueryText

public java.lang.String getQueryText()
                              throws org.eclipse.birt.core.exception.BirtException

Gets the query text of the data set.

Returns:

The static query text for execution.

Throws:

org.eclipse.birt.core.exception.BirtException

setQueryText

public void setQueryText(java.lang.String queryText)
                  throws org.eclipse.birt.core.exception.BirtException

Sets the query text of the data set.

Returns:

The static query text for execution.

Throws:

org.eclipse.birt.core.exception.BirtException

getExtensionProperty

public java.lang.String getExtensionProperty(java.lang.String name)

Get the value of a data set extension property.

Parameters:

name - Name of property; must not be null or empty

Returns:

Property value; null if property has not been defined

setExtensionProperty

public void setExtensionProperty(java.lang.String name,
                                 java.lang.String value)

Set the value of an extension property

Parameters:

name - Name of property; must not be null or empty

value - Property value; may be null

getAllExtensionProperties

public java.util.Map getAllExtensionProperties()

Gets the data set extension properties, in the form of a ( name [String], value [String] ) map.

Returns:

Extension properties as a Map of String->String pairs. Null if no extension property is defined