org.eclipse.birt.report.model.api
Class OdaDataSourceHandle

java.lang.Object
  extended byorg.eclipse.birt.report.model.api.DesignElementHandle
      extended byorg.eclipse.birt.report.model.api.ReportElementHandle
          extended byorg.eclipse.birt.report.model.api.DataSourceHandle
              extended byorg.eclipse.birt.report.model.api.OdaDataSourceHandle
All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDataSourceModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.IOdaDataSourceModel

public class OdaDataSourceHandle
extends DataSourceHandle
implements org.eclipse.birt.report.model.elements.interfaces.IOdaDataSourceModel

Represents a extended data source.

See Also:
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
DRIVER_NAME_PROP, PRIVATE_DRIVER_PROPERTIES_PROP, PUBLIC_DRIVER_PROPERTIES_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
 
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.
 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 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, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask
 
Methods inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
addElement, addElement, addListener, addUserPropertyDefn, canContain, canContain, canDrop, canEdit, canTransformToTemplate, clearAllProperties, clearContents, clearProperty, clientsIterator, copy, copyPropertyTo, createTemplateElement, derivedIterator, doSort, drop, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerSlotHandle, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getEventHandlerClass, getExtends, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getID, getIntProperty, getListProperty, getMethods, getModule, getModuleHandle, getName, getNumberProperty, getPrivateStyle, getProperty, getPropertyBinding, getPropertyDefn, getPropertyHandle, getPropertyIterator, getQualifiedName, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, isTemplateParameterValue, isValid, localize, moveTo, removeListener, revertToReportItem, revertToTemplate, semanticCheck, setEventHandlerClass, setExtends, setExtendsElement, setExtendsName, setFloatProperty, setIntProperty, setName, setNumberProperty, setProperties, setProperty, setPropertyBinding, setStringProperty, setStyle, setStyleElement, setStyleName, setValid, showError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OdaDataSourceHandle

public 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. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.

Parameters:
module - the module
element - the model representation of the element
Method Detail

getExtensionName

public java.lang.String getExtensionName()
Deprecated. use getExtensioID()

Returns the extension name defined by the extended item.

Returns:
the extension name as a string

getExtensionID

public java.lang.String getExtensionID()
Returns ID of the extension which extends this ODA data source.

Returns:
the extension ID

setDriverName

public void setDriverName(java.lang.String driverName)
                   throws SemanticException
Deprecated. This property is removed.

Sets the driver name.

Parameters:
driverName - the name to set
Throws:
SemanticException - if this property is locked.

getDriverName

public java.lang.String getDriverName()
Deprecated. This property is removed.

Returns the driver name.

Returns:
the driver name

privateDriverPropertiesIterator

public java.util.Iterator privateDriverPropertiesIterator()
Returns the iterator for the private driver property list. The item over the iterator is the instance of ExtendedPropertyHandle.

Returns:
the iterator over private driver property list defined on this data source.
See Also:
ExtendedProperty

getPrivateDriverProperty

public java.lang.String getPrivateDriverProperty(java.lang.String name)
Returns a private driver property value with the given property name.

Parameters:
name - the name of a public driver property
Returns:
a public driver property value

setPrivateDriverProperty

public void setPrivateDriverProperty(java.lang.String name,
                                     java.lang.String value)
                              throws SemanticException
Sets a private driver property value with the given name and value. If the property does not exist, it will be added into the property list. If the property already exists, the value will be overwritten.

Parameters:
name - the name of a public driver property
value - the value of a public driver property
Throws:
SemanticException - if name is null or an empty string after trimming.

getDefn

public IElementDefn getDefn()
Returns the element definition of the element this handle represents.

Overrides:
getDefn in class DesignElementHandle
Returns:
the element definition of the element this handle represents.

getExtensionPropertyDefinitionList

public java.util.List getExtensionPropertyDefinitionList()
Returns the list of extension property definition. All these properties are just those defined in extension plugin.

Returns:
the list of extension property definition.


Copyright © 2005 Actuate Corp. All rights reserved.