|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.DataSetHandle
org.eclipse.birt.report.model.api.ScriptDataSetHandle
public class ScriptDataSetHandle
Represents a script data set item. The scripted data set gives the report developer the ability to implement a data set in code. The developer implements a series of simple scripts to open the data set, fetch each row, and to close the data set.
ScriptDataSet
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
element |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
---|
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IScriptDataSetModel |
---|
CLOSE_METHOD, DESCRIBE_METHOD, FETCH_METHOD, OPEN_METHOD |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDataSetModel |
---|
CACHED_METADATA_PROP, COLUMN_HINTS_PROP, COMPUTED_COLUMNS_PROP, FILTER_PROP, NEEDS_CACHE_PROP, PARAMETERS_PROP, RESULT_SET_HINTS_PROP, RESULT_SET_PROP, ROW_FETCH_LIMIT_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.ISimpleDataSetModel |
---|
AFTER_CLOSE_METHOD, AFTER_OPEN_METHOD, BEFORE_CLOSE_METHOD, BEFORE_OPEN_METHOD, CACHED_ROW_COUNT_PROP, DATA_SET_ROW_LIMIT, DATA_SOURCE_PROP, ON_FETCH_METHOD, PARAM_BINDINGS_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel |
---|
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
---|---|
ScriptDataSetHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a handle for script data set. |
Method Summary | |
---|---|
java.lang.String |
getClose()
Returns the script for closing data set. |
java.lang.String |
getDescribe()
Returns the script for describing the result set dynamically. |
java.lang.String |
getFetch()
Returns the script for providing the data for the next row from the result set. |
java.lang.String |
getOpen()
Returns the script for opening data set. |
PropertyHandle |
getPropertyHandle(java.lang.String propName)
Returns a property handle for a top-level property. |
java.util.Iterator |
resultSetIterator()
Deprecated. by {#resultSetHintsIterator()} |
void |
setClose(java.lang.String value)
Sets the script for closing data set. |
void |
setDescribe(java.lang.String value)
Sets the script for describing the result set dynamically. |
void |
setFetch(java.lang.String value)
Sets the script for providing the data for the next row from the result set. |
void |
setOpen(java.lang.String value)
Sets the script for opening data set. |
Methods inherited from class org.eclipse.birt.report.model.api.DataSetHandle |
---|
addFilter, columnHintsIterator, computedColumnsIterator, filtersIterator, getAfterClose, getAfterOpen, getBeforeClose, getBeforeOpen, getCachedMetaDataHandle, getCachedRowCount, getDataSetRowLimit, getDataSource, getDataSourceName, getOnFetch, getRowFetchLimit, needsCache, paramBindingsIterator, parametersIterator, removeFilter, resultSetHintsIterator, setAfterClose, setAfterOpen, setBeforeClose, setBeforeOpen, setCachedMetaData, setCachedRowCount, setDataSetRowLimit, setDataSource, setNeedsCache, setOnFetch, setRowFetchLimit |
Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ScriptDataSetHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the script data set elementMethod Detail |
---|
public java.lang.String getOpen()
public void setOpen(java.lang.String value) throws SemanticException
value
- the script to set
SemanticException
- if the property is locked.public java.lang.String getDescribe()
public void setDescribe(java.lang.String value) throws SemanticException
value
- the script to set
SemanticException
- if the property is locked.public java.lang.String getFetch()
null
return value indicates the end of the result set.)
public void setFetch(java.lang.String value) throws SemanticException
value
- the script to set
SemanticException
- if the property is locked.getFetch()
public java.lang.String getClose()
public void setClose(java.lang.String value) throws SemanticException
value
- the script to set
SemanticException
- if the property is locked.public java.util.Iterator resultSetIterator()
ResultSetColumnHandle
that represents
hints of result set column object.
resultSetIterator
in class DataSetHandle
DataSetHandle.resultSetIterator()
public PropertyHandle getPropertyHandle(java.lang.String propName)
DesignElementHandle
getPropertyHandle
in class DataSetHandle
propName
- the name of the property to get
null
if the no property
exists with the given name.PropertyHandle
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |