|
||||||||||
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.OdaDataSetHandle
public class OdaDataSetHandle
Represents an extended data set.
OdaDataSet
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.IOdaDataSetModel |
---|
DESIGNER_STATE_PROP, DESIGNER_VALUES_PROP, PRIVATE_DRIVER_PROPERTIES_PROP, PUBLIC_DRIVER_PROPERTIES_PROP, QUERY_TEXT_PROP, RESULT_SET_HINTS_PROP, RESULT_SET_NAME_PROP, RESULT_SET_NUMBER_PROP |
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 | |
---|---|
OdaDataSetHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a handle for extended data set report item. |
Method Summary | |
---|---|
IElementDefn |
getDefn()
Returns the element definition of the element this handle represents. |
byte[] |
getDesigerStateContentAsBlob()
Returns the content of designer state as the byte array. |
java.lang.String |
getDesigerStateContentAsString()
Returns the content of designer state as the string. |
java.lang.String |
getDesigerStateVersion()
Returns the version of designer state. |
OdaDesignerStateHandle |
getDesignerState()
Returns the oda designer state. |
java.lang.String |
getDesignerValues()
Returns persistent ODA designer values stored in the data set. |
java.lang.String |
getExtensionID()
Returns ID of the extension which extends this ODA data set. |
java.lang.String |
getExtensionName()
Deprecated. use getExtensionID() |
java.util.List |
getExtensionPropertyDefinitionList()
Returns the list of extension property definition. |
java.lang.String |
getPrivateDriverDesignState()
Deprecated. |
java.lang.String |
getPrivateDriverProperty(java.lang.String name)
Returns a private driver property value with the given property name. |
java.lang.String |
getQueryScript()
Deprecated. to be removed. |
java.lang.String |
getQueryText()
Returns the query text. |
java.lang.String |
getResultSetName()
Returns the result set name. |
int |
getResultSetNumber()
Gets the result set number. |
java.lang.String |
getType()
Deprecated. type has been replaced by extension ID |
java.util.Iterator |
parametersIterator()
Returns an iterator over the list of oda dataset parameter definitions. |
java.util.Iterator |
privateDriverPropertiesIterator()
Returns the iterator for the private driver property list. |
void |
setDesigerStateContentAsBlob(byte[] content)
Returns the content of designer state as the byte. |
void |
setDesigerStateContentAsString(java.lang.String content)
Returns the content of designer state as the string. |
void |
setDesigerStateVersion(java.lang.String version)
Returns the version of designer state. |
OdaDesignerStateHandle |
setDesignerState(OdaDesignerState designerState)
Sets the designer state for a oda data set. |
void |
setDesignerValues(java.lang.String values)
Stores persistent ODA designer values in the data set. |
void |
setPrivateDriverDesignState(java.lang.String state)
Deprecated. |
void |
setPrivateDriverProperty(java.lang.String name,
java.lang.String value)
Sets a private driver property value with the given name and value. |
void |
setQueryScript(java.lang.String script)
Deprecated. to be removed. |
void |
setQueryText(java.lang.String text)
Sets the query text. |
void |
setResultSetName(java.lang.String name)
Sets the result set name. |
void |
setResultSetNumber(int number)
Sets the result set number. |
void |
setType(java.lang.String type)
Deprecated. type has been replaced by extension ID |
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, getPropertyHandle, getRowFetchLimit, needsCache, paramBindingsIterator, removeFilter, resultSetHintsIterator, resultSetIterator, 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 OdaDataSetHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementMethod Detail |
---|
public java.lang.String getPrivateDriverDesignState()
public java.lang.String getQueryScript()
public java.lang.String getQueryText()
public java.lang.String getType()
public java.lang.String getResultSetName()
public void setPrivateDriverDesignState(java.lang.String state) throws SemanticException
state
- the design state to set
SemanticException
- if this property is locked.public void setQueryScript(java.lang.String script) throws SemanticException
script
- the script to set
SemanticException
- if this property is locked.public void setQueryText(java.lang.String text) throws SemanticException
text
- the text to set
SemanticException
- if this property is locked.public void setType(java.lang.String type) throws SemanticException
type
- the type to set
SemanticException
- if this property is locked.public void setResultSetName(java.lang.String name) throws SemanticException
name
- the name to set
SemanticException
- if this property is locked.public java.lang.String getExtensionName()
getExtensionID()
public java.lang.String getExtensionID()
public java.util.Iterator privateDriverPropertiesIterator()
ExtendedPropertyHandle
.
ExtendedProperty
public java.lang.String getPrivateDriverProperty(java.lang.String name)
name
- the name of a public driver property
public void setPrivateDriverProperty(java.lang.String name, java.lang.String value) throws SemanticException
name
- the name of a public driver propertyvalue
- the value of a public driver property
SemanticException
- if name
is null
or an empty string
after trimming.public IElementDefn getDefn()
getDefn
in class DesignElementHandle
public java.util.List getExtensionPropertyDefinitionList()
public java.lang.String getDesigerStateVersion()
public void setDesigerStateVersion(java.lang.String version) throws SemanticException
version
- the version of designer state.
SemanticException
- if designer state property is locked.public java.lang.String getDesigerStateContentAsString()
public void setDesigerStateContentAsString(java.lang.String content) throws SemanticException
content
- the content of designer state as the string.
SemanticException
- if designer state property is locked.public byte[] getDesigerStateContentAsBlob()
public void setDesigerStateContentAsBlob(byte[] content) throws SemanticException
content
- the content of designer state as the byte.
SemanticException
- if designer state property is locked.public OdaDesignerStateHandle getDesignerState()
null
if the designer state.OdaDesignerStateHandle
public OdaDesignerStateHandle setDesignerState(OdaDesignerState designerState) throws SemanticException
designerState
- new designer state
SemanticException
- if member of the designer state is not valid.public java.util.Iterator parametersIterator()
OdaDataSetParameterHandle
that represents oda dataset parameter objects.
parametersIterator
in class DataSetHandle
OdaDataSetParameter
public java.lang.String getDesignerValues()
public void setDesignerValues(java.lang.String values) throws SemanticException
values
- designer values in string
SemanticException
- if the property is locked.public int getResultSetNumber()
public void setResultSetNumber(int number) throws SemanticException
number
- the result set number.
SemanticException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |