|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDataSetInstanceHandle
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.util.Map |
getInputParameters()
Gets the names and values of all data set input parameters, as a read-only Name (String) -> Value (Object) map. |
java.lang.Object |
getInputParameterValue(java.lang.String paramName)
Gets the current value of the named data set input parameter. |
java.lang.String |
getName()
Gets the name of this data set |
java.util.Map |
getOutputParameters()
Gets the names and values of all data set output parameters, as a read-only Name (String) -> Value (Object) map. |
java.lang.Object |
getOutputParameterValue(java.lang.String paramName)
Gets the current value of the named data set output parameter. |
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 |
setInputParameterValue(java.lang.String paramName,
java.lang.Object paramValue)
Sets the value of the named data set input parameter. |
void |
setOutputParameterValue(java.lang.String paramName,
java.lang.Object paramValue)
Sets the value of the named data set output parameter. |
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 |
---|
java.lang.String getName()
IDataSourceInstanceHandle getDataSource()
java.lang.String getExtensionID()
IResultMetaData getResultMetaData() throws org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.core.exception.BirtException
java.lang.String getQueryText() throws org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.core.exception.BirtException
void setQueryText(java.lang.String queryText) throws org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.core.exception.BirtException
java.lang.String getExtensionProperty(java.lang.String name)
name
- Name of property; must not be null or empty
void setExtensionProperty(java.lang.String name, java.lang.String value)
name
- Name of property; must not be null or emptyvalue
- Property value; may be nulljava.util.Map getAllExtensionProperties()
java.lang.Object getInputParameterValue(java.lang.String paramName) throws org.eclipse.birt.core.exception.BirtException
paramName
- Name of data set input parameter
org.eclipse.birt.core.exception.BirtException
- if named parameter does not existvoid setInputParameterValue(java.lang.String paramName, java.lang.Object paramValue) throws org.eclipse.birt.core.exception.BirtException
paramName
- name of data set input parameterparamValue
- value of data set input parameter
org.eclipse.birt.core.exception.BirtException
- If named parameter does not exist, or if paramValue has an incompatible data
type with the declared parameter typejava.util.Map getInputParameters()
java.lang.Object getOutputParameterValue(java.lang.String paramName) throws org.eclipse.birt.core.exception.BirtException
paramName
- Name of data set output parameter
org.eclipse.birt.core.exception.BirtException
- if named parameter does not existvoid setOutputParameterValue(java.lang.String paramName, java.lang.Object paramValue) throws org.eclipse.birt.core.exception.BirtException
paramName
- name of data set output parameterparamValue
- value of data set output parameter
org.eclipse.birt.core.exception.BirtException
- If named parameter does not exist, or if paramValue has an incompatible data
type with the declared parameter typejava.util.Map getOutputParameters()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |