|
||||||||||
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.DataSourceHandle
org.eclipse.birt.report.model.api.OdaDataSourceHandle
public class OdaDataSourceHandle
Represents a extended data source.
OdaDataSource
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.IOdaDataSourceModel |
---|
DESIGNER_STATE_PROP, DRIVER_NAME_PROP, PRIVATE_DRIVER_PROPERTIES_PROP, PUBLIC_DRIVER_PROPERTIES_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IOdaExtendableElementModel |
---|
EXTENSION_ID_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDataSourceModel |
---|
AFTER_CLOSE_METHOD, AFTER_OPEN_METHOD, BEFORE_CLOSE_METHOD, BEFORE_OPEN_METHOD |
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 | |
---|---|
OdaDataSourceHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs an extended data source handle with the given design and the element. |
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 |
getDriverName()
Deprecated. This property is removed. |
java.lang.String |
getExtensionID()
Returns ID of the extension which extends this ODA data source. |
java.lang.String |
getExtensionName()
Deprecated. use getExtensioID() |
java.util.List |
getExtensionPropertyDefinitionList()
Returns the list of extension property definition. |
java.lang.String |
getPrivateDriverProperty(java.lang.String name)
Returns a private driver property value with the given property name. |
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 source. |
void |
setDriverName(java.lang.String driverName)
Deprecated. This property is removed. |
void |
setPrivateDriverProperty(java.lang.String name,
java.lang.String value)
Sets a private driver property value with the given name and value. |
Methods inherited from class org.eclipse.birt.report.model.api.DataSourceHandle |
---|
getAfterClose, getAfterOpen, getBeforeClose, getBeforeOpen, setAfterClose, setAfterOpen, setBeforeClose, setBeforeOpen |
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 OdaDataSourceHandle(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 getExtensionName()
getExtensioID()
public java.lang.String getExtensionID()
public void setDriverName(java.lang.String driverName) throws SemanticException
driverName
- the name to set
SemanticException
- if this property is locked.public java.lang.String getDriverName()
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |